CogOCRMaxFielding Class

Cognex VisionPro 9.5

Fielding is the third main step in performing OCRMax.

Fielding takes the Classifier results as an input and outputs a refined set of results based on prior information and expectations of the text being read. For instance, if you know the text being read always start with the letter 'C', fielding can use this information to improve the classifier results.

The Classifier results represent a line of character positions and the scores of different characters at each position.

A user configures the Fielding to provides information about what characters are expected at different positions in the string. Fielding uses this information, and the information in the Classifier results, to make small corrections in situations where the Classifier was unable to make a clear determination of what character was printed at a particular position. Fielding may also use the expected string information to invalidate the classifier result at locations where the classifier found something very different than what was expected by the fielding.

Inheritance Hierarchy

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

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

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class CogOCRMaxFielding : CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public class CogOCRMaxFielding : CogSerializableChangedEventBase, 
	IDisposable

<SerializableAttribute>
Public Class CogOCRMaxFielding 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

<SerializableAttribute>
Public Class CogOCRMaxFielding 
	Inherits CogSerializableChangedEventBase 
	Implements IDisposable

[SerializableAttribute]
public ref class CogOCRMaxFielding : public CogSerializableChangedEventBase, 
	IDisposable

[SerializableAttribute]
public ref class CogOCRMaxFielding : public CogSerializableChangedEventBase, 
	IDisposable

The CogOCRMaxFielding type exposes the following members.

Constructors

	Name	Description
	CogOCRMaxFielding	Constructs a new instance of this class.
	CogOCRMaxFielding(String)	Constructs a new instance of this class, and initializes the FieldString property to the supplied value.
	CogOCRMaxFielding(CogOCRMaxFielding)	Constructs a new instance of this class as a deep copy of the given instance.
	CogOCRMaxFielding(SerializationInfo, StreamingContext)	Serialization constructor for CogOCRMaxFielding object.

Top

Methods

	Name	Description
	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	Destruct this CogOCRMaxFielding object.
	Dispose(Boolean)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Execute(CogOCRMaxClassifierLineResult)	Perform OCRMax Fielding on the supplied CogOCRMaxClassifierLineResult.
	Execute(CogOCRMaxClassifierLineResult, CogOCRMaxSwapCharSet)	Perform OCRMax Fielding on the supplied CogOCRMaxClassifierLineResult.
	Finalize	Finalize this CogOCRMaxFielding object. (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	Implements the GetObjectData method of the ISerializable interface. (Inherited from CogSerializableObjectBase.)
	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.)
	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.)
	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.)
	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	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	SfAcceptedMetric	This bit will be set in the EventArgs of a Changed event every time the value returned by AcceptedMetric may have changed.
	SfConfusionMetric	This bit will be set in the EventArgs of a Changed event every time the value returned by ConfusionMetric may have changed.
	SfEscapeCharacter	This bit will be set in the EventArgs of a Changed event every time the value returned by EscapeCharacter may have changed.
	SfEscapeCharacterEnabled	This bit will be set in the EventArgs of a Changed event every time the value returned by EscapeCharacterEnabled may have changed.
	SfFieldCount	This bit will be set in the EventArgs of a Changed event every time the value returned by FieldCount may have changed.
	SfFieldingDefinitions	This bit will be set in the EventArgs of a Changed event every time the value returned by FieldingDefinitions may have changed.
	SfFieldString	This bit will be set in the EventArgs of a Changed event every time the value returned by FieldString may have changed.
	SfFirstIndexMax	This bit will be set in the EventArgs of a Changed event every time the value returned by FirstIndexMax may have changed.
	SfIgnoreFailingPrefixSuffix	This bit will be set in the EventArgs of a Changed event every time the value returned by IgnoreFailingPrefixSuffix may have changed.
	SfIgnoreUnfieldedSpaces	This bit will be set in the EventArgs of a Changed event every time the value returned by IgnoreUnfieldedSpaces may have changed.
	SfLastIndexMin	This bit will be set in the EventArgs of a Changed event every time the value returned by LastIndexMin may have changed.
	SfLengthMax	This bit will be set in the EventArgs of a Changed event every time the value returned by LengthMax may have changed.
	SfLengthMin	This bit will be set in the EventArgs of a Changed event every time the value returned by LengthMin may have changed.
	SfNextSf
	SfVariableLength	This bit will be set in the EventArgs of a Changed event every time the value returned by VariableLength may have changed.

Top

Properties

	Name	Description
	AcceptedMetric	Get or set how the CogOCRMaxFielding will judge Accepted. Valid choices include "PrimaryMatches" (which does not allow a secondary match to be judged Accepted), and "PrimaryAndSecondaryMatches" (which does allow either Primary or Secondary matches to be judged Accepted). Default is PrimaryAndSecondaryMatches.
	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.)
	ConfusionMetric	Get or set how the CogOCRMaxFielding will determine confusion, which will be reflected in each CogOCRMaxFieldingPositionResult.PostFieldingClassifierResult's Status, ConfusionCharacter, ConfusionExplanation, and ConfidenceScore. Default is OnlyFieldedCharacters.
	EscapeCharacter	Get or set the character that may optionally be used to distinguish whether a character in the FieldString should be considered as a possible alias for a fielding definition. If EscapeCharacterEnabled is true and this character is encountered in the FieldString, the next character in the field string will be interpreted literally and will not be evaluated as a possible alias.
	EscapeCharacterEnabled	Get or set whether the EscapeCharacter should be considered when evaluating the FieldString.
	FieldCount	Get the number of fielding positions currently defined by the FieldString. Note that the returned value honors the EscapeCharacterEnabled and EscapeCharacter properties.
	FieldingDefinitions	Get or set the fielding definition collection for this operator. This property may be assigned an empty collection but may not be set to null. Note that a default constructed CogOCRMaxFieldingDefinitionCollection is not empty - it contains a number a predefined aliases.
	FieldString	Get or set the string that specifies what characters are expected. This string may optionally contain characters that correspond to fielding definition aliases.
	FirstIndexMax	The fielding subsequences to be considered must start at a position no greater than this index (in the FieldString). This property is ignored if VariableLength is false. Default is 999.
	HasChanged	(Inherited from CogSerializableChangedEventBase.)
	IgnoreFailingPrefixSuffix	Get or set whether to ignore characters which failed the classification phase (scored below the accept threshold) at the beginning or end of the input string. This can be useful if the input image contains spurious, non-character features at either end of the line of text. Occasionally the segmentation phase will incorrectly identify such spurious features as characters. These spurious characters will fail classification and can be correctly ignored by setting IgnoreFailingPrefixSuffix to true. Default is true.
	IgnoreUnfieldedSpaces	Get or set whether to ignore/skip spaces in the input string where the corresponding fielding settings for those character settings do not allow spaces. Default is true.
	LastIndexMin	The fielding subsequences to be considered must end at a position no smaller than this index (in the FieldString). This property is ignored if VariableLength is false. Default is 0.
	LengthMax	Get or set the maximum acceptable string length, inclusive. This parameter is ignored if VariableLength is false. Note that this setter will enforce LengthMax >= LengthMin by setting LengthMin to equal the new LengthMax if necessary. Default is 999.
	LengthMin	Get or set the minimum acceptable string length, inclusive. This property is ignored if VariableLength is false. Note that this setter will enforce LengthMin less than or equal to LengthMax by setting LengthMax to equal the new LengthMin if necessary. Default is 1.
	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.)
	VariableLength	Get or set whether to run the CogOCRMaxFielding operator in variable-length mode. If false, run in fixed-length mode. Fixed-length mode requires that the classifier result match the field string in its entirety while variable-length allows matching a partial sub-set of the field string. Default is false.

Top

Events

	Name	Description
	Changed	This event is raised when one or more parts of the object's state may have changed. (Inherited from CogSerializableChangedEventBase.)

Top