protect_ocr_trainfprotect_ocr_trainfProtectOcrTrainfProtectOcrTrainf (Operator)

Name

protect_ocr_trainfprotect_ocr_trainfProtectOcrTrainfProtectOcrTrainf — Protection of training data.

Signature

protect_ocr_trainf( : : TrainingFile, Password, TrainingFileProtected : )

Description

Obtaining training data for an OCR classifier can be a complicated and time consuming activity. Thus, training data is valuable and there might be the necessity to protect its usage. The general idea is to prevent protected OCR training data from being reviewed or modified in any way and to ensure that its usage, e.g., training an OCR classifier, is restricted by a user password.

The approach in HALCON is to obtain OCR training data in the usual way, then write it to an unprotected OCR training file using, e.g., write_ocr_trainfwrite_ocr_trainfWriteOcrTrainfWriteOcrTrainfWriteOcrTrainf, and afterwards create a new file containing the OCR training data protected with a user password. Protected training files can be used with a set of special operators that also require the correct password in order to be able to process the data, e.g., for training an OCR classifier.

It is important to keep in mind that data in a protected OCR training file cannot be reviewed or modified in any way, thus it is important to keep the original, unprotected, training data files.

Protected OCR training data can be used for training of multilayer perceptron (MLP) classifiers and support vector machine (SVM) classifiers.

protect_ocr_trainfprotect_ocr_trainfProtectOcrTrainfProtectOcrTrainfProtectOcrTrainf protects the OCR training data contained in the file TrainingFileTrainingFileTrainingFileTrainingFiletrainingFile and writes it to the protected training data file TrainingFileProtectedTrainingFileProtectedTrainingFileProtectedTrainingFileProtectedtrainingFileProtected. The protection is done with the user password PasswordPasswordPasswordPasswordpassword. The same password has to be used afterwards in order to use the protected OCR training data, e.g., by the operators trainf_ocr_class_mlp_protectedtrainf_ocr_class_mlp_protectedTrainfOcrClassMlpProtectedTrainfOcrClassMlpProtectedTrainfOcrClassMlpProtected or read_ocr_trainf_names_protectedread_ocr_trainf_names_protectedReadOcrTrainfNamesProtectedReadOcrTrainfNamesProtectedReadOcrTrainfNamesProtected. Empty passwords (or passwords containing the empty string) are not allowed. If the number of passwords PasswordPasswordPasswordPasswordpassword equals 1, then every output file TrainingFileProtectedTrainingFileProtectedTrainingFileProtectedTrainingFileProtectedtrainingFileProtected is protected with that password, otherwise the number of passwords has to be equal to the number of input and output files and the output file at position n is protected with the password at position n.

Execution Information

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

Parameters

TrainingFileTrainingFileTrainingFileTrainingFiletrainingFile (input_control) filename.read → (string)

Names of the training files.

Default value: '' "" "" "" ""

File extension: .trf, .otr

PasswordPasswordPasswordPasswordpassword (input_control) string(-array) → (string)

Passwords for protecting the training files.

TrainingFileProtectedTrainingFileProtectedTrainingFileProtectedTrainingFileProtectedtrainingFileProtected (input_control) filename.write → (string)

Names of the protected training files.

File extension: .trf

Result

If the parameters are correct, the operator protect_ocr_trainfprotect_ocr_trainfProtectOcrTrainfProtectOcrTrainfProtectOcrTrainf returns the value 2 (H_MSG_TRUE). Otherwise an exception will be raised.