OCROperator ClassCognex VisionPro 9.23

This class provides functionality for OCR training and execution.

Inheritance Hierarchy

System Object
  Cognex.Vision ShareableBase
    Cognex.Vision ChangedEventShareableBase
      Cognex.Vision.ViDiEL OCROperator

Namespace: Cognex.Vision.ViDiEL
Assembly: Cognex.Vision.ViDiELOCR.Net (in Cognex.Vision.ViDiELOCR.Net.dll) Version: 9.24.0.0
Syntax

public sealed class OCROperator : ChangedEventShareableBase, 
	IObject

The OCROperator type exposes the following members.

Constructors

  NameDescription
Public methodOCROperator

Constructs a new instance of this class.

Top
Methods

  NameDescription
Public methodClearCache

Clears the training cache, this should be used only when the TrainingDatabase entirely changes.

Public methodEquals
Compares the equality of this object with another.
(Overrides ChangedEventShareableBase Equals(Object).)
Public methodExecute(IImage)

Executes the OCR process with the trained model.

Public methodExecute(IImage, IRegion)

Executes the OCR process with the trained model.

Public methodExecutePretrained

Executes the OCR process with a pre-trained model.

Public methodGetHashCode
Returns the hash code of this object.
(Overrides ChangedEventShareableBase GetHashCode .)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Overrides ShareableBase GetTypeMeta .)
Public methodResumeAndRaiseChangedEvent

Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent.

(Overrides ChangedEventShareableBase ResumeAndRaiseChangedEvent .)
Public methodSortCharacters

Sorts the character positions into lines.

Public methodSuspendChangedEvent

Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.

(Overrides ChangedEventShareableBase SuspendChangedEvent .)
Public methodToString

Returns a human readable string that represents the object.

(Overrides Object ToString .)
Public methodTrain

Trains the OCR operator using the TrainingDatabase.

Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two OCROperator objects.
Public operatorStatic memberInequality
Compares the inequality of two OCROperator objects.
Top
Fields

  NameDescription
Public fieldStatic memberSfAdvancedFielding
Public fieldStatic memberSfBasicFielding
Public fieldStatic memberSfCharacterHeight
Public fieldStatic memberSfCharacterWidth
Public fieldStatic memberSfFieldingMode
Public fieldStatic memberSfModelHealth
Public fieldStatic memberSfRegion
Public fieldStatic memberSfRegionMode
Public fieldStatic memberSfTrained
Public fieldStatic memberSfTrainingResults
Top
Properties

  NameDescription
Public propertyAdvancedFielding
Get

Gets the Advanced Fielding.

Public propertyBasicFielding
Get

Gets the Basic Fielding.

Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Overrides ChangedEventShareableBase ChangedEventSuspended.)
Public propertyCharacterHeight
Get

Gets the Height for the characters to search for Default Value: 0.

Public propertyCharacterWidth
Get

Gets the width of the characters to search for Default Value: 0.

Public propertyFieldingMode
Get

Gets the fielding mode.

Public propertyHandle (Overrides ChangedEventShareableBase Handle.)
Public propertyModelHealth

Gets the health of the underlying model.

Public propertyRegion
Get

Gets the inspection region of the input image.

Public propertyRegionMode
Get

Gets the technique used to apply the region to the inspection image. Default Value: AffineTransform.

Public propertyTrained

Get if the model is trained or not.

Public propertyTrainingDatabase

Gets the database which contains the training data.

Public propertyTrainingResults

The results of the last training.

Top
Events

  NameDescription
Public eventChanged

The actual event.

(Overrides ChangedEventShareableBase Changed.)
Top
See Also