This class holds one result item of the results.
Each result corresponds to a found instance of the pattern.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.SearchMax CogSearchMaxResult
Namespace: Cognex.VisionPro.SearchMax
Assembly: Cognex.VisionPro.SearchMax (in Cognex.VisionPro.SearchMax.dll) Version: 69.0.0.0
Syntax
The CogSearchMaxResult type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| CogSearchMaxResult(CogSearchMaxResult) |
Constructs a deep copy of the supplied CogSearchMaxResult object.
| |
| CogSearchMaxResult(SerializationInfo, StreamingContext) |
Methods
| Name | Description | |
|---|---|---|
| Clone | ||
| 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.) | |
| CreateResultGraphics |
Creates a composite result graphic containing child graphics specified
by the GraphicOptions which is a bitwise combination of
CogSearchMaxResultGraphicConstants.
The graphics options. Supply a value formed by ORing together one or
more of the values defined in CogSearchMaxResultGraphicConstants.
| |
| 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.) | |
| GetPose |
Gets the transform from "Pattern Space" to the selected space of the
run-time input image. This transform can be used to find any point
relative to the pattern in the selected space of the run-time input
image.
| |
| 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.) | |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
| Accepted |
Gets whether the result's Score was greater than or equal to
the accept threshold.
| |
| Contrast |
Gets the contrast for this result. Contrast is the ratio of
the standard deviation of the pixels in the located pattern to the
standard deviation of the care pixels in the trained pattern.
| |
| ID |
Gets a unique ID used to identify this result. This ID also corresponds
to the index of this result in the CogSearchMaxResults to which
this result belongs.
| |
| RelativeBrightness |
Gets the relative brightness for this result. Relative brightness
is the ratio of the mean of the pixels in the located pattern to the
mean of the care pixels in the trained pattern.
| |
| Score |
Gets the score for this result. The score is between 0.0 and 1.0 with
higher values indicating a closer match between the trained pattern and
the pattern in the search image.
|
See Also