CogPMAlignMulti Class

Cognex VisionPro 9.8 SR1

The CogPMAlignMulti class.

This class is a collection of CogPMAlignPatternItem objects and holds the training parameters. This class provides a method to train this object and a method to execute the inspection.

The user can add patterns, access the patterns, and remove the patterns using the standard collection methods. For ease-of-use, adding and removing patterns will not un-train the tool; however, removing the last runnable pattern will un-train the tool.

Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.Implementation CogSerializableCollectionBase CogPMAlignPatternItem
            Cognex.VisionPro.PMAlign CogPMAlignMulti

Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 75.0.0.0

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogPMAlignMulti : CogSerializableCollectionBase<CogPMAlignPatternItem>, 
	IDeserializationCallback, IDisposable

[SerializableAttribute]
public class CogPMAlignMulti : CogSerializableCollectionBase<CogPMAlignPatternItem>, 
	IDeserializationCallback, IDisposable

<SerializableAttribute>
Public Class CogPMAlignMulti 
	Inherits CogSerializableCollectionBase(Of CogPMAlignPatternItem)
	Implements IDeserializationCallback, IDisposable

<SerializableAttribute>
Public Class CogPMAlignMulti 
	Inherits CogSerializableCollectionBase(Of CogPMAlignPatternItem)
	Implements IDeserializationCallback, IDisposable

[SerializableAttribute]
public ref class CogPMAlignMulti : public CogSerializableCollectionBase<CogPMAlignPatternItem^>, 
	IDeserializationCallback, IDisposable

[SerializableAttribute]
public ref class CogPMAlignMulti : public CogSerializableCollectionBase<CogPMAlignPatternItem^>, 
	IDeserializationCallback, IDisposable

The CogPMAlignMulti type exposes the following members.

Constructors

	Name	Description
	CogPMAlignMulti	Construct a default CogPMAlignMulti object.
	CogPMAlignMulti(CogPMAlignMulti)	Construct a deep copy of the supplied CogPMAlignMultiPattern object.
	CogPMAlignMulti(SerializationInfo, StreamingContext)	Serialization constructor for CogPMAlignMutli object.

Top

Methods

	Name	Description
	Add	Adds value to the end of the collection. (Inherited from CogSerializableCollectionBase T .)
	AddAllItemsToSearchOrder	Internal Cognex use only. This is mainly used by the control. Add all runnable items to the queue. It does not throw
	AddItemToSearchOrderByInternalID	Internal Cognex use only. This is mainly used by the control. The item is always added to the end of the queue. It does not throw
	Clear	Removes all objects from the collection. (Inherited from CogSerializableCollectionBase T .)
	Contains	Returns true if value is in the collection (Inherited from CogSerializableCollectionBase T .)
	CopyTo	Copies the collection to an array (Inherited from CogSerializableCollectionBase T .)
	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	Execute this operator.
	Finalize	(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.)
	GetNamesOfPatternsInQueue	Internal Cognex use only. This is mainly used by the control. The method returns the names of the patterns in the queue.
	GetObjectData	Serializer for CogPMAlignMultiPattern 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.)
	GetSearchOrderQueue	Returns the search order queue. The values in the array list are references to the CogPMAlignPatternItems held by the operator that are also in the queue.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUniqueIDsOfPatternsInQueue	Internal Cognex use only. This is mainly used by the control. The method returns the internal unique id of the patterns in the queue.
	IndexOf	Returns the index of value in the collection, or -1 if value is not in the collection. (Inherited from CogSerializableCollectionBase T .)
	InitializeLifetimeService	Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
	Insert	Inserts the value at the specified index of the collection (Inherited from CogSerializableCollectionBase T .)
	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.)
	Move	Moves an item from one position to another. (Inherited from CogSerializableCollectionBase T .)
	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.)
	OnCleared	Raises the Cleared event. (Inherited from CogSerializableCollectionBase T .)
	OnClearing	Raises the Clearing event. (Inherited from CogSerializableCollectionBase T .)
	OnDeserialization	Perform post-deserialization setup.
	OnInsertedItem	Raises the InsertedItem event. (Inherited from CogSerializableCollectionBase T .)
	OnInsertingItem	Raises the InsertingItem event. (Inherited from CogSerializableCollectionBase T .)
	OnMovedItem	Raises the MovedItem event. (Inherited from CogSerializableCollectionBase T .)
	OnMovingItem	Raises the MovingItem event. (Inherited from CogSerializableCollectionBase T .)
	OnRemovedItem	Raises the RemovedItem event. (Inherited from CogSerializableCollectionBase T .)
	OnRemovingItem	Raises the RemovingItem event. (Inherited from CogSerializableCollectionBase T .)
	OnReplacedItem	Raises the ReplacedItem event. (Inherited from CogSerializableCollectionBase T .)
	OnReplacingItem	Raises the ReplacingItem event. (Inherited from CogSerializableCollectionBase T .)
	Remove	Removes value from the collection (Inherited from CogSerializableCollectionBase T .)
	RemoveAllItemsFromSearchOrder	Internal Cognex use only. This is mainly used by the control. All items are removed from the queue. It does not throw.
	RemoveAt	Removes the element at the specified index. (Inherited from CogSerializableCollectionBase T .)
	RemoveItemFromSearchOrderByInternalID	Internal Cognex use only. This is mainly used by the control. The item is removed from the queue. It does not throw.
	ResetResultStatistics	Reset the result statistics window. Only affects SequentialMostSuccessful mode.
	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.)
	SetSearchOrderQueue	Sets the search order queue. Values must be references to held pattern items. Only referenced pattern items can be located at runtime. The queue is used in all modes. The queue will be updated in SequentialMostRecentlySuccessful and in SequentialMostSuccessful. Pattern items that are in the queue and are not runnable will cause a runtime error. Internally the queue is stored using the unique ids of the pattern items.
	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	Train the multi-model. For multi-model training to be successful there must be at least one runnable pattern item in the collection. A pattern item is runnable if the following 3 conditions are met: It is trained Has the same coarse and fine grain limits as the CogPMAlignMulti operator, and Has the same train algorithm as the CogPMAlignMulti operator. At the start of the training, the trained state will be set to false. The trained state will be set to true only if training is successful. The train method will throw an exception if training is unsuccessful.

Top

Fields

	Name	Description
	SfGrainLimitCoarse	This bit will be set in the EventArgs of a Changed event every time the value returned by GrainLimitCoarse 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.
	SfNextSf
	SfResultStatisticWindowLength	This bit will be set in the EventArgs of a Changed event every time the value returned by ResultStatisticsWindowLength may have changed.
	SfSelectedIndex	This bit will be set in the EventArgs of a Changed event every time the value returned by SelectedIndex may have changed.
	SfSetSearchOrderQueue	This bit will be set in the EventArgs of a Changed event every time the value returned by SearchOrderQueue may have changed.
	SfTrainAlgorithm	This bit will be set in the EventArgs of a Changed event every time the value returned by TrainAlgorithm 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.

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.)
	Count	Gets the number of elements contained in the collection. (Inherited from CogSerializableCollectionBase T .)
	GrainLimitCoarse	Gets or sets the coarse grain limit that must be used by all the patterns in the operator collection. The property is initialized when the first pattern is added to the operator. Valid range is 1 to 25.5. Setting the coarse less than fine will also set the fine to the new value.
	GrainLimitFine	Gets or sets the coarse grain limit that must be used by all the patterns in the operator collection. The property is initialized when the first pattern is added to the operator. Valid range is 1 to 25.5. Setting the coarse less than fine will also set the fine to the new value.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	InnerList	Gets the internal List containing the list of elements. (Inherited from CogSerializableCollectionBase T .)
	IsFixedSize	returns false (Inherited from CogSerializableCollectionBase T .)
	IsReadOnly	Returns true if this collection is ReadOnly (Inherited from CogSerializableCollectionBase T .)
	IsSynchronized	(Inherited from CogSerializableCollectionBase T .)
	Item	Returns the T at index (Inherited from CogSerializableCollectionBase T .)
	List	Gets an the IList interface of this collection. (Inherited from CogSerializableCollectionBase T .)
	ResultStatisticWindowLength	Gets or sets the length of the window over which statistic data is collected. The data is used in SequentialMostSuccessful runtime mode to re-order the patterns in the queue. Calling the setter will cause any existing result statistics to be flushed.
	SelectedIndex	Gets of sets the selected pattern. It is used by CreateCurrentRecord() to create the PatternTrainImage record. It is used by the edit control to specify the pattern selected in the grid.
	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.)
	SyncRoot	(Inherited from CogSerializableCollectionBase T .)
	TrainAlgorithm	Gets or sets the train algorithm that must be used by all the patterns in the operator collection. The property is initialized when the first pattern is added to the operator.
	Trained	Returns true if the multi-model operator is trained. The property is set by the Train() method.

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.)
	Cleared	Raised after the collection is cleared. (Inherited from CogSerializableCollectionBase T .)
	Clearing	Raised before the collection is cleared. (Inherited from CogSerializableCollectionBase T .)
	InsertedItem	Raised after an item is inserted. (Inherited from CogSerializableCollectionBase T .)
	InsertingItem	Raised before an item is inserted. (Inherited from CogSerializableCollectionBase T .)
	MovedItem	Raised after an item is moved to a new index. (Inherited from CogSerializableCollectionBase T .)
	MovingItem	Raised before an item is moved to a new index. (Inherited from CogSerializableCollectionBase T .)
	MultiChanged	Internal Cognex use only.
	RemovedItem	Raised after an item is removed. (Inherited from CogSerializableCollectionBase T .)
	RemovingItem	Raised before an item is removed. (Inherited from CogSerializableCollectionBase T .)
	ReplacedItem	Raised after an item is replaced. (Inherited from CogSerializableCollectionBase T .)
	ReplacingItem	Raised before an item is replaced. (Inherited from CogSerializableCollectionBase T .)

Top