An internal, more direct wrap of the CVL OCRMax Classifier.
Inheritance Hierarchy
System MarshalByRefObject
Cognex.VisionPro.Implementation CogObjectBase
Cognex.VisionPro.Implementation CogSerializableObjectBase
Cognex.VisionPro.Implementation CogSerializableChangedEventBase
Cognex.VisionPro.OCRMax.Implementation.Internal CogOCRMaxClassifierImpl
Namespace: Cognex.VisionPro.OCRMax.Implementation.Internal
Assembly: Cognex.VisionPro.OCRMax (in Cognex.VisionPro.OCRMax.dll) Version: 75.1.0.0
Syntax
The CogOCRMaxClassifierImpl type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | CogOCRMaxClassifierImpl |
Construct a default CogOCRMaxClassifierImpl object.
|
| CogOCRMaxClassifierImpl(CogOCRMaxClassifierImpl) |
Constructs a deep copy of the supplied CogOCRMaxClassifierImpl object.
|
 | CogOCRMaxClassifierImpl(SerializationInfo, StreamingContext) |
Serialization constructor for CogOCRMaxClassifierImpl.
|
Methods
| Name | Description | |
|---|---|---|
| Clone |
Returns a deep copy of this class instance.
|
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.) |
| Dispose | |
| Dispose(Boolean) | |
| Equals | (Inherited from Object.) |
| Finalize | (Overrides Object Finalize .) |
| GetAttributes |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetClassName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetComponentName |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetConverter |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultEvent |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetDefaultProperty |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEditor |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetEvents( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| GetObjectData | (Overrides CogSerializableObjectBase GetObjectData(SerializationInfo, StreamingContext).) |
| GetProperties |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetProperties( Attribute ) |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetPropertyOwner |
Implements the corresponding member of the ICustomTypeDescriptor interface.
May be overridden in derived classes to provide custom type information.
(Inherited from CogObjectBase.) |
| GetTrainCharacterIndices |
Returns the indices of all training instances in TrainCharacterKeys()
that match the specified character key.
|
| GetTrainCharacterKeys |
Returns a copy of the keys of all training characters.
|
| GetTrainCharacters |
Returns a copy of the training characters.
|
| GetTrainCharactersProcessed |
Returns a copy of the training characters after processing (re-sampling
and image pre-processing).
|
| GetTrainParams |
Returns a copy of the training params specified when calling
StartTrain(), Train(), or Retrain().
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.) |
| IsStartTrained |
Whether training has started, regardless of if the classifier has
received any training instances.
|
| IsTrained |
Whether this classifier has been trained with at least one training
instance.
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.) |
| OnChanged(Int64) |
This method should be called internally whenever the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
| OnChanged(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.) |
| ResumeAndRaiseChangedEvent |
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.) |
| Retrain |
Re-train the classifier with the specified parameters and the training
instances saved in the tool. It is okay to call Retrain() repeatedly.
Effects of earlier calls will be cleared by the last call. After the
call, both IsStartTrained() and IsTrained() remain true.
|
| Run(CogOCRMaxChar, CogOCRMaxSwapCharSet, CogOCRMaxClassifierRunParams) |
Run the classifier on the input character(s).
|
| Run( CogOCRMaxChar , CogOCRMaxSwapCharSet, CogOCRMaxClassifierRunParams) |
Run the classifier on the input character(s).
|
| Run(CogOCRMaxChar, Boolean, Double, CogOCRMaxSwapCharSet, CogOCRMaxClassifierRunParams) |
Run the classifier on the input character(s).
|
| Run( CogOCRMaxChar , Boolean , Double , CogOCRMaxSwapCharSet, CogOCRMaxClassifierRunParams) |
Run the classifier on the input character(s).
|
| StartTrain |
Start the training process with the specified parameters. This calls
Untrain() as the first step. It is legal to call startTrain()
repeatedly. Effects of earlier calls will be cleared by the last call.
|
| SuspendChangedEvent |
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.) |
| ToString | (Inherited from Object.) |
| Train |
Convenience functions to call StartTrain() followed by
TrainIncremental(). After the call, IsStartTrained() and IsTrained()
become/remain true. It is okay to call Train() repeatedly. Effects of
earlier calls will be cleared by the last call.
|
| TrainIncremental(CogOCRMaxChar) |
Add one training instance to this classifier. Requires IsStartTrained()
be true. After the call, IsTrained() becomes/remains true.
|
| TrainIncremental(CogSerializableCollectionBase CogOCRMaxChar ) |
Add one training instance to this classifier. Requires IsStartTrained()
be true. After the call, IsTrained() becomes/remains true.
|
| Untrain |
Untrain the classifier. Discard information of all training parameters
and training instances.
|
Fields
| Name | Description | |
|---|---|---|
  | SfGetTrainCharacterKeys | |
| SfGetTrainCharacters | |
| SfGetTrainCharactersProcessed | |
| SfGetTrainParams | |
| SfIsStartTrained | |
| SfIsTrained | |
 | SfNextSf | |
| SfSaveTrainCharacters |
Properties
| Name | Description | |
|---|---|---|
 | ChangedEventSuspended |
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.) |
| HasChanged | (Inherited from CogSerializableChangedEventBase.) |
| SaveTrainCharacters |
Whether to save all training characters.
|
| StateFlags |
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.) |
Events
| Name | Description | |
|---|---|---|
 | Changed |
This event is raised when one or more parts of the object's state may
have changed.
(Inherited from CogSerializableChangedEventBase.) |
See Also