Cognex.VisionPro.OCVMax NamespaceCognex VisionPro 9.22
 
Classes

  ClassDescription
Public classCogOCVMaxCharacterIterator
This class provides easy access to character-level properties and methods of the CogOCVMaxPattern object. With this class you can navigate amongst all of the character positions within a single line within a single paragraph. You may NOT directly construct this object. Instead, use the CreateCharacterIterator method on either the containing line's iterator or on the top level CogOCVMaxPattern object. Also note that this class can not be persisted.
Public classCogOCVMaxCharacterResult
This class holds all of the result information for a single character.
Public classCogOCVMaxFont
This class represents the set of geometric character descriptions associated with a single font. We read the geometric description data from a predefined font file. In general a user does not create a font file. We can, however, adjust certain characteristics of a font such as its size and line spacing.
Public classCogOCVMaxFontRenderParams
This class encapsulates properties typically used to control rendering, or rendering-based processing of text in a particular font. These are the properties that allow one to fine-tune the correspondence between a CogOCVMaxFont and what is actually observed by a camera.
Public classCogOCVMaxLineIterator
This class provides easy access to line-level properties and methods of the CogOCVMaxPattern object. With this class you can navigate amongst all of the lines within a single paragraph. You may NOT directly construct this object. Instead, use the CreateLineIterator method on either the containing paragraph's iterator or on the top level CogOCVMaxPattern object. Also note that this class can not be persistedo.
Public classCogOCVMaxLineResult
This class holds all of the result information for a single line.
Public classCogOCVMaxParagraphIterator
This class provides easy access to paragraph-level properties and methods of the CogOCVMaxPattern object. With this class you can navigate amongst all of the paragraphs within the arrangement. You may NOT directly construct this object. Instead, use the CreateParagraphIterator method on the top level CogOCVMaxPattern object. Also note that this class can not be persisted.
Public classCogOCVMaxParagraphResult
This class holds all of the result information for a single paragraph.
Public classCogOCVMaxPattern

This class is the workhorse of the Cognex.VisionPro.OCVMax assembly; it does the actual optical character verification. This class contains the training parameters and trained state information. You can use this class to perform character verifcation, or you can use the tool, CogOCVMaxTool.

Unlike other vision tools that require training, OCVMax does not use a training image or training region. This class's training is based on synthetically generated images produced by CogOCVMaxFont.

Public classCogOCVMaxPatternCharacterAddedEventArgs
This class holds data provided by the CharacterAdded event. The CharacterAdded event fires in addition to the standard Changed event after one or more characters are added to the arrangement.
Public classCogOCVMaxPatternCharacterChangedEventArgs
This class holds data provided by the CharacterChanged event. The CharacterChanged event fires in addition to the standard Changed event after some aspect of a character in the arrangement has been changed.
Public classCogOCVMaxPatternCharacterRemovedEventArgs
This class holds data provided by the CharacterRemoved event. The CharacterRemoved event fires in addition to the standard Changed event after one or more characters in the arrangement have been removed.
Public classCogOCVMaxPatternLineAddedEventArgs
This class holds data provided by the LineAdded event. The LineAdded event fires in addition to the standard Changed event after one or more lines are added to the arrangement.
Public classCogOCVMaxPatternLineChangedEventArgs
This class holds data provided by the LineChanged event. The LineChanged event fires in addition to the standard Changed event after some aspect of a line in the arrangement has been changed.
Public classCogOCVMaxPatternLineRemovedEventArgs
This class holds data provided by the LineRemoved event. The LineRemoved event fires in addition to the standard Changed event after one or more lines in the arrangement have been removed.
Public classCogOCVMaxPatternParagraphAddedEventArgs
This class holds data provided by the ParagraphAdded event. The ParagraphAdded event fires in addition to the standard Changed event after one or more paragraphs are added to the arrangement.
Public classCogOCVMaxPatternParagraphChangedEventArgs
This class holds data provided by the ParagraphChanged event. The ParagraphChanged event fires in addition to the standard Changed event after some aspect of a paragraph in the arrangement has been changed.
Public classCogOCVMaxPatternParagraphRemovedEventArgs
This class holds data provided by the ParagraphRemoved event. The ParagraphRemoved event fires in addition to the standard Changed event after one or more paragraphs in the arrangement have been removed.
Public classCogOCVMaxPatternTrainProgressEventArgs
This class holds data provided by the TrainProgress event. The TrainProgess event fires periodically during training.
Public classCogOCVMaxPatternTuneProgressEventArgs
This class holds data provided by the TuneProgress event. The TuneProgress event fires periodically during tuning.
Public classCogOCVMaxPoseHelper
This class provides help in defining a pose for a text paragraph. The general usage model assumes that you have: a) An image depicting the actual text in question, b) A font object, and c) The text (one or more strings), and from these you wish to determine a pose at which the CogOCVMax operator or tool might process the image. There are five basic steps. First, set up the CogOCVMaxPoseHelper object by setting the Font and Text properties (and optionally modifying the FontRenderParams property). Second, call the InitialPoseEstimate() method to get a first guess at what the desired pose might be. Third, call the FinalPosePrepare() method to create a CogCompositeShape graphic using the estimated initial pose. Fourth, add the graphic to the interactive display and allow the user to dynamically adjust the position, rotation, size, scale, or skew of this graphic so as to superimpose the graphic on the corresponding text in the image. Fifth, call the FinalPoseComplete() method with the (user modified) CogCompositeShape graphic. This final step will yield a CogTransform2DLinear that describes the user specified pose.
Public classCogOCVMaxResult
This class holds all of the result information for an entire pattern.
Public classCogOCVMaxRunParams
This class encapsulates the run time parameters used by Execute(CogImage8Grey, ICogRegion, CogOCVMaxRunParams).
Public classCogOCVMaxSearchParams
This class encapsulates all of the parameters used to run the arrangement and/or character searches.
Public classCogOCVMaxSharedResult
Public classCogOCVMaxTool
This class provides tool level access to the CogOCVMaxPattern operator. This class encapsulates all of the classes required to perform an OCVMax inspection.
Public classCogOCVMaxTuneParams
This class encapsulates properties used to tune the CogOCVMaxPattern object.
Delegates

  DelegateDescription
Public delegateCogOCVMaxPatternCharacterAddedEventHandler
Public delegateCogOCVMaxPatternCharacterChangedEventHandler
Public delegateCogOCVMaxPatternCharacterRemovedEventHandler
Public delegateCogOCVMaxPatternLineAddedEventHandler
Public delegateCogOCVMaxPatternLineChangedEventHandler
Public delegateCogOCVMaxPatternLineRemovedEventHandler
Public delegateCogOCVMaxPatternParagraphAddedEventHandler
Public delegateCogOCVMaxPatternParagraphChangedEventHandler
Public delegateCogOCVMaxPatternParagraphRemovedEventHandler
Public delegateCogOCVMaxPatternTrainProgressEventHandler
Public delegateCogOCVMaxPatternTuneProgressEventHandler
Enumerations

  EnumerationDescription
Public enumerationCogOCVMaxCharacterRegistrationConstants
Constants used to select the type of registration (fitting) done for each character found.
Public enumerationCogOCVMaxCharacterStatusConstants
Constants which describe the overall outcome for the inspection of a single character.
Public enumerationCogOCVMaxCharacterTypeConstants
Constants to aid in specifying which characters within a given font to incorporate in the alphabet for a particular paragraph. These help provide an easier way to specify an alphabet than explicitly listing each character.
Public enumerationCogOCVMaxComputePosesConstants
Constants used to specify which poses to compute at run time. Computing poses takes additional execution time and may not be needed in all applications. Note that poses of individual characters are always computed.
Public enumerationCogOCVMaxCurrentRecordConstants
Enumeration of data that can be included in the tool's CurrentRecord.
Public enumerationCogOCVMaxCustomizationTypeConstants
Constants used in customizing a CogOCVMaxPattern object.
Public enumerationCogOCVMaxDOFAttributeConstants
Constants to help specify which aspect of a particular search degree of freedom (DOF) is being accessed. Only one such attribute may be accessed at a time.
Public enumerationCogOCVMaxDOFConstants
Constants used to specify search degree(s) of freedom (DOFs).
Public enumerationCogOCVMaxFontOriginConstants
Constants used to identify the character origins of an imported image font.
Public enumerationCogOCVMaxFontTypeConstants
Constants used to identify the type of an imported font.
Public enumerationCogOCVMaxLastRunRecordConstants
Enumeration of Non-Diagnostic data that can be included in the tool's LastRunRecord.
Public enumerationCogOCVMaxLastRunRecordDiagConstants
Enumeration of Diagnostic data that can be included in the tool's LastRunRecord.
Public enumerationCogOCVMaxParagraphResultGraphicConstants
Constants used to specify desired result graphics for CogOCVMaxParagraphResult::CreateResultGraphics().
Public enumerationCogOCVMaxPolarityConstants
Constants for specifying the brightness or darkness of the characters to be inspected relative to their background.
Public enumerationCogOCVMaxRefinementConstants
Constants used to specify the amount of refinement done on the transform that represents the deformation for a particular character.
Public enumerationCogOCVMaxScoreModeConstants
Constants used to specify how we compute the score for each character. Note: ScoreUsingClutter is usually preferable to allow confusion to be computed more reliably, whereas ScoreWithoutClutter may be necessary in noisy images.
Public enumerationCogOCVMaxTuneConstants
Constants used to specify which pattern properties to tune.
Public enumerationCogOCVMaxVerificationTypeConstants
Constants used to select the type of verification performed on each character.