Cognex.VisionPro.OCRMax NamespaceCognex VisionPro 9.20
 
Classes

  ClassDescription
Public classCogOCRMaxChar
This class contains data associated with characters in OCRMax. This includes the character's character code, the character's image, rectangles that describe where the character appears in the image, and other data.
Public classCogOCRMaxCharKey
The CogOCRMaxChar class holds an object of type CogOCRMaxCharKey in its Key property. The Key contains information that identifies the CogOCRMaxChar. Most importantly the Key property holds the CharacterCode. The CharacterCode is a Unicode UTF-32 value which determines the 'letter' a CogOCRMaxChar corresponds to.
Public classCogOCRMaxCharKeyCollection
A collection of CogOCRMaxCharKey objects.
Public classCogOCRMaxCharMetrics
This class contains metadata associated with characters for OCRMax.
Public classCogOCRMaxClassifier
Classification is the second main step in performing OCRMax. Classification takes in a CogOCRMaxChar produced by the segmenter and returns the best matching character, the score of that best matching character, and the confidence of that best matching character. By classifying all of the segmented characters in a line of text, the classifier determines the result string for the whole line. See the OCRMax Theory Guide for more information.
Public classCogOCRMaxClassifierCharResult
Result data for one potential classification of the run-time image.
Public classCogOCRMaxClassifierCharResultCollection
A Collection of CogOCRMaxClassifierCharResults.
Public classCogOCRMaxClassifierLineResult
All result data for the classification of one line of characters.
Public classCogOCRMaxClassifierPositionResult
All result data for the classification of a run-time character.
Public classCogOCRMaxClassifierRunParams
Run-time parameters for the OCRMax Classifier.
Public classCogOCRMaxClassifierTrainParams
Training parameters for the OCRMax Classifier.
Public classCogOCRMaxFielding
Fielding is the third main step in performing OCRMax.

Fielding takes the Classifier results as an input and outputs a refined set of results based on prior information and expectations of the text being read. For instance, if you know the text being read always start with the letter 'C', fielding can use this information to improve the classifier results.

The Classifier results represent a line of character positions and the scores of different characters at each position.

A user configures the Fielding to provides information about what characters are expected at different positions in the string. Fielding uses this information, and the information in the Classifier results, to make small corrections in situations where the Classifier was unable to make a clear determination of what character was printed at a particular position. Fielding may also use the expected string information to invalidate the classifier result at locations where the classifier found something very different than what was expected by the fielding.

Public classCogOCRMaxFieldingDefinition
This class is a named, reusable description of the characters that are expected at some position. Multiple character positions may be specified by referring to the name, or 'alias', of a single field definition object.
Public classCogOCRMaxFieldingDefinitionCollection
This class holds zero or more CogOCRMaxFieldingDefinition objects. Note that the ordering of objects within this collection does not affect processing.
Public classCogOCRMaxFieldingLineResult
The result of fielding a line of text.
Public classCogOCRMaxFieldingPositionResult
A verification result for a single position.
Public classCogOCRMaxFont
A container of CogOCRMaxChars (character images and their associated character codes) used to train the OCRMax classifier.
Public classCogOCRMaxLineResult
A Collection of CogOCRMaxPositionResults which represent the output/result of running the OCRMax tool.
Public classCogOCRMaxPositionResult
Contains a the result for a single character position in a CogOCRMaxLineResult.
Public classCogOCRMaxSegmenter
CogOCRMaxSegmenter performs the first main step of OCRMax. Segmentation takes an image containing a line of text as input, and outputs CogOCRMaxChar(s) structures which contain information about where individual characters can be found in the image. For example, if the input image contains the line of text "ABCD", then segmenter outputs four separate CogOCRMaxChars, each of which contains an image of a single character. The segmenter does not know anything about actually determining which letter a CogOCRMaxChar corresponds to; in the above example, it has no way of knowing that the CogOCRMaxChar is the letter "A". The job of identifying each CogOCRMaxChar is left to the classifier. See the OCRMax Theory Guide for more information.
Public classCogOCRMaxSegmenterCharacterStatistics
Statistical information about a set of OCRMax Segmenter characters
Public classCogOCRMaxSegmenterElementInfo
Information about an OCR element, which could be a fragment or character. One or more fragments joined together constitute a character. A fragment can also get split into more than one character.
Public classCogOCRMaxSegmenterElementInfoCollection
A collection of CogOCRMaxSegmenterElementInfos
Public classCogOCRMaxSegmenterFragmentStatistics
Statistical information about a set of OCRMax Segmenter fragments
Public classCogOCRMaxSegmenterLineResult
A segmenter line result represents an entire line of segmented characters.
Public classCogOCRMaxSegmenterLineResultDiagnostics
Contains information about how the OCRMax Segmenter arrived at a particular line result.
Public classCogOCRMaxSegmenterParagraphResult
A segmentation paragraph result contains one or more lines of segmented characters.
Public classCogOCRMaxSegmenterPositionResult
A segmentation position result represents a single segmented character.
Public classCogOCRMaxSegmenterResult
A segmenter result is a collection of one or more CogOCRMaxSegmenterParagraphResults. This result is returned when using the Execute override that accepts multiple regions of interest as inputs.
Public classCogOCRMaxSegmenterSpaceParams
Parameters to control how spaces between characters are handled by the segmenter.
Public classCogOCRMaxSwapChar
This class defines a single group of swap characters. Characters within the group are swappable with each other. (They appear similar and are hard to distinguish, e.g. '0' (zero) and 'O' (capital oh)).
Public classCogOCRMaxSwapCharSet
This class is a container that holds multiple CogOCRMaxSwapChars. Each CogOCRMaxSwapChar holds a set of character codes that are "swappable" with each other.
Public classCogOCRMaxTool
The CogOCRMaxTool (Optical Character Recognition) reads a line of text in an image. The CogOCRMaxTool performs three primary operations: segmentation, classification, and fielding. Segmentation occurs first and uses thresholding techniques to identify which areas in the image appear to contain lines of text. Classification occurs second and is responsible for "reading" any text found by the segmenter. It does this by comparing the images of segmented characters to previously acquired images of known characters in a font. Fielding is the third and final stage of OCRMax. Fielding is an optional step which uses prior information about the text being read to improve or correct the classification results. For more details see the documentation for CogOCRMaxSegmenter, CogOCRMaxClassifier, CogOCRMaxFielding, as well as the OCRMax Theory Guide.
Public classCogOCRMaxTuneData
CogOCRMaxTuneData contains a set of CogOCRMaxTuneRecords for use with training the CogOCRMaxTool.
Public classCogOCRMaxTuneParams
Tune parameters for the CogOCRMaxTool.
Public classCogOCRMaxTuneRecord
Contains data about a line of text in an image that can be used to tune the CogOCRMaxTool.
Public classCogOCRMaxTuneRecordCollection
A collection of CogOCRMaxTuneRecords
Public classCogRectangleAffineCollection
A collection of CogRectangleAffine objects.
Enumerations

  EnumerationDescription
Public enumerationCogOCRMaxCharCodeConstants
Cognex Custom Character Codes
Public enumerationCogOCRMaxClassifierAlgorithmConstants
The algorithm to use for classification
Public enumerationCogOCRMaxClassifierAspectModeConstants
The Aspect Mode to use for classification
Public enumerationCogOCRMaxClassifierConfusionExplanationConstants
The reason a classified character was confused
Public enumerationCogOCRMaxClassifierImagePreprocessingConstants
What image preprocessing to perform before classification. Note that if both are enabled, histogram normalization happens after median subtraction.
Public enumerationCogOCRMaxClassifierPositionStatusConstants
The status of a classified character
Public enumerationCogOCRMaxCurrentRecordConstants
Enumeration of data that can be provided in the Tool's CurrentRecord.
Public enumerationCogOCRMaxFieldingAcceptedMetricConstants
How the CogOCRMaxFielding operator will judge Accepted.
Public enumerationCogOCRMaxFieldingConfusionMetricConstants
How confidence/confusion will be computed by the CogOCRMaxFielding operator.
Public enumerationCogOCRMaxFieldingStatusConstants
Status values returned by fielding to indicate the state of a fielded position result.
Public enumerationCogOCRMaxLastRunRecordConstants
Enumeration of non-diagnostic data that can be provided in the Tool's LastRunRecord.
Public enumerationCogOCRMaxLastRunRecordDiagConstants
Enumeration of diagnostic data that can be provided in the Tool's LastRunRecord.
Public enumerationCogOCRMaxLineResultStatusConstants
Conveys information about the state of an OCRMax Tool's Line Result. Returns the most severe status found in the line result's position results.
Public enumerationCogOCRMaxPolarityConstants
Enumeration of character polarity constants.
Public enumerationCogOCRMaxPositionResultStatusConstants
Conveys information about the state of an Position Result
Public enumerationCogOCRMaxResultGraphicConstants
Enumeration of data used for creating result graphics.
Public enumerationCogOCRMaxSegmenterAnalysisModeConstants
Type of analysis to perform in order to determine the optimal character segmentation.
Public enumerationCogOCRMaxSegmenterCellRectangleWidthTypeConstants
Used to describe how OCRMax will compute the width of the cell rectangle that surrounds each character.
Public enumerationCogOCRMaxSegmenterCharacterFragmentMergeModeConstants
How to merge character fragments to form characters during the Group stage. Note that the Analyze stage may perform additional merges.
Public enumerationCogOCRMaxSegmenterElementActionConstants
Provides diagnostic information about segmenter characters and fragments in order to show how the segmenter arrived its results.
Public enumerationCogOCRMaxSegmenterFontCharWidthTypeConstants
Used to describe the width of characters for OCRMax.
Public enumerationCogOCRMaxSegmenterFontPitchMetricConstants
Describes the pitch of characters for OCRMax.
Public enumerationCogOCRMaxSegmenterFontPitchTypeConstants
Used to describe the pitch of characters for OCRMax.
Public enumerationCogOCRMaxSegmenterLineRefinementModeConstants
Describes the method of line refinement for OCRMax character segmentation.
Public enumerationCogOCRMaxSegmenterNormalizationModeConstants
How to normalize the image so that the normalized image can be binarized well using only a global threshold.
Public enumerationCogOCRMaxSegmenterSpaceInsertModeConstants
How to handle insertion of space characters into gaps between other characters.
Public enumerationCogOCRMaxSegmenterSpaceScoreModeConstants
How to compute the score of a space character.
Public enumerationCogOCRMaxTunablePropertiesConstants
Controls which CogOCRMaxSegmeter properties will be tunned.
Public enumerationCogOCRMaxTuneRecordOrigin
Identifies tune record for use with OCRMax tuning was created.