CogOCRMaxPositionResult ClassCognex VisionPro 9.5
Contains a the result for a single character position in a CogOCRMaxLineResult.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.OCRMax CogOCRMaxPositionResult

Namespace: Cognex.VisionPro.OCRMax
Assembly: Cognex.VisionPro.OCRMax (in Cognex.VisionPro.OCRMax.dll) Version: 69.0.0.0
Syntax

[SerializableAttribute]
public class CogOCRMaxPositionResult : CogSerializableObjectBase

The CogOCRMaxPositionResult type exposes the following members.

Constructors

  NameDescription
Public methodCogOCRMaxPositionResult 
Construct a default CogOCRMaxPositionResult object.
Public methodCogOCRMaxPositionResult(CogOCRMaxPositionResult)
Constructs a deep copy of the supplied CogOCRMaxPositionResult object.
Protected methodCogOCRMaxPositionResult(SerializationInfo, StreamingContext)
Serialization constructor for CogOCRMaxPositionResult.
Top
Methods

  NameDescription
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetCharacter
Gets a CogOCRMaxChar representation of this position result. CogOCRMaxChars contain information about a character which is necessary for training the classifier. Usually CogOCRMaxChars are extracted from the result and added to the Classifier's Font using the OCRMaxTool.Classifier.Font.Add() method. This process is repeated until the training information in the font enables the classifier to successfully read all the characters of interest to the OCRMax application.
Protected methodGetClassName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetComponentName
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetConverter
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultEvent
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetDefaultProperty
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEditor
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetEvents( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodGetObjectData
Implements the GetObjectData method of the ISerializable interface.
(Inherited from CogSerializableObjectBase.)
Protected methodGetProperties 
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetProperties( Attribute )
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Protected methodGetPropertyOwner
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
Public methodGetString 
Returns a string which represents this CogOCRMaxPositionResult.
Public methodGetString(String)
Returns a string which represents this CogOCRMaxPositionResult.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Obtains a lifetime service object to control the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Protected methodMemberwiseClone 
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodMemberwiseClone(Boolean)
Creates a shallow copy of the current MarshalByRefObject object.
(Inherited from MarshalByRefObject.)
Public methodToString (Overrides Object ToString .)
Top
Properties

  NameDescription
Public propertyAlternativeCharacters
The list of alternative characters. These characters induced scores satisfying the alternative score threshold.
Public propertyCellRect
The cell rectangle of position result in the image. The cell rectangle is a bounding box that encloses not only all of the foreground (e.g. ink) pixels of a character image, but also typically additional padding region. Cell rectangles are typically height of the full line of text containing the character. Ideally, all of the cell rectangles in a line of text touch their adjacent neighbors.
Public propertyCharacterCode
The character code, which is a Unicode UTF-32 code point.
Public propertyConfidenceScore
The confidence score, in the range [0, 1].
Public propertyConfusionCharacter
The confusion character.
Public propertyConfusionExplanation
The reason that lead to the Confused status.
Public propertyID
Gets a unique ID used to identify this result. This ID also corresponds to the index of this result in the CogOCRMaxLineResult to which this result belongs.
Public propertyMarkRect
The mark rectangle of the position result in the image. The mark rectangle of a character is a tight bounding box enclosing all of foreground (e.g. ink) pixels in the character image.
Public propertyPolarity
The Polarity of the character.
Public propertyProcessedImage
The processed image, which is generated from the input rectified image and used for classification.
Public propertyScore
The position result score.
Public propertySkippedTrainCharacterIndices
The list of indices to training character instances that were skipped (i.e., not considered) during classification, e.g., due to violating scale/size constraints.
Public propertyStatus
The status of the OCRMax read operation at this character position summarized into one of four discrete states.
Top
Remarks

The CogOCRMaxPositionResult contains detailed information about the character position found in the image. This includes:
MarkRect and CellRectPosition of the found character in the image
CharacterCodeWhat Character was read at this position (also available via GetString())
ScoreHow closely the character matched the font character
KeyWhich character in the CogOCRMaxFont was the matching character
ConfidenceScoreA measure of how certain the Tool is of the chosen match when compared with the next best match
ConfusionCharacterThe next best matching character
AlternativeCharactersA list of other characters that were near matches
StatusInformation about the position result sumarized into a set of discrete status values
IDA unique ID used to identify this result. This ID also corresponds to the index of this result in the CogOCRMaxLineResult to which this result belongs.
See Also