CogPMAlignRunParams PropertiesCognex VisionPro

The CogPMAlignRunParams type exposes the following members.

Properties

  NameDescription
Public propertyAcceptThreshold
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.
Public propertyApproximateNumberToFind
Number of results to look for. In some cases, PMAlign may return more or fewer results than requested.
Public propertyAutoEdgeThresholdEnabled
If true, user provided edge threshold will be used for training. If false, computed edge threshold will be used. Default value is false.
Public propertyChangedEventSuspended
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.
Public propertyCoarseAcceptThreshold
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.
Public propertyCoarseAcceptThresholdEnabled
Whether to use CoarseAcceptThreshold. Default is false.
Public propertyContrastThreshold
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.
Public propertyEdgeThreshold
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.
Public propertyGrainLimitCoarse
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.
Public propertyGrainLimitFine
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.
Public propertyGrainLimitsUsePattern
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.
Public propertyHasChanged
If true, the serializable state of this object has changed since the last time it was serialized.
Public propertyOutsideRegionThreshold
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.
Public propertyOwnedFlexParams
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.
Public propertyRunAlgorithm
The algorithm used to run this PMAlign pattern. The algorithm specified must be among those for which the PMAlign object was trained.
Public propertyRunMode
The mode in which this PMAlign pattern will be run.
Public propertySaveMatchInfo
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.
Public propertyScoreUsingClutter
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.
Public propertySearchImageMask
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.
Public propertySearchImageMaskOffsetX
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.
Public propertySearchImageMaskOffsetY
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.
Public propertySearchRegionMode
Mode which specifies how the search region is to be applied to the input image of a PMAlign inspection.
Public propertyStartPose
Transform that defines the starting model pose within the input image.
Public propertyTimeout
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.
Public propertyTimeoutEnabled
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.
Public propertyXYOverlap
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.
Public propertyZoneAngle
Zone configuration for the angle degree of freedom. Units are in Radians.
Public propertyZoneScale
Zone configuration for the uniform scale degree of freedom.
Public propertyZoneScaleX
Zone configuration for the X scale degree of freedom only.
Public propertyZoneScaleY
Zone configuration for the Y scale degree of freedom only.
Top
See Also