CogOCRMaxTuneRecord ClassCognex VisionPro
Contains data about a line of text in an image that can be used to tune the CogOCRMaxTool.
Inheritance Hierarchy

System Object
  System MarshalByRefObject
    Cognex.VisionPro.Implementation CogObjectBase
      Cognex.VisionPro.Implementation CogSerializableObjectBase
        Cognex.VisionPro.Implementation CogSerializableChangedEventBase
          Cognex.VisionPro.OCRMax.Implementation.Internal CogOCRMaxTuneRecordImpl
            Cognex.VisionPro.OCRMax CogOCRMaxTuneRecord

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

[SerializableAttribute]
public class CogOCRMaxTuneRecord : CogOCRMaxTuneRecordImpl

The CogOCRMaxTuneRecord type exposes the following members.

Constructors

  NameDescription
Public methodCogOCRMaxTuneRecord 
Default Constructor
Public methodCogOCRMaxTuneRecord(CogOCRMaxTuneRecord)
Copy Constructor
Protected methodCogOCRMaxTuneRecord(SerializationInfo, StreamingContext)
Public methodCogOCRMaxTuneRecord(ICogImage, CogRectangleAffine, CogRectangleAffineCollection, CogRectangleAffineCollection, CogOCRMaxCharKeyCollection, Boolean, Boolean, Boolean, Boolean, CogOCRMaxTuneRecordOrigin)
Cognex Internal Use Only
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 methodCreateTuneRecordGraphics
Creates a CogGraphicCollection which represents the current state of the tune record.

Note that changes to returned graphics collection are not reflected in the original tune record and vice versa.

(Inherited from CogOCRMaxTuneRecordImpl.)
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.)
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 methodGetImage
Gets the image contained within this record. If this is an 8 bit record the Image property is returned. If this is an 16 bit record the Image16 property is returned.
(Inherited from CogOCRMaxTuneRecordImpl.)
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 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 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.)
Top
Fields

  NameDescription
Public fieldStatic memberSfClassifierCorrected
Set in the EventArgs of the Changed event every time the value returned by ClassifierCorrected may have changed.
Protected fieldStatic memberSfNextSf
Public fieldStatic memberSfOrigin
Set in the EventArgs of the Changed event every time the value returned by Origin may have changed.
Public fieldStatic memberSfSegmenterCorrected
Set in the EventArgs of the Changed event every time the value returned by SegmenterCorrected may have changed.
Top
Properties

  NameDescription
Public propertyCellRects
An ordered collection of rectangles that define the cell rectangles for each character in the image.
(Inherited from CogOCRMaxTuneRecordImpl.)
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 propertyCharacterCodes
An ordered collection of UTF-32 encoded characters which identify the correct character at each position in the string.
(Inherited from CogOCRMaxTuneRecordImpl.)
Public propertyClassifierCorrected
Indicates that the character codes have been modified since the record was first created.
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Public propertyHasImage16
Indicates that this record contains 16 bit image data.
(Inherited from CogOCRMaxTuneRecordImpl.)
Public propertyImage
An image which contains text to be read.
(Inherited from CogOCRMaxTuneRecordImpl.)
Public propertyImage16
An image which contains text to be read.
(Inherited from CogOCRMaxTuneRecordImpl.)
Public propertyMarkRects
An ordered collection of rectangles that tightly enclose each of the characters in the image.
(Inherited from CogOCRMaxTuneRecordImpl.)
Public propertyOrigin
Identifies how the tune record was created.
Public propertyRegion
The region of the image which contains the text to be read.
(Inherited from CogOCRMaxTuneRecordImpl.)
Public propertySegmenterCorrected
Indicates that the cell or mark rectangles have been modified since the record was first created.
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.)
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
Remarks

The OCRMaxTool tuning process involves the following steps.

Tune records are constructed from a CogOCRMaxLineResult.

Any incorrect OCRMaxTool results are converted into a tune record.

Once converted the record is corrected. The correction is done by manually editing the record or by using the CogOCRTool's AutoCorrect() function.

Once a tune record is correct, it can then be used to tune the CogOCRMaxTool. The OCRMaxTool is tuned by passing the corrected tune record to the AutoTune() function.

Tuning helps the OCRMaxTool find parameters that will correctly read the tune record.

See Also