The PMAlign composite class.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.PMAlign CogPMAlignComposite
Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 65.1.0.0
Syntax
The CogPMAlignComposite type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogPMAlignComposite | Construct a default CogPMAlignComposite object. |
| CogPMAlignComposite(CogPMAlignComposite) | Construct a deep copy of the supplied CogPMAlignComposite object except for PercentCoarseFeaturesUsed, PercentFineFeaturesUsed and SelectedIndex. because these values are generated at train time. |
 | CogPMAlignComposite(SerializationInfo, StreamingContext) | Serialization constructor for CogPMAlignComposite object. The PercentCoarseFeaturesUsed, PercentFineFeaturesUsed and SelectedIndex are not serialized because these values are generated at train time. |
Methods
| Name | Description | |
|---|---|---|
| ClearCollection | Clear the collection and leave the pattern trained state as is. In case the application memory is low, this can free up some memory. Remember to save the tool before clearing the collection. |
| ClearTrainData | |
| Clone | |
| 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 | (Inherited from Object.) |
| 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.) |
| GetAlignmentFeatures | |
| 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.) |
| GetCount | |
| 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.) |
| GetEnabled | |
| GetEnabledCount | |
| 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.) |
| GetIgnorePolarity | |
| GetImage | |
| 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.) |
| GetSelectedIndex | |
| GetTrainGraphicsIndex | |
| 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.) |
| OnDeserialization | Internal Cognex 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.) |
| SetCompositeParent | |
| 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 | (Inherited from Object.) |
| TrainComposite |
Fields
| Name | Description | |
|---|---|---|
  | SfCompositeData | This bit will be set in the EventArgs of a Changed event every time the value returned by CompositeData may have changed. |
| SfIgnorePolarity | This bit will be set in the EventArgs of a Changed event every time the value returned by IgnorePolarity may have changed. |
| SfImageFraction | This bit will be set in the EventArgs of a Changed event every time the value returned by ImageFraction may have changed. |
 | SfNextSf | NextSf state flag. |
| SfPercentCoarseFeaturesUsed | This bit will be set in the EventArgs of a Changed event every time the value returned by PercentCoarseFeaturesUsed may have changed. |
| SfPercentFineFeaturesUsed | This bit will be set in the EventArgs of a Changed event every time the value returned by PercentFineFeaturesUsed 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. |
| SfTimeout | This bit will be set in the EventArgs of a Changed event every time the value returned by Timeout may have changed. |
| SfTimeoutEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by TimeoutEnabled may have changed. |
| SfTuningElasticity | This bit will be set in the EventArgs of a Changed event every time the value returned by TuningElasticity may have changed. |
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.) |
| CompositeData | Gets or sets the CompositeData property. |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| IgnorePolarity | Gets or sets whether composite training should ignore polarity or not. |
| ImageFraction | Gets or sets the ImageFraction property. The feature must be present in at least this fraction of the images to contribute to the produced pattern. |
| PercentCoarseFeaturesUsed | Gets the percentage of the coarse feature that were used in the pattern from the initial train image.The value is set when the user calls train and the item is enabled. |
| PercentFineFeaturesUsed | Gets the percentage of the fine feature that were used in the pattern from the initial train image.The value is set when the user calls train and at least one composite item is enabled. |
| SelectedIndex | Gets or sets the SelectedIndex property. This property is used to create the record content graphics for the composite data item specified in the selected index. The SelectedIndex is used by the edit control to specify the item selected. |
| 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.) |
| Timeout | Gets or sets the maximum amount of time in milliseconds that training can take. |
| TimeoutEnabled | Gets or sets whether composite training is allowed to time out. If true, the composite training is limited by the Timeout value. |
| TuningElasticity | Gets or sets the TuningElasticity property. The value indicates how far the feature location can vary. The value is specified in pixels. |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| InvalidatePMAlignCurrentRecord | Internal Cognex use only. |
Remarks
See Also