CogOCRMaxTuneParams ClassCognex VisionPro 9.7
Tune parameters for the CogOCRMaxTool.
Inheritance Hierarchy

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

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

[SerializableAttribute]
public class CogOCRMaxTuneParams : CogSerializableChangedEventBase

The CogOCRMaxTuneParams type exposes the following members.

Constructors

  NameDescription
Public methodCogOCRMaxTuneParams 
Construct a default CogOCRMaxTuneParams object.
Public methodCogOCRMaxTuneParams(CogOCRMaxTuneParams)
Constructs a deep copy of the supplied CogOCRMaxTuneParams object.
Protected methodCogOCRMaxTuneParams(SerializationInfo, StreamingContext)
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 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 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 memberSfMaxCandidateCount
Set in the EventArgs of the Changed event every time the value returned by MaxCandidateCount may have changed.
Public fieldStatic memberSfMaxNumCharInstancesInFont
Set in the EventArgs of the Changed event every time the value returned by MaxNumCharInstancesInFont may have changed.
Protected fieldStatic memberSfNextSf
Public fieldStatic memberSfNumSteps
Set in the EventArgs of the Changed event every time the value returned by NumSteps may have changed.
Public fieldStatic memberSfPaddingFactor
Set in the EventArgs of the Changed event every time the value returned by PaddingFactor may have changed.
Public fieldStatic memberSfRegenerateFont
Set in the EventArgs of the Changed event every time the value returned by RegenerateFont may have changed.
Public fieldStatic memberSfRegionMatchOverlapFrac
Set in the EventArgs of the Changed event every time the value returned by RegionMatchOverlapFrac may have changed.
Public fieldStatic memberSfTunablePropertiesEnable
Set in the EventArgs of the Changed event every time the value returned by TunablePropertiesEnable 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 propertyMaxCandidateCount
Controls "how hard" OCRMax tuning will try to find valid parameters by setting the maximum number of internal candidates the tune mechanism will evaluate.
Public propertyMaxNumCharInstancesInFont
Set the maximum number of instances per character that the OCRMax tuning mechanism will include in the tuned font.
Public propertyNumSteps
Controls how many steps the OCRMax tuning mechanism will try when modifying a parameter.
Public propertyPaddingFactor
Controls how "loosely" the OCRMax tuning mechanism will set the segmentation params.
Public propertyRegenerateFont
Controls whether the OCRMax tuning mechanism will regenerate the characters in the pre-existing font.
Public propertyRegionMatchOverlapFrac
Controls how much two character regions must overlap to be considered the same by OCRMax tuning.
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 propertyTunablePropertiesEnable
Enables or disables which parameters of CogOCRMaxTool will be tuned.
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 tune params control how the CogOCRMaxTool's Tune() and AutoTune() features function.
See Also