CogPMRedLinePattern Class

Cognex VisionPro 9.22

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.PMRedLine CogPMRedLinePattern

Namespace: Cognex.VisionPro.PMRedLine
Assembly: Cognex.VisionPro.PMRedLine (in Cognex.VisionPro.PMRedLine.dll) Version: 87.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogPMRedLinePattern : CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public class CogPMRedLinePattern : CogSerializableChangedEventBase, 
	IDisposable

<SerializableAttribute>
Public Class CogPMRedLinePattern 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogPMRedLinePattern 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

[SerializableAttribute]
public ref class CogPMRedLinePattern : public CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public ref class CogPMRedLinePattern : public CogSerializableChangedEventBase, 
	IDisposable

The CogPMRedLinePattern type exposes the following members.

Constructors

	Name	Description
	CogPMRedLinePattern	Constructs a default CogPMRedLinePattern object. You must train this object before you can use it to search for pattern instances.
	CogPMRedLinePattern(CogPMRedLinePattern)	Constructs a deep copy of the supplied CogPMRedLinePattern object.
	CogPMRedLinePattern(SerializationInfo, StreamingContext)	Serialization constructor for CogPMRedLinePattern object.

Top

Methods

	Name	Description
	CreateObjRef	Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
	CreateTrainedGraphics	Gets a collection of graphics that can be used to display the trained pattern features.
	Dispose	Releases all resources used by this CogPMRedLinePattern object.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Searchs the given inputImage for instances of this pattern. The search is performed using the supplied runParams within the given region.
	Finalize	Releases all unmanaged resources used by this CogPMRedLinePattern object. (Overrides Object Finalize .)
	GetAttributes	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetClassName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetComponentName	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetConverter	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultEvent	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetDefaultProperty	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEditor	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetEvents( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetLifetimeService	Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	GetObjectData	Populates the provided SerializationInfo with the data needed to serialize the object. (Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).)
	GetProperties	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetProperties( Attribute )	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetPropertyOwner	Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information. (Inherited from CogObjectBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	MemberwiseClone(Boolean)	Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
	OnChanged(Int64)	This method should be called internally whenever the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)
	OnChanged(CogChangedEventArgs)	This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class. (Inherited from CogSerializableChangedEventBase.)
	Precompute	Precompute internal data for the pattern. Cognex internal use only.
	ResumeAndRaiseChangedEvent	Re-enables raising of the Changed event after SuspendChangedEvent has been called, and raises the Changed event if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent. (Inherited from CogSerializableChangedEventBase.)
	SuspendChangedEvent	Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. (Inherited from CogSerializableChangedEventBase.)
	ToString	Returns a String that represents the current Object. (Inherited from Object.)
	Train	Trains this PMRedLine pattern. If the pattern is already trained then it will be untrained and retrained.
	Untrain	Untrains this PMRedLine pattern.

Top

Fields

	Name	Description
	SfCreateTrainedGraphics	This bit will be set in the EventArgs of a Changed event every time the value returned by CreateTrainedGraphics may have changed.
	SfFeatureThreshold	This bit will be set in the EventArgs of a Changed event every time the value returned by FeatureThreshold may have changed.
	SfGrainLimitCoarse	This bit will be set in the EventArgs of a Changed event every time the value returned by GrainLimitCoarse may have changed.
	SfGrainLimitCoarseAutoSelect	This bit will be set in the EventArgs of a Changed event every time the value returned by GrainLimitCoarseAutoSelect may have changed.
	SfGrainLimitFine	This bit will be set in the EventArgs of a Changed event every time the value returned by GrainLimitFine may have changed.
	SfGrainLimitFineAutoSelect	This bit will be set in the EventArgs of a Changed event every time the value returned by GrainLimitFineAutoSelect may have changed.
	SfNextSf
	SfOrigin	This bit will be set in the EventArgs of a Changed event every time the value returned by Origin may have changed.
	SfTrained	This bit will be set in the EventArgs of a Changed event every time the value returned by Trained may have changed.
	SfTrainImage	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainImage may have changed.
	SfTrainImageMask	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainImageMask may have changed.
	SfTrainImageMaskOffsetX	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainImageMaskOffsetX may have changed.
	SfTrainImageMaskOffsetY	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainImageMaskOffsetY may have changed.
	SfTrainRegion	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainRegion may have changed.
	SfTrainRegionMode	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainRegionMode may have changed.
	SfTrainTimeout	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainTimeout may have changed.
	SfTrainTimeoutEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainTimeoutEnabled may have changed.

Top

Properties

	Name	Description
	ChangedEventSuspended	If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called. (Inherited from CogSerializableChangedEventBase.)
	FeatureThreshold	Gets or sets the feature threshold. This value controls how many features are included in the trained pattern. Raising the threshold reduces the number of trained features.
	GrainLimitCoarse	Gets or sets the coarse granularity limit. This is the maximum amount of subsampling that will be applied to the input image when PMRedLine searchs for instances of your pattern. If GrainLimitCoarseAutoSelect is "true" this granularity limit will be recomputed automatically when the pattern is trained, overwriting the previous value.
	GrainLimitCoarseAutoSelect	Gets or sets whether to automatically recompute the coarse granularity limit during pattern training. If "true", the limit computed during training will overwrite the existing GrainLimitCoarse. Otherwise, it will remain unchanged.
	GrainLimitFine	Gets or sets the fine granularity limit. This is the minimum amount of subsampling that will be applied to the input image when PMRedLine searchs for instances of your pattern. If GrainLimitFineAutoSelect is "true" this granularity limit will be recomputed automatically when the pattern is trained, overwriting the previous value.
	GrainLimitFineAutoSelect	Gets or sets whether to automatically recompute the fine granularity limit during pattern training. If "true", the limit computed during training will overwrite the existing GrainLimitFine. Otherwise, it will remain unchanged.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	Origin	Gets or sets a six degree of freedom (DOF) origin for the pattern. This linear transform maps points from "Pattern Space" to the selected space of the train image.
	StateFlags	Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... } (Inherited from CogSerializableChangedEventBase.)
	Trained	Gets whether this pattern is currently trained.
	TrainImage	Gets or sets the image that will be used to train this PMRedLine pattern. Pattern features will be found and trained only from portions of the image within the train region.
	TrainImageMask	Gets or sets the mask to be used when training a CogPMRedLine pattern. The mask allows you to identify areas of the train image as "Care" or "Don't Care".
	TrainImageMaskOffsetX	Gets or sets the X offset (in pixels) for the train image mask.
	TrainImageMaskOffsetY	Gets or sets the Y offset (in pixels) for the train image mask.
	TrainRegion	Gets or sets the train region. Only the portion of the train image that lies within this region will be trained by PMRedLine. If the supplied region object is null, the entire train image will be trained.
	TrainRegionMode	Gets or sets the train region mode. This mode specifies how the train region is applied to the train image.
	TrainTimeout	Gets or sets the maximum execution time (in msec) allowed when a PMRedLine tool is trained. This value only applies if TrainTimeoutEnabled is set to "true".
	TrainTimeoutEnabled	Gets or sets whether to enable the train timeout.

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)

Top