CogSearchMaxRunParams PropertiesCognex VisionPro 9.8

The CogSearchMaxRunParams type exposes the following members.

Properties

  NameDescription
Public propertyAcceptThreshold
Gets or sets the 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 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 propertyCompressionEnabledForScore
Gets or sets the use Compression Enabled For Score property. If false, SearchMax will use the uncompressed models to calculate final scores of found results even if it was trained and run using the Compression. See CogSearchMaxCompressionModeConstants for details.
Public propertyConfusionThreshold
Gets or sets the confusion threshold on the score of a result which is a hint regarding how confusing the search image is likely to be. A high value slows the search but ensures that wrong features are not found. A low value speeds up the search for non-confusing scenes. Must be >= AcceptThreshold. Valid range is from 0 to 1.
Public propertyContrastEnabled
Gets or sets whether to enable contrast. If true then ContrastRangeLow and ContrastRangeHigh properties will be used to search only the patterns within the defined contrast range. If false then ContrastRangeLow and ContrastRangeHigh properties are ignored during SearchMax search.
Public propertyContrastRangeHigh
Gets or sets the highest acceptable contrast for a located pattern. Contrast is the ratio of the standard deviation of the corresponding care pixels in the located pattern to the standard deviation of the care pixels in the trained pattern.
Public propertyContrastRangeLow
Gets or sets the lowest acceptable contrast for a located pattern. Contrast is the ratio of the standard deviation of the corresponding care pixels in the located pattern to the standard deviation of the care pixels in the trained pattern.
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Public propertyIgnorePolarity
Gets or sets whether to ignore polarity. If true, pattern polarity is ignored. If false, only patterns with polarity matching the trained pattern will be found.
Public propertyMaximumNumberToFind
Gets or sets the Maximum number of results to look for. In some cases, SearchMax may return fewer results than requested.
Public propertyOriginBoundary
Gets or sets the origin boundary. The origin boundary will limit the parts of the image where the pattern may be found such that the found pattern's origin must be within the origin boundary. This value is ignored unless RunMode is set to SearchImageWithOriginBoundary.
Public propertyRelativeBrightnessEnabled
Gets or sets whether to enable relative brightness. If true then RelativeBrightnessRangeLow and RelativeBrightnessRangeHigh properties will be used to search only the patterns within the defined relative brightness range. If false then RelativeBrightnessRangeLow and RelativeBrightnessRangeHigh properties are ignored during SearchMax search.
Public propertyRelativeBrightnessRangeHigh
Gets or sets the highest acceptable relative brightness for a located pattern. Relative brightness is the ratio of the mean of the corresponding care pixels in the located pattern to the mean of the care pixels in the trained pattern.
Public propertyRelativeBrightnessRangeLow
Gets or sets the lowest acceptable relative brightness for a located pattern. Relative brightness is the ratio of the mean of the corresponding care pixels in the located pattern to the mean of the care pixels in the trained pattern.
Public propertyRunAlgorithm
Gets or sets the run algorithm that is used to search for the pattern.
Public propertyRunMode
Gets or sets the run mode that is used to search for the pattern.
Public propertySearchImageMask
Gets or sets the mask that is used when running the CogSearchMax. The mask allows the user to identify areas of the run-time image as "Care" or "Don't Care". The mask is aligned to the run-time input image using the SearchImageMaskOffsetX and SearchImageMaskOffsetY values.
Public propertySearchImageMaskOffsetX
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 run-time input image to the upper-left corner of the SearchImageMask in image coordinates of the input image.
Public propertySearchImageMaskOffsetY
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 run-time input image to the upper-left corner of the SearchImageMask in image coordinates of the input image.
Public propertySearchRegionMode
Gets or sets the region mode which specifies how the region is applied to the input image.
Public propertyStartPose
Gets or sets the start pose. The start pose specifies the expected location of the pattern origin relative to the input image's selected coordinate space. This property is for advanced users.
Public propertyStartPoseTranslationUncertaintyX
Gets or sets the amount of + or - X translation to search about the start pose. This value is ignored if RunMode is not set to SearchImageWithStartPose.
Public propertyStartPoseTranslationUncertaintyY
Gets or sets the amount of + or - Y translation to search about the start pose. This value is ignored if RunMode is not set to SearchImageWithStartPose.
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 propertyTimeout
Gets or sets the maximum execution time (msec) allowed to run a SearchMax. If SearchMax 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
Gets or sets whether to enable timeout. If true then the Timeout property limits the execution time of SearchMax. If false then timeout is disabled and the Timeout property is ignored.
Public propertyXYOverlap
Gets or sets the area overlap threshold. Result candidates overlap in area if the percentage of area overlap is greater than XYOverlap. SearchMax discards the weaker pattern instance when two pattern instances overlap for all DOFs as well as area. Valid range is from 0 to 1.0.
Public propertyZoneAngle
Gets or sets the runtime zone configuration for the angle degree of freedom. Units are in Radians.
Public propertyZoneScale
Gets or sets the runtime zone configuration for the uniform scale degree of freedom.
Public propertyZoneScaleX
Gets or sets the zone configuration for the X scale degree of freedom only.
Public propertyZoneScaleY
Gets or sets the zone configuration for the Y scale degree of freedom only.
Public propertyZoneSkew
Gets or sets the runtime zone configuration for the skew degree of freedom. Units are in Radians.
Public propertyZoneUsePattern
Gets or sets whether to use zone information of DOFs from CogSearchMaxPattern. If true, zone information of DOFs specified in CogSearchMaxPattern will be used; otherwise, zone information specified in this CogSearchMaxRunParams will be used.
Top
See Also