CogOCRMaxFielding PropertiesCognex VisionPro 9.7

The CogOCRMaxFielding type exposes the following members.

Properties

  NameDescription
Public propertyAcceptedMetric
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.
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 propertyConfusionMetric
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.
Public propertyEscapeCharacter
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.
Public propertyEscapeCharacterEnabled
Get or set whether the EscapeCharacter should be considered when evaluating the FieldString.
Public propertyFieldCount
Get the number of fielding positions currently defined by the FieldString. Note that the returned value honors the EscapeCharacterEnabled and EscapeCharacter properties.
Public propertyFieldingDefinitions
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.
Public propertyFieldString
Get or set the string that specifies what characters are expected. This string may optionally contain characters that correspond to fielding definition aliases.
Public propertyFirstIndexMax
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.
Public propertyHasChanged (Inherited from CogSerializableChangedEventBase.)
Public propertyIgnoreFailingPrefixSuffix
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.
Public propertyIgnoreUnfieldedSpaces
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.
Public propertyLastIndexMin
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.
Public propertyLengthMax
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.
Public propertyLengthMin
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.
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 propertyVariableLength
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
See Also