CogOCRMaxTuneData ClassCognex VisionPro 9.5
CogOCRMaxTuneData contains a set of CogOCRMaxTuneRecords for use with training the CogOCRMaxTool.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.OCRMax CogOCRMaxTuneData

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

[SerializableAttribute]
public class CogOCRMaxTuneData : CogSerializableChangedEventBase, 
	IDisposable

The CogOCRMaxTuneData type exposes the following members.

Constructors

  NameDescription
Public methodCogOCRMaxTuneData 
Public methodCogOCRMaxTuneData(CogOCRMaxTuneData)
Copy Constructor
Public methodCogOCRMaxTuneData(SerializationInfo, StreamingContext)
Top
Methods

  NameDescription
Public methodAddTuneRecord
Adds an additional tune record to the tune data.

The input record should be verified to be correct by the user.

The input record should be a representative example of the image you wish the tuned tool to read.

After calling this function the TuneData will be in the "untuned" state.

In order to re-enter the tuned state the user should call the Tune() function.

Public methodAutoCorrect

AutoCorrect makes educated guesses at a "correct" tune record by searching for an OCRMax result that matches the character codes contained in the partially correct input record.

The primary input to AutoCorrect() is a tune record which contains an image, a region, and the correct string of character codes. It is important for the inputRecords to already contain the character codes that the user expects the OCRMaxTool to eventually read in order for the AutoCorrect function to work properly.

The output of AutoCorrect() is a set of tune records which now includes the corrected mark and cell rects location of each character.

Public methodAutoTune
Adds the additional tune record to the tune data and performs an incremental auto tune.

The input record should be verified to be a correct record by the user.

The input record should be a representative example of the image you wish the tuned tool to read.

After calling this function the TuneData will be in the "tuned" state.

When in the tuned state the user can call GetTunedSegmenter(), and GetTunedFont() to extract tuned OCRMax operators.

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 methodDispose 
Protected methodDispose(Boolean)
Public methodDoesRecordMatchToolResult
Returns true if the record and the result of running OCRMax on this record are considered a match.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize (Overrides Object Finalize .)
Protected methodGetAttributes
Implements the corresponding member of the ICustomTypeDescriptor interface. May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.)
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.)
Public methodGetObjectData (Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).)
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 methodGetTunedFont(CogOCRMaxTuneParams)
Returns the tuned OCRMax Font.
Public methodGetTunedFont(CogOCRMaxFont, CogOCRMaxTuneParams)
Returns the tuned OCRMax Font. The tuned font is merged with the existing font.
Public methodGetTunedSegmenter
Returns the tuned OCRMax Segmenter operator.
Public methodGetTuneRecord
Returns a copy of the Tune Record at the specified index.
Public methodGetTuneRecords
Returns a collection of the CogOCRMaxTuneRecords held by this object.
Public methodGetTuneRecordsCount
Returns the number of Tune Records in the Tune Data.
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.)
Protected methodOnChanged(Int64)
This method should be called internally whenever the object's state may have changed.
(Inherited from CogSerializableChangedEventBase.)
Protected methodOnChanged(CogChangedEventArgs)
This method may be called internally whenever a derived object's state may have changed and the derived object expresses this change via a derived CogChangedEventArgs class.
(Inherited from CogSerializableChangedEventBase.)
Public methodRemoveAllTuneRecords
Removes all tune records from the tune data.

After calling this function the TuneData will be in the "untuned" state.

Public methodRemoveTuneRecord
Removes a record from the tune data.

After calling this function the TuneData will be in the "untuned" state.

In order to re-enter the tuned state the user shold call the Tune() function.

Public methodResumeAndRaiseChangedEvent
Re-enables raising of the Changed event after SuspendChangedEvent has been called, and raises the Changed event 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.
(Inherited from CogSerializableChangedEventBase.)
Public methodSuspendChangedEvent
Temporarily suspends the raising of the Changed event. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent.
(Inherited from CogSerializableChangedEventBase.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodTune

Performs a full Tune of the CogOCRMaxTuneRecords contained in this object.

After calling this function the TuneData will be in the "tuned" state.

When in the tuned state the user can call GetTunedSegmenter(), and GetTunedFont() to extract the tuned OCRMax operators.

Note that performing a full Tune may produce different results than calling the incremental AutoTune() on the same set of CogOCRMaxTuneRecords data.

Public methodUntune
Causes the TuneData to become "untuned"
Top
Fields

  NameDescription
Public fieldStatic memberSfGetTuneRecords
Set in the EventArgs of the Changed event every time the value returned by GetTuneRecords() may have changed.
Public fieldStatic memberSfGetTuneRecordsCount
Set in the EventArgs of the Changed event every time the value returned by GetTuneRecords() may have changed.
Protected fieldStatic memberSfNextSf
Public fieldStatic memberSfTuned
Set in the EventArgs of the Changed event every time the value returned by Tuned may have changed.
Top
Properties

  NameDescription
Public propertyChangedEventSuspended
If nonzero, indicates that the raising of the Changed event has been suspended. This value is incremented when SuspendChangedEvent is called and decremented when ResumeAndRaiseChangedEvent is called.
(Inherited from CogSerializableChangedEventBase.)
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Public propertyStateFlags
Returns the complete set of state flags supported on this object. The flags may be indexed by name as shown in the following C# code snippet: if (changedObject.StateFlags["Color"] & eventArgs.StateFlags) { ... }
(Inherited from CogSerializableChangedEventBase.)
Public propertyTuned
Top
Events

  NameDescription
Public eventChanged
This event is raised when one or more parts of the object's state may have changed.
(Inherited from CogSerializableChangedEventBase.)
Top
See Also