CogPMAlignPattern PropertiesCognex VisionPro 9.21

The CogPMAlignPattern type exposes the following members.

Properties

  NameDescription
Public propertyAutoEdgeThresholdEnabled
If true, an automatically computed edge threshold will be used for training. If false, the user provided edge threshold will be used.
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 propertyComposite
Gets or sets the CogPMAlignComposite object.
Public propertyEdgeThreshold
Train-time edge threshold, under which, the edges will be ignored. Valid value is from 0.0 to 65535.0. Default value is 10.0.
Public propertyElasticity
The elasticity value is the amount of feature variance, in pixels, that PMAlign allows. Setting a nonzero elasticity value permits PMAlign to find pattern instances with nonlinear geometric variation to be found.
Public propertyExpectedDeformationRate
The expected deformation rate of the PatFlex pattern. This has no effect unless the TrainAlgorithm is PatFlex.
Public propertyGrainLimitAutoSelect
If true then PMAlign will automatically generate grain limits during training. If false then the values stored in the pattern prior to training will be used.
Public propertyGrainLimitCoarse
Coarse granularity limit. User can manually set the grain limit if GrainLimitAutoSelect is false. Valid range is 1.0 to 25.5 inclusive. Coarse must be greater than or equal to fine. Setting coarse less than fine will also set fine to the new value.
Public propertyGrainLimitFine
Fine granularity limit. User can manually set the grain limit if GrainLimitAutoSelect is false. Valid range is 1.0 to 25.5 inclusive. Coarse must be greater than or equal to fine. Setting fine greater than coarse will also set coarse to the new value.
Public propertyHasChanged
If true, the serializable state of this object has changed since the last time it was serialized.
Public propertyHighSensitivityParameter
Control the sensitivity parameter used by PatMax when TrainAlgorithm is cogPMAlignTrainAlgorithmPatMaxHighSensitivity.
Public propertyIgnorePolarity
If true, pattern polarity is ignored. If false, only patterns with polarity matching the trained pattern will be found.
Public propertyOrigin
A 6 DOF origin for the pattern. This transform maps from "Pattern Space" to the selected space of TrainImage.
Public propertyPCPDiagMessage
Diagnostic data string for use by Cognex.
Public propertyPCPString
Customization string (PCP) used to customize this PMAlign pattern. The PCP string can be set by either setting the PCPString property directly or calling the PCPLoadFromFile method. An empty string indicates that no PCP is set for this pattern.
Public propertyRepeatingPatterns
If true and training algorithm is Patmax, the pattern will be trained specially for repeating patterns. Otherwise, the pattern will be trained as before.
Public propertyRuntimeScoringMethod
Instructs the pattern how to treat non-visible pixels at run-time.
Public propertyTrainAlgorithm
Algorithm(s) used to train this PMAlign pattern. The PMAlign pattern can only be executed using the algorithms that were enabled at train-time. The algorithm actually used at run-time is specified in ICogPMAlignRunParams.
Public propertyTrained
True if the pattern is trained.
Public propertyTrainImage
Pattern image used to train PMAlign. The TrainRegion is applied to this TrainImage in order to define the region that will be used to train the pattern. The TrainRegionMode property specifies how the region will be applied to this image.
Public propertyTrainImageMask
Mask used when training the PMAlign pattern. The mask allows the user to identify areas of the pattern as "Care" or "Don't Care". The "Don't Care" areas can also be subclassified into "Score" and "Don't Score" with regards to clutter.
Public propertyTrainImageMaskOffsetX
X offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the TrainImage to the upper-left corner of the TrainImageMask in image coordinates of the TrainImage.
Public propertyTrainImageMaskOffsetY
Y offset value in pixels. The X & Y offset values measure the offset from the upper-left corner of the TrainImage to the upper-left corner of the TrainImageMask in image coordinates of the TrainImage.
Public propertyTrainMode
Train mode indicates whether a PMAlign pattern should be trained based on the pixel content of the training image or trained based on a synthetic pattern described by a collection of shape models.
Public propertyTrainRegion
Region of interest indicating portion of TrainImage or TrainShapeModels that will be used to train the pattern. A NULL TrainRegion indicates that the entire TrainImage or TrainShapeModels will be used to train the PMAlign pattern.
Public propertyTrainRegionMode
Specifies how the TrainRegion is applied to the TrainImage.
Public propertyTrainShapeModels
A collection of shape models used to train a PMAlign pattern when the TrainMode property is either cogPMAlignTrainModeShapeModelsWithImage or cogPMAlignTrainModeShapeModelsWithTransform.
Public propertyTrainShapeModelsTransform
Transform defines the space of all shape models when TrainMode is cogPMAlignTrainModeShapeModelsWithTransform, otherwise, this transform is ignored. This is a pixel from shape model space transform.
Top
See Also