Class which holds scale Degree Of Freedom (DOF) information. PMAlign can locate patterns that have changed in scale from the trained pattern. This class specifies the scale(s) at which patterns may be located.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.PMAlign CogPMAlignZoneScale
Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 69.0.0.0
Syntax
The CogPMAlignZoneScale type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogPMAlignZoneScale | Constructs a new instance of this class. |
| CogPMAlignZoneScale(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogPMAlignZoneScale(CogPMAlignZoneScale) | Constructs a new instance of this class as a deep copy of the given instance. |
Methods
| Name | Description | |
|---|---|---|
 | Clone | Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject |
| 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 | (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 | |
| 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.) |
| ResumeAndRaiseChangedEvent | Re-enables raising of the Changed event after SuspendChangedEvent has been called. Also 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. |
| 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. |
| ToString | (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
  | SfConfiguration | This bit will be set in the EventArgs of a Changed event every time the value returned by Configuration may have changed. |
| SfHigh | This bit will be set in the EventArgs of a Changed event every time the value returned by High may have changed. |
| SfLow | This bit will be set in the EventArgs of a Changed event every time the value returned by Low may have changed. |
| SfNominal | This bit will be set in the EventArgs of a Changed event every time the value returned by Nominal may have changed. |
| SfOverlap | This bit will be set in the EventArgs of a Changed event every time the value returned by Overlap 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. |
| Configuration | Configuration of this DOF zone which specifies whether PMAlign will use either the low & high limits for the expected range of values or just the nominal value. |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. |
| High | High limit for DOF zone. Only used if Configuration is cogPMAlignZoneLowHigh. In this case, PMAlign will use the low & high limits for the expected range of values. Low must be <= to high. Setting high < low will also set high to the new value. |
| Low | Low limit for DOF zone. Only used if Configuration is cogPMAlignZoneLowHigh. In this case, PMAlign will use the low & high limits for the expected range of values. Low must be <= to high. Setting low > high will also set high to the new value. |
| Nominal | The nominal value is only used if Configuration is cogPMAlignZoneNominal. In this case PMAlign only finds pattern instances that are close to the Nominal value specified and the results will always be reported at exactly the found value. |
| Overlap | Result candidates overlap for a scale DOF if the scale ratio (larger scale/smaller scale) <= Overlap. PMAlign discards the weaker pattern instance when two pattern instances overlap for all degrees of freedom (DOF) as well as area. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
Remarks
Interface used to select and configure the desired method, "Nominal Value" or "Low, High Zone", of locating a PMAlign pattern for a scale-based degree of freedom.
If you specify a nominal value, the results returned by the tool will have exactly the scale value you specify. If you specify a low and high limit, the results returned by the tool will be within (or slightly outside of) the range of scales that you specify.
See Also