This class encapsulates the run time parameters used by
Execute method of
CogSearchMaxPattern
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.SearchMax CogSearchMaxRunParams
Namespace: Cognex.VisionPro.SearchMax
Assembly: Cognex.VisionPro.SearchMax (in Cognex.VisionPro.SearchMax.dll) Version: 75.0.0.0
Syntax
The CogSearchMaxRunParams type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogSearchMaxRunParams |
Construct a default CogSearchMaxRunParams object.
|
| CogSearchMaxRunParams(CogSearchMaxRunParams) |
Construct a deep copy of the supplied CogSearchMaxRunParams object.
|
 | CogSearchMaxRunParams(SerializationInfo, StreamingContext) |
Methods
| Name | Description | |
|---|---|---|
| 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.) |
| Equals | (Inherited from Object.) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| 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 |
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.) |
| 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.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(CogChangedEventArgs) |
This method may be called internally whenever a derived object's state
may have changed and the derived object expresses this change via a
derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.) |
| ResumeAndRaiseChangedEvent |
Re-enables raising of the Changed event after SuspendChangedEvent
has been called, and 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.
(Inherited from CogSerializableChangedEventBase.) |
| 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.
(Inherited from CogSerializableChangedEventBase.) |
| ToString | (Inherited from Object.) |
Fields
Properties
| Name | Description | |
|---|---|---|
 | AcceptThreshold |
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.
|
| 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.
(Inherited from CogSerializableChangedEventBase.) |
| CompressionEnabledForScore |
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.
|
| ConfusionThreshold |
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.
|
| ContrastEnabled |
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.
|
| ContrastRangeHigh |
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.
|
| ContrastRangeLow |
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.
|
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| IgnorePolarity |
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.
|
| MaximumNumberToFind |
Gets or sets the Maximum number of results to look for. In some cases,
SearchMax may return fewer results than requested.
|
| OriginBoundary |
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.
|
| RelativeBrightnessEnabled |
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.
|
| RelativeBrightnessRangeHigh |
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.
|
| RelativeBrightnessRangeLow |
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.
|
| RunAlgorithm |
Gets or sets the run algorithm that is used to search for the pattern.
|
| RunMode |
Gets or sets the run mode that is used to search for the pattern.
|
| SearchImageMask |
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.
|
| SearchImageMaskOffsetX |
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.
|
| SearchImageMaskOffsetY |
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.
|
| SearchRegionMode |
Gets or sets the region mode which specifies how the region
is applied to the input image.
|
| StartPose |
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.
|
| StartPoseTranslationUncertaintyX |
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.
|
| StartPoseTranslationUncertaintyY |
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.
|
| StateFlags |
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.) |
| Timeout |
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.
|
| TimeoutEnabled |
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.
|
| XYOverlap |
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.
|
| ZoneAngle |
Gets or sets the runtime zone configuration for the angle degree of
freedom. Units are in Radians.
|
| ZoneScale |
Gets or sets the runtime zone configuration for the uniform scale degree of
freedom.
|
| ZoneScaleX |
Gets or sets the zone configuration for the X scale degree of freedom
only.
|
| ZoneScaleY |
Gets or sets the zone configuration for the Y scale degree of freedom
only.
|
| ZoneSkew |
Gets or sets the runtime zone configuration for the skew degree of
freedom. Units are in Radians.
|
| ZoneUsePattern |
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.
|
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also