Class which holds PMAlign run parameters. The run parameters are used to control how PMAlign locates matching patterns in the run-time image.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.PMAlign CogPMAlignRunParams
Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 73.0.0.0
Syntax
The CogPMAlignRunParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogPMAlignRunParams | Constructs a new instance of this class. |
| CogPMAlignRunParams(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogPMAlignRunParams(CogPMAlignRunParams) | 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 | |
|---|---|---|
  | SfAcceptThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by AcceptThreshold may have changed. |
| SfApproximateNumberToFind | This bit will be set in the EventArgs of a Changed event every time the value returned by ApproximateNumberToFind may have changed. |
| SfAutoEdgeThresholdEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by AutoEdgeThresholdEnabled may have changed. |
| SfCoarseAcceptThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by CoarseAcceptThreshold may have changed. |
| SfCoarseAcceptThresholdEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by CoarseAcceptThresholdEnabled may have changed. |
| SfContrastThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by ContrastThreshold may have changed. |
| SfControlPointsX | This bit will be set in the EventArgs of a Changed event every time the value returned by ControlPointsX may have changed. |
| SfControlPointsY | This bit will be set in the EventArgs of a Changed event every time the value returned by ControlPointsY may have changed. |
| SfDeformationFit | This bit will be set in the EventArgs of a Changed event every time the value returned by DeformationFit may have changed. |
| SfEdgeThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by EdgeThreshold 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. |
| SfGrainLimitFine | This bit will be set in the EventArgs of a Changed event every time the value returned by GrainLimitFine may have changed. |
| SfGrainLimitsUsePattern | This bit will be set in the EventArgs of a Changed event every time the value returned by GrainLimitsUsePattern may have changed. |
| SfMaxDeformationRate | This bit will be set in the EventArgs of a Changed event every time the value returned by MaxDeformationRate may have changed. |
| SfOutsideRegionThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by OutsideRegionThreshold may have changed. |
| SfPartialMatchCoverageThreshold | This bit will be set in the EventArgs of a Changed event every time the value returned by PartialMatchCoverageThreshold may have changed. |
| SfPartialMatchEnabled | This bit will be set in the EventArgs of a Changed event every time the value returned by PartialMatchEnabled may have changed. |
| SfRefinement | This bit will be set in the EventArgs of a Changed event every time the value returned by Refinement may have changed. |
| SfRunAlgorithm | This bit will be set in the EventArgs of a Changed event every time the value returned by RunAlgorithm 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. |
| SfSaveDeformationInfo | This bit will be set in the EventArgs of a Changed event every time the value returned by SaveDeformationInfo may have changed. |
| SfSaveMatchInfo | This bit will be set in the EventArgs of a Changed event every time the value returned by SaveMatchInfo may have changed. |
| SfScoreUsingClutter | This bit will be set in the EventArgs of a Changed event every time the value returned by ScoreUsingClutter may have changed. |
| SfSearchImageMask | This bit will be set in the EventArgs of a Changed event every time the value returned by SearchImageMask may have changed. |
| SfSearchImageMaskOffsetX | This bit will be set in the EventArgs of a Changed event every time the value returned by SearchImageMaskOffsetX may have changed. |
| SfSearchImageMaskOffsetY | This bit will be set in the EventArgs of a Changed event every time the value returned by SearchImageMaskOffsetY may have changed. |
| SfSearchRegionMode | This bit will be set in the EventArgs of a Changed event every time the value returned by SearchRegionMode may have changed. |
| SfSmoothness | This bit will be set in the EventArgs of a Changed event every time the value returned by Smoothness may have changed. |
| SfStartPose | This bit will be set in the EventArgs of a Changed event every time the value returned by StartPose 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. |
| SfXYOverlap | This bit will be set in the EventArgs of a Changed event every time the value returned by XYOverlap may have changed. |
| SfZoneAngle | This bit will be set in the EventArgs of a Changed event every time the value returned by ZoneAngle may have changed. |
| SfZoneScale | This bit will be set in the EventArgs of a Changed event every time the value returned by ZoneScale may have changed. |
| SfZoneScaleX | This bit will be set in the EventArgs of a Changed event every time the value returned by ZoneScaleX may have changed. |
| SfZoneScaleY | This bit will be set in the EventArgs of a Changed event every time the value returned by ZoneScaleY may have changed. |
Properties
| Name | Description | |
|---|---|---|
 | AcceptThreshold | Acceptance threshold on the score of a result. Only instances of the pattern that receive scores greater than or equal to this threshold are accepted. Valid range is from 0 to 1. |
| ApproximateNumberToFind | Number of results to look for. In some cases, PMAlign may return more or fewer results than requested. |
| AutoEdgeThresholdEnabled | If true, user provided edge threshold will be used for training. If false, computed edge threshold will be used. Default value is false. |
| 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. |
| CoarseAcceptThreshold | If CoarseAcceptThresholdEnabled is true, then results whose score is greater than or equal to CoarseAcceptThreshold will be refined and then compared against AcceptThreshold. Otherwise result scores are only compared against AcceptThreshold. The legal range for CoarseAcceptThreshold is [0.0, 1.0] and the default is 0.33. |
| CoarseAcceptThresholdEnabled | Whether to use CoarseAcceptThreshold. Default is false. |
| ContrastThreshold | Minimum acceptable contrast for a pattern instance. Only pattern instances where the average difference in pixel values across all feature boundaries exceeds the contrast threshold are considered by PMAlign. Threshold must be between 0 and 65535. |
| EdgeThreshold | Run-time edge threshold, under which, edges will be ignored. Valid value range is from 0.0 to 65535.0. Default value is 5.0. |
| GrainLimitCoarse | Coarse grain limit that will be used at run-time if GrainLimitsUsePattern is false. Coarse must be greater than or equal to fine. Setting coarse less than fine will also set fine to the new coarse value. Valid range is from 1.0 to 25.5 inclusive. |
| GrainLimitFine | Fine grain limit that will be used at run-time if GrainLimitsUsePattern is false. Coarse must be greater than or equal to fine. Setting fine greater than coarse will also set coarse to the new fine value. Valid range is from 1.0 to 25.5 inclusive. |
| GrainLimitsUsePattern | If true then the grain limits specified in CogPMAlignPattern will be used. If false then the grain limits specified in this CogPMAlignRunParams will be used. |
| HasChanged | If true, the serializable state of this object has changed since the last time it was serialized. |
| OutsideRegionThreshold | Specifies the proportion of features that can be outside the search region without affecting score. The value must be set to 0 when using PatFlex or PatMaxPerspective train algorithm. |
| OwnedFlexParams | Gets the runtime parameters specific to the PatFlex algorithm. These parameters are owned by this object, but are conveniently grouped together inside the returned interface. |
| RunAlgorithm | The algorithm used to run this PMAlign pattern. The algorithm specified must be among those for which the PMAlign object was trained. |
| RunMode | The mode in which this PMAlign pattern will be run. |
| SaveMatchInfo | Flag indicating whether to save information necessary to create result match graphics. Must be set to true if user wants to get match info graphics using the ICogPMAlignResult::CreateResultGraphics method. |
| ScoreUsingClutter | Determines if PatMax considers extraneous features when computing the score of a pattern instance. True, extraneous features are considered and will result in lower scores. False, extraneous features are ignored. Available for PatMax only. |
| SearchImageMask | Mask that is used when running the PMAlign pattern. The mask allows the user to identify areas of the pattern as "Care" or "Don't Care". The mask is aligned to the run-time input image using the SearchImageMaskOffsetX & Y values. |
| SearchImageMaskOffsetX | X offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the run-time input image to the upper-left corner of the SearchImageMask in image coordinates of the input image. |
| SearchImageMaskOffsetY | Y offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the run-time input image to the upper-left corner of the SearchImageMask in image coordinates of the input image. |
| SearchRegionMode | Mode which specifies how the search region is to be applied to the input image of a PMAlign inspection. |
| StartPose | Transform that defines the starting model pose within the input image. |
| Timeout | The maximum execution time (msec) allowed to run a PMAlign inspection. If PMAlign has not finished by the end of the timeout period, it will stop soon thereafter and return E_Cog_TimeoutExpired. This value only applies if TimeoutEnabled is true. |
| TimeoutEnabled | If true then the Timeout property limits the execution time of the PMAlign inspection. If false then timeout is disabled and the Timeout property is ignored. |
| XYOverlap | Result candidates overlap in area if the percentage of area overlap is greater than XYOverlap. PMAlign discards the weaker pattern instance when two pattern instances overlap for all DOFs as well as area. |
| ZoneAngle | Zone configuration for the angle degree of freedom. Units are in Radians. |
| ZoneScale | Zone configuration for the uniform scale degree of freedom. |
| ZoneScaleX | Zone configuration for the X scale degree of freedom only. |
| ZoneScaleY | Zone configuration for the Y scale degree of freedom only. |
Events
| Name | Description | |
|---|---|---|
 | Changed | Occurs when one or more parts of the object's state may have changed. |
Remarks
Interface for PMAlign run parameters.
See Also