This class holds all of the result information for a single character.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.OCVMax CogOCVMaxCharacterResult
Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 65.1.0.0
Syntax
The CogOCVMaxCharacterResult type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogOCVMaxCharacterResult(CogOCVMaxCharacterResult) | Construct a deep copy of the supplied CogOCVMaxCharacterResult object. |
 | CogOCVMaxCharacterResult(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.) |
| ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | Character | The character found at this position. This assumes that something was in fact found (e.g. that CharacterKey is not -1). This also assumes that the character keys in the associated font correspond to Unicode code point values. |
| CharacterArrangementPose | The pose of this character in arrangement space. Note that this property is only meaningful if CharacterArrangementPoseValid is true. |
| CharacterArrangementPoseValid | Whether or not the pose of this character in arrangement space was successfully computed. |
| CharacterIndex | The zero-based character index. This tells you which character within the containing line produced this particular result. Note of course that this index reflects the arrangement as it existed when this result was produced - if the arrangement has changed since then this index may no longer be valid. |
| CharacterKey | The key of the character found at this position. This will be -1 if VerificationStatus is Failed or if the verification type for the search was CogOCVMaxVerificationTypeConstants::Ignore. |
| CharacterParagraphPose | The pose of this character in paragraph space. Note that this property is only meaningful if CharacterParagraphPoseValid is true. |
| CharacterParagraphPoseValid | Whether or not the pose of this character in paragraph space was successfully computed. |
| CharacterSelectedBounds | The bounding affine rectangle of found character in selected space. Note that this property is only meaningful if CharacterSelectedBoundsValid is true. |
| CharacterSelectedBoundsValid | Whether or not the bounds of this character in selected space was successfully computed. |
| CharacterSelectedPose | The pose of this character in selected space. Note that this property is only meaningful if CharacterSelectedPoseValid is true. |
| CharacterSelectedPoseValid | Whether or not the pose of this character in selected space was successfully computed. |
| ConfidenceScore | The confidence score of this character. This is the verification score of this character minus the score of the best ConfusionScore, but not less than zero. |
| ConfusionKeys | The character keys of the characters causing confusion with this character, if VerificationStatus is Confused. If VerificationStatus is not Confused, this will be an empty array. Elements in this array correspond to elements in the ConfusionScores array. |
| ConfusionScores | The confusion scores of the characters causing confusion with this character, if VerificationStatus is Confused. If VerificationStatus is not Confused, this will be an empty array. Elements in this array correspond to elements in the ConfusionKeys array. |
| Empty | Whether or not this character position was empty, i.e. both failed and having no violation information. |
| FitError | The fit error of this character. Zero is the best possible value, while larger numbers are worse. While there is no theoretical upper limit, it is typically less than 10 in practical use. Will be -1 if not available. |
| LineIndex | The zero-based line index. This tells you which line within the containing paragraph produced this particular result. Note of course that this index reflects the arrangement as it existed when this result was produced - if the arrangement has changed since then this index may no longer be valid. |
| ParagraphIndex | The zero-based paragraph index. This tells you which paragraph within the arrangement produced this particular result. Note of course that this index reflects the arrangement as it existed when this result was produced - if the arrangement has changed since then this index may no longer be valid. |
| VerificationDOFScore | The verification DOF score of this character. |
| VerificationFullViolations | The verification full violations. These are the degrees of freedom (DOFs) of the full (i.e. image or start pose) search params that were violated and which therefore decreased the VerificationDOFScore for this character. |
| VerificationKeyViolations | The verification key violations. These are the degrees of freedom (DOFs) of the key search params that were violated and which therefore decreased the VerificationDOFScore for this character. |
| VerificationMatchScore | The verification match score of this character. |
| VerificationScore | The verification score of this character. |
| VerificationStatus | The verification status for this character. Possible values include Verified, Confused, and Failed. |
See Also