CogOCRMaxClassifier.Execute Method (IEnumerable(CogOCRMaxChar), CogOCRMaxClassifierRunParams, CogOCRMaxSwapCharSet)

CogOCRMaxClassifier Execute Method (IEnumerable CogOCRMaxChar , CogOCRMaxClassifierRunParams, CogOCRMaxSwapCharSet)

Cognex VisionPro

Classify a collection of characters.

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

Syntax

C++

Copy to Clipboard Print

public CogOCRMaxClassifierLineResult Execute(
	IEnumerable<CogOCRMaxChar> characters,
	CogOCRMaxClassifierRunParams runParams,
	CogOCRMaxSwapCharSet swapCharSet
)

public CogOCRMaxClassifierLineResult Execute(
	IEnumerable<CogOCRMaxChar> characters,
	CogOCRMaxClassifierRunParams runParams,
	CogOCRMaxSwapCharSet swapCharSet
)

Public Function Execute ( 
	characters As IEnumerable(Of CogOCRMaxChar),
	runParams As CogOCRMaxClassifierRunParams,
	swapCharSet As CogOCRMaxSwapCharSet
) As CogOCRMaxClassifierLineResult

Public Function Execute ( 
	characters As IEnumerable(Of CogOCRMaxChar),
	runParams As CogOCRMaxClassifierRunParams,
	swapCharSet As CogOCRMaxSwapCharSet
) As CogOCRMaxClassifierLineResult

public:
CogOCRMaxClassifierLineResult^ Execute(
	IEnumerable<CogOCRMaxChar^>^ characters, 
	CogOCRMaxClassifierRunParams^ runParams, 
	CogOCRMaxSwapCharSet^ swapCharSet
)

public:
CogOCRMaxClassifierLineResult^ Execute(
	IEnumerable<CogOCRMaxChar^>^ characters, 
	CogOCRMaxClassifierRunParams^ runParams, 
	CogOCRMaxSwapCharSet^ swapCharSet
)

Parameters

characters: Type: System.Collections.Generic IEnumerable CogOCRMaxChar
The characters to be classified.

runParams: Type: Cognex.VisionPro.OCRMax CogOCRMaxClassifierRunParams
The run params that specify how to perform classification.

swapCharSet: Type: Cognex.VisionPro.OCRMax CogOCRMaxSwapCharSet
The set of chracters which have been predetermined to be "swappable" (They appear similar and are hard to distinguish, e.g. '0' and 'O').

Return Value

Type: CogOCRMaxClassifierLineResult

Exceptions

Exception	Condition
CogSecurityViolationException
CogOCRMaxClassifierParamsException	Thrown if: any character's image is not allocated any character's cell rect is not specified
CogTimeoutExpiredException	Thrown if the Timeout expired.
ArgumentNullException	Thrown if characters is null. Thrown if runParams is null. Thrown if swapCharSet is null.

Remarks

Note that space characters are a special case. The OCRMax Classifier does not classify space characters. Instead the classifier input (cf. the segmenter output) is responsible for deciding if a particular character is a space. The classifier simply "passes through" space characters and their associated scores. Space characters are not assigned alternative characters, and the confidence score is set to be equal to the regular score in the classifier output.

If the input's CogOCRMaxChar.CharacterCode == 20 (space) the classifier will automatically classify the character as a space. The space character's score and confidence score will be set to the 1 in the classifier output.