CogSearchMaxPattern PropertiesCognex VisionPro 9.8

The CogSearchMaxPattern type exposes the following members.

Properties

  NameDescription
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.
(Inherited from CogSerializableChangedEventBase.)
Public propertyCompressionMode
Gets or sets the compression mode which specifies how the CogSearchMaxPattern is trained and run.
Public propertyCompressionQuality
Gets or sets the CompressionQuality which specifies how much the lossy compression algorithm will compress the trained image model. This value is ignored if compression mode is not lossy.
Public propertyCvlCompatibilityMode
Cognex internal use only.
Public propertyGrainLimitAutoSelect
Gets or sets whether CogSearchMaxPattern will automatically generate grain limits during training. If false then the values stored in the pattern prior to training will be used.
Public propertyGrainLimitCoarse
Gets or sets the coarse granularity limit. User can manually set the grain limits, but if GrainLimitAutoSelect is true, they will be overwritten by the automatically generated granularity limits. Coarse must be greater than or equal to fine. Setting coarse less than fine will also set fine to the new value.
Public propertyGrainLimitFine
Gets or sets the fine granularity limit. User can manually set the grain limits, but if GrainLimitAutoSelect is true, they will be overwritten by the automatically generated granularity limits. Coarse must be greater than or equal to fine. Setting fine greater than coarse will also set coarse to the new value.
Public propertyGranularityMode
Gets or sets the granularity mode which specifies the method used to generate the coarse model at a given granularity or resolution.
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Public propertyOrigin
Gets or sets a 6 DOF origin for the pattern. This transform maps from "Pattern Space" to the selected space of TrainImage
Public propertyStateFlags
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.)
Public propertyTrained
Gets whether this pattern has been trained.
Public propertyTrainImage
Gets or sets the train image used to train SearchMax. The TrainRegion and TrainImageMask are applied to this TrainImage in order to define the region and care pixels that will be used to train the pattern. The TrainRegionMode property specifies how TrainRegion will be applied to this image.
Public propertyTrainImageMask
Gets or sets the mask that is used when training the CogSearchMaxPattern. The mask allows the user to identify areas of the TrainImage as "Care" (0) or "Don't Care" (255). The mask is aligned to the TrainImage using the TrainImageMaskOffsetX and TrainImageMaskOffsetY values.
Public propertyTrainImageMaskOffsetX
Gets or sets the X offset value in pixels. The X and 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
Gets or sets the Y offset value in pixels. The X and 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
Gets or sets the train mode which specifies how the CogSearchMaxPattern is trained.
Public propertyTrainRegion
Gets or sets the region of interest indicating portion of the TrainImage that will be used to train the pattern. A NULL TrainRegion indicates that the entire TrainImage will be used to train the CogSearchMaxPattern.
Public propertyTrainRegionMode
Gets or sets the region mode which specifies how the TrainRegion is applied to the TrainImage.
Public propertyTrainTimeout
Gets or sets the maximum execution time (msec) allowed to train SearchMax. If SearchMax has not finished training by the end of the timeout period, it will stop soon thereafter and return E_Cog_TimeoutExpired. This value only applies if TrainTimeoutEnabled is true.
Public propertyTrainTimeoutEnabled
Gets or sets whether to enable a train timeout. If true then the execution time of the SearchMax train operation is limited by the TrainTimeout. If false, then timeout is disabled and the TrainTimeout property is ignored.
Public propertyZoneAngle
Gets or sets the zone configuration for the angle degree of freedom for training pattern templates. Units are in Radians. This property is ignored if TrainMode is EvaluateDOFsAtRuntime.
Public propertyZoneScale
Gets or sets the zone configuration for the uniform scale degree of freedom used when training pattern templates. This property is ignored if TrainMode is EvaluateDOFsAtRuntime.
Public propertyZoneScaleX
Gets or sets the zone configuration for the X scale degree of freedom used for training pattern templates. This property is ignored if TrainMode is EvaluateDOFsAtRuntime.
Public propertyZoneScaleY
Gets or sets the zone configuration for the Y scale degree of freedom used for training pattern templates. This property is ignored if TrainMode is EvaluateDOFsAtRuntime.
Public propertyZoneSkew
Gets or sets the zone configuration for the Skew degree of freedom for training pattern templates. Units are in Radians. This property is ignored if TrainMode is EvaluateDOFsAtRuntime.
Top
See Also