CogAutoSelect Class

Cognex VisionPro 9.5

This class automatically selects an image model for either CogPMAlign or CogCNLSearch based upon the supplied input image.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.AutoSelect CogAutoSelect

Namespace: Cognex.VisionPro.AutoSelect
Assembly: Cognex.VisionPro.AutoSelect (in Cognex.VisionPro.AutoSelect.dll) Version: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogAutoSelect : CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public class CogAutoSelect : CogSerializableChangedEventBase, 
	IDisposable

<SerializableAttribute>
Public Class CogAutoSelect 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogAutoSelect 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

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

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

The CogAutoSelect type exposes the following members.

Constructors

	Name	Description
	CogAutoSelect
	CogAutoSelect(CogAutoSelect)	Construct a deep copy of the supplied CogAutoSelect object.
	CogAutoSelect(SerializationInfo, StreamingContext)

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.)
	Dispose
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute	Perform auto selection on the supplied input image.
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	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.)
	GetDiagImages	Produce the actual image and mask that would be processed if the Execute method were called with the supplied input image and region. This method is provided as a diagnostic aid to help the user visualize the actual image and mask that will be used at run time.
	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	Implements the GetObjectData method of the ISerializable interface. (Inherited from CogSerializableObjectBase.)
	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.)
	QueryPointAdd	Add the specified query point to the internal list of query points. These X,Y coordinates are in the selected space of the input image.
	QueryPointClear	Remove all defined query points from this CogAutoSelect's internal list.
	QueryPointGetX	Get the X coordinate of the query point at the supplied index. This value is in the selected space of the input image.
	QueryPointGetY	Get the Y coordinate of the query point at the supplied index. This value is in the selected space of the input image.
	QueryPointRemoveAt	Remove from this CogAutoSelect's internal list the query point at the specified index.
	QueryPointSetX	Set the X coordinate of the query point at the supplied index. This value is in the selected space of the input image.
	QueryPointSetY	Set the Y coordinate of the query point at the supplied index. This value is in the selected space of the input image.
	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.)

Top

Fields

	Name	Description
	SfCNLSearchRunParams	This bit will be set in the EventArgs of a Changed event every time the value returned by CNLSearchRunParams may have changed.
	SfInputImageMask	This bit will be set in the EventArgs of a Changed event every time the value returned by InputImageMask may have changed.
	SfInputImageMaskOffsetX	This bit will be set in the EventArgs of a Changed event every time the value returned by InputImageMaskOffsetX may have changed.
	SfInputImageMaskOffsetY	This bit will be set in the EventArgs of a Changed event every time the value returned by InputImageMaskOffsetY may have changed.
	SfMaxNumResults	This bit will be set in the EventArgs of a Changed event every time the value returned by MaxNumResults may have changed.
	SfModelMask	This bit will be set in the EventArgs of a Changed event every time the value returned by ModelMask may have changed.
	SfModelSizeX	This bit will be set in the EventArgs of a Changed event every time the value returned by ModelSizeX may have changed.
	SfModelSizeY	This bit will be set in the EventArgs of a Changed event every time the value returned by ModelSizeY may have changed.
	SfNextSf
	SfPMAlignRunParams	This bit will be set in the EventArgs of a Changed event every time the value returned by PMAlignRunParams may have changed.
	SfQueryPointCount	This bit will be set in the EventArgs of a Changed event every time the value returned by QueryPointCount may have changed.
	SfQueryPointGetX	This bit will be set in the EventArgs of a Changed event every time the value returned by QueryPointGetX may have changed.
	SfQueryPointGetY	This bit will be set in the EventArgs of a Changed event every time the value returned by QueryPointGetY may have changed.
	SfRegionMode	This bit will be set in the EventArgs of a Changed event every time the value returned by RegionMode may have changed.
	SfRunMode	This bit will be set in the EventArgs of a Changed event every time the value returned by RunMode may have changed.
	SfSamplingInterval	This bit will be set in the EventArgs of a Changed event every time the value returned by SamplingInterval may have changed.
	SfScoringCombineMethod	This bit will be set in the EventArgs of a Changed event every time the value returned by ScoringCombineMethod may have changed.
	SfScoringOrthogonalityWeight	This bit will be set in the EventArgs of a Changed event every time the value returned by ScoringOrthogonalityWeight may have changed.
	SfScoringSymmetryWeight	This bit will be set in the EventArgs of a Changed event every time the value returned by ScoringSymmetryWeight may have changed.
	SfScoringUniquenessWeight	This bit will be set in the EventArgs of a Changed event every time the value returned by ScoringUniquenessWeight may have changed.
	SfTarget	This bit will be set in the EventArgs of a Changed event every time the value returned by Target may have changed.
	SfXYOverlap	This bit will be set in the EventArgs of a Changed event every time the value returned by XYOverlap 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.)
	CNLSearchRunParams	Get or sets the CogCNLSearchRunParams to be used during the auto selection process.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	InputImageMask	Gets or sets the input image mask to be used during the auto selection process. Only the three most significant bits of each mask image pixel are used: Bit 7 (MSB): Care bit. One (1) means "Care", as in "use this feature in the model", while zero (0) means "do not use this feature in the model". Bit 6: Don't Score bit. One (1) means "Don't Score", as in "don't compute clutter score", while zero means "Score", as in "do compute clutter score". Bit 5: Position bit. One (1) means discard any model that includes this pixel, while zero (0) means the opposite.
	InputImageMaskOffsetX	Gets or sets the input image mask X offset in pixels. This offset is the horizontal distance in pixels from the upper left corner of the input image to the upper left corner of the InputImageMask.
	InputImageMaskOffsetY	Gets or sets the input image mask Y offset in pixels. This offset is the vertical distance in pixels from the upper left corner of the input image to the upper left corner of the InputImageMask.
	MaxNumResults	Gets or sets the maximum number of results.
	ModelMask	Gets or sets the model mask to be used during the auto selection process. The size of this mask must match the run time values of ModelSizeX and ModelSizeY.
	ModelSizeX	Gets or sets the desired image model X dimension in pixels.
	ModelSizeY	Gets or sets the desired image model Y dimension in pixels.
	PMAlignRunParams	Get or sets the CogPMAlignRunParams to be used during the auto selection process.
	QueryPointCount	Get the number of currently defined query points.
	RegionMode	Gets or sets the region mode. Legal values include PixelAlignedBoundingBox and PixelAlignedBoundingBoxAdjustMask.
	RunMode	Gets or sets the run mode. Legal values include Search (process the entire input image) and Query (only consider specified locations).
	SamplingInterval	Gets or sets the sampling interval in pixels. Increasing the sampling interval causes CogAutoSelect to run faster but produce lower quality results.
	ScoringCombineMethod	Gets or sets the scoring combine method. Legal values include GeometricMean and ArithmeticMean.
	ScoringOrthogonalityWeight	Gets or sets the orthogonality scoring weight.
	ScoringSymmetryWeight	Gets or sets the symmetry scoring weight.
	ScoringUniquenessWeight	Gets or sets the uniqueness scoring weight.
	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.)
	Target	Gets or sets the target tool type. Legal values include PMAlign and CNLSearch.
	XYOverlap	Gets or sets the XY overlap required to consider two instances to be the same result. Overlap is (approximately) the ratio of overlap area to total area of the pattern, in the range of 0.0 (no overlap) to 1.0 (full overlap) inclusive. Note that this parameter has a large effect upon execution time - low values (below 0.5) may cause a significant slowdown.

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