trainf_ocr_class_svm_protectedTrainfOcrClassSvmProtectedTrainfOcrClassSvmProtectedtrainf_ocr_class_svm_protectedT_trainf_ocr_class_svm_protected

HALCON ScriptCpp++.NETPythonC

Short description

trainf_ocr_class_svm_protectedTrainfOcrClassSvmProtectedTrainfOcrClassSvmProtectedtrainf_ocr_class_svm_protectedT_trainf_ocr_class_svm_protected — Train an OCR classifier with data from a (protected) training file.

Signature

trainf_ocr_class_svm_protected( ocr_svm OCRHandle, filename.read TrainingFile, string Password, real Epsilon, number TrainMode )void TrainfOcrClassSvmProtected( const HTuple& OCRHandle, const HTuple& TrainingFile, const HTuple& Password, const HTuple& Epsilon, const HTuple& TrainMode )static void HOperatorSet.TrainfOcrClassSvmProtected( HTuple OCRHandle, HTuple trainingFile, HTuple password, HTuple epsilon, HTuple trainMode )def trainf_ocr_class_svm_protected( ocrhandle: HHandle, training_file: MaybeSequence[str], password: MaybeSequence[str], epsilon: float, train_mode: Union[str, int] ) -> None

Herror T_trainf_ocr_class_svm_protected( const Htuple OCRHandle, const Htuple TrainingFile, const Htuple Password, const Htuple Epsilon, const Htuple TrainMode )

void HOCRSvm::TrainfOcrClassSvmProtected( const HTuple& TrainingFile, const HTuple& Password, double Epsilon, const HTuple& TrainMode ) const

void HOCRSvm::TrainfOcrClassSvmProtected( const HString& TrainingFile, const HString& Password, double Epsilon, const HString& TrainMode ) const

void HOCRSvm::TrainfOcrClassSvmProtected( const char* TrainingFile, const char* Password, double Epsilon, const char* TrainMode ) const

void HOCRSvm::TrainfOcrClassSvmProtected( const wchar_t* TrainingFile, const wchar_t* Password, double Epsilon, const wchar_t* TrainMode ) const (Windows only)

void HOCRSvm.TrainfOcrClassSvmProtected( HTuple trainingFile, HTuple password, double epsilon, HTuple trainMode )

void HOCRSvm.TrainfOcrClassSvmProtected( string trainingFile, string password, double epsilon, string trainMode )

Description

trainf_ocr_class_svm_protectedTrainfOcrClassSvmProtected trains the OCR classifier OCRHandleOCRHandleocrhandle with the training data stored in the OCR training files given by TrainingFiletrainingFiletraining_file. Its functionality corresponds to the functionality of trainf_ocr_class_svmTrainfOcrClassSvm, with the addition that trainf_ocr_class_svm_protectedTrainfOcrClassSvmProtected can process unprotected and protected training files. Protected training files can be used only with the correct user password Passwordpasswordpassword. If the number of passwords Passwordpasswordpassword equals 1, then every input file TrainingFiletrainingFiletraining_file is checked with that password, otherwise the number of passwords has to be equal to the number of input files and the input file at position n is checked with the password at position n. For unprotected training files the passwords are ignored.

For a more detailed description of the operator’s functionality see trainf_ocr_class_svmTrainfOcrClassSvm. The concept of protecting OCR training data in HALCON is described in protect_ocr_trainfProtectOcrTrainf.

Execution information

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:

• OCRHandleOCRHandleocrhandle

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

OCRHandleOCRHandleocrhandle (input_control, state is modified) ocr_svm → (handle)HTuple (HHandle)HOCRSvm, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the OCR classifier.

TrainingFiletrainingFiletraining_file (input_control) filename.read(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Names of the training files.

Default: 'ocr.trf'"ocr.trf"
File extension: .trf, .otr

Passwordpasswordpassword (input_control) string(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Passwords for protected training files.

Epsilonepsilonepsilon (input_control) real → (real)HTuple (double)HTuple (double)floatHtuple (double)

Stop parameter for training.

Default: 0.0010.001
Suggested values: 0.00001, 0.0001, 0.001, 0.01, 0.10.00001, 0.0001, 0.001, 0.01, 0.1

TrainModetrainModetrain_mode (input_control) number → (string / integer)HTuple (HString / Hlong)HTuple (string / int / long)Union[str, int]Htuple (char* / Hlong)

Mode of training.

Default: 'default'"default"
List of values: 'add_sv_to_train_set', 'default'"add_sv_to_train_set", "default"

Result

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

trainf_ocr_class_svm_protectedTrainfOcrClassSvmProtected may return the error 9211 (Matrix is not positive definite) if Preprocessingpreprocessingpreprocessing \(=\) 'canonical_variates'"canonical_variates" is used. This typically indicates that not enough training samples have been stored for each class. In this case we recommend to change Preprocessingpreprocessingpreprocessing to 'normalization'"normalization". Another solution can be to add more training samples.

Combinations with other operators

Combinations

Possible predecessors

create_ocr_class_svmCreateOcrClassSvm, write_ocr_trainfWriteOcrTrainf, append_ocr_trainfAppendOcrTrainf, write_ocr_trainf_imageWriteOcrTrainfImage, protect_ocr_trainfProtectOcrTrainf

Possible successors

do_ocr_single_class_svmDoOcrSingleClassSvm, do_ocr_multi_class_svmDoOcrMultiClassSvm, write_ocr_class_svmWriteOcrClassSvm

Alternatives

read_ocr_class_svmReadOcrClassSvm

See also

trainf_ocr_class_svmTrainfOcrClassSvm, train_class_svmTrainClassSvm

Module

OCR/OCV