trainf_ocr_class_knnT_trainf_ocr_class_knnTrainfOcrClassKnnTrainfOcrClassKnn (Operator)

Name

trainf_ocr_class_knnT_trainf_ocr_class_knnTrainfOcrClassKnnTrainfOcrClassKnn — Trains an k-NN classifier for an OCR task.

Signature

trainf_ocr_class_knn( : : OCRHandle, TrainingFile, GenParamName, GenParamValue : )

Description

trainf_ocr_class_knntrainf_ocr_class_knnTrainfOcrClassKnnTrainfOcrClassKnnTrainfOcrClassKnn trains the k-NN classifier OCRHandleOCRHandleOCRHandleOCRHandleOCRHandle with the training characters stored in the OCR training files given by TrainingFileTrainingFileTrainingFileTrainingFiletrainingFile. The training files must have been created, e.g., using write_ocr_trainfwrite_ocr_trainfWriteOcrTrainfWriteOcrTrainfWriteOcrTrainf, before calling trainf_ocr_class_knntrainf_ocr_class_knnTrainfOcrClassKnnTrainfOcrClassKnnTrainfOcrClassKnn. Please, note that training characters that have no corresponding class in the classifier OCRHandleOCRHandleOCRHandleOCRHandleOCRHandle are discarded.

It is possible to set the number of trees via the parameters GenParamNameGenParamNameGenParamNameGenParamNamegenParamName and GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue by 'num_trees'"num_trees""num_trees""num_trees""num_trees". The default value for the number of search trees is 4. A higher number of trees improves the accuracy of the search, but also increases the runtime. Normalization can be activated by setting 'normalization'"normalization""normalization""normalization""normalization" in GenParamNameGenParamNameGenParamNameGenParamNamegenParamName and and 'true'"true""true""true""true" in GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue. This will change the stored training data permanently. Therefore, adding data after the training is not possible.

Execution Information

Multithreading type: reentrant (runs in parallel with non-exclusive operators).
Multithreading scope: global (may be called from any thread).
Processed without parallelization.

This operator modifies the state of the following input parameter:

OCRHandleOCRHandleOCRHandleOCRHandleOCRHandle

The value of this parameter may not be shared across multiple threads without external synchronization.

Parameters

OCRHandleOCRHandleOCRHandleOCRHandleOCRHandle (input_control, state is modified) ocr_knn → (handle)

Handle of the k-NN classifier.

TrainingFileTrainingFileTrainingFileTrainingFiletrainingFile (input_control) filename.read(-array) → (string)

Names of the training files.

Default value: 'ocr.trf' "ocr.trf" "ocr.trf" "ocr.trf" "ocr.trf"

File extension: .trf, .otr

GenParamNameGenParamNameGenParamNameGenParamNamegenParamName (input_control) string-array → (string)

Names of the generic parameters that can be adjusted for the k-NN classifier creation.

Default value: []

List of values: 'normalization'"normalization""normalization""normalization""normalization", 'num_trees'"num_trees""num_trees""num_trees""num_trees"

GenParamValueGenParamValueGenParamValueGenParamValuegenParamValue (input_control) number-array → (integer / string / real)

Values of the generic parameters that can be adjusted for the k-NN classifier creation.

Default value: []

Suggested values: 4, 5, 'false'"false""false""false""false", 'true'"true""true""true""true"

Example (HDevelop)

* Train an OCR classifier
read_ocr_trainf_names ('ocr.trf', CharacterNames, CharacterCount)
create_ocr_class_knn (8, 10, 'constant', 'default', CharacterNames, [],\
                      [], OCRHandle)
trainf_ocr_class_knn (OCRHandle, 'ocr.trf', [], [])
write_ocr_class_knn (OCRHandle, 'ocr.omc')

Result

If the parameters are valid, the operator trainf_ocr_class_knntrainf_ocr_class_knnTrainfOcrClassKnnTrainfOcrClassKnnTrainfOcrClassKnn returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.