Class which holds a single CNLSearch result. Each result corresponds to a found instance of the pattern.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.CNLSearch CogCNLSearchResult
Namespace: Cognex.VisionPro.CNLSearch
Assembly: Cognex.VisionPro.CNLSearch (in Cognex.VisionPro.CNLSearch.dll) Version: 69.0.0.0
Syntax
The CogCNLSearchResult type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogCNLSearchResult | Constructs a new instance of this class. |
| CogCNLSearchResult(IntPtr) | Constructs a new instance of this class using com pointer. |
| CogCNLSearchResult(CogCNLSearchResult) | Constructs a new instance of this class as a deep copy of the given instance. |
Methods
| Name | Description | |
|---|---|---|
 | Clone | Returns a deep copy of this class instance. Derived classes that implement Clone should override this method; other clients who wish to clone this instance should call ICloneable.Clone. See also CogSerializer.DeepCopyObject |
| 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 CogCNLSearchResultGraphicConstants. |
| Dispose | |
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Finalize | (Overrides Object Finalize .) |
| 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 | |
| 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 | True if the result's Score was >= the AcceptThreshold specified in the CogCNLSearchRunParams. |
| AreaCoverageScore | The AreaCoverageScore indicates the fraction of the pattern that lies within the search region. The returned value is in the range 0.0 through 1.0. Only the Linear Search algorithm can find pattern matches that are partially outside of the search region. |
| AreaScore | The AreaScore represents the quality of the match regardless of the amount of the pattern that appears in the image. This value is between 0.0 and 1.0 with higher values indicating a closer match between the trained pattern and the pattern match. |
| Contrast | The Contrast is the ratio of the standard deviation of the pixels in the trained pattern to the standard deviation of the care pixels in the located pattern. |
| ContrastComputed | True if the result's Contrast has been computed. This will only be true if the LinearSearch algorithm was used to compute this result. |
| EdgeHit | Indicates whether this pattern instance was found against one or more edges of the search region. This value is composed by performing a bitwise OR of CogCNLSearchEdgeHitConstants. |
| EdgeScore | The EdgeScore represents the quality of the match between the edges of the trained pattern and the edges of the pattern match in the search image. This value is between 0.0 and 1.0 with higher values indicating a closer match. |
| EdgeScoreComputed | True if the result's EdgeScore has been computed. This will only be true if the NonLinearCNLPAS algorithm was used to compute this result. |
| ID | A unique ID used to identify this CNLSearch result. This ID also corresponds to the index of this result in the CogCNLSearchResults to which this result belongs. |
| LocationX | The X component of the location at which this pattern instance was found. The location corresponds the pattern's origin and is specified in units of the selected space of the InputImage. |
| LocationY | The Y component of the location at which this pattern instance was found. The location corresponds the pattern's origin and is specified in units of the selected space of the InputImage. |
| Score | 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. The Score will be reduced if the result is a partial match and PartialMatchReduceScore is true. |
| SelectedSpaceName | Returns the name of the selected space of the input image at run-time. The location of this result is specified in units of the selected space. |
Remarks
Interface for a single CNLSearch result. Each result corresponds to a found instance of the pattern.
See Also