Operator Reference

HALCON Operator Reference / OCR / Training Files
ClassesClasses | | Operators

protect_ocr_trainfprotect_ocr_trainfProtectOcrTrainfProtectOcrTrainfprotect_ocr_trainf (Operator)

protect_ocr_trainfprotect_ocr_trainfProtectOcrTrainfProtectOcrTrainfprotect_ocr_trainf — Protection of training data.

Signature

protect_ocr_trainf( : : TrainingFile, Password, TrainingFileProtected : )

Herror protect_ocr_trainf(const char* TrainingFile, const char* Password, const char* TrainingFileProtected)

Herror T_protect_ocr_trainf(const Htuple TrainingFile, const Htuple Password, const Htuple TrainingFileProtected)

void ProtectOcrTrainf(const HTuple& TrainingFile, const HTuple& Password, const HTuple& TrainingFileProtected)

static void HRegion::ProtectOcrTrainf(const HString& TrainingFile, const HTuple& Password, const HString& TrainingFileProtected)

static void HRegion::ProtectOcrTrainf(const HString& TrainingFile, const HString& Password, const HString& TrainingFileProtected)

static void HRegion::ProtectOcrTrainf(const char* TrainingFile, const char* Password, const char* TrainingFileProtected)

static void HRegion::ProtectOcrTrainf(const wchar_t* TrainingFile, const wchar_t* Password, const wchar_t* TrainingFileProtected)   ( Windows only)

static void HOperatorSet.ProtectOcrTrainf(HTuple trainingFile, HTuple password, HTuple trainingFileProtected)

static void HRegion.ProtectOcrTrainf(string trainingFile, HTuple password, string trainingFileProtected)

static void HRegion.ProtectOcrTrainf(string trainingFile, string password, string trainingFileProtected)

def protect_ocr_trainf(training_file: str, password: MaybeSequence[str], training_file_protected: str) -> None

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_trainfWriteOcrTrainfWriteOcrTrainfwrite_ocr_trainf, 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_trainfProtectOcrTrainfProtectOcrTrainfprotect_ocr_trainf protects the OCR training data contained in the file TrainingFileTrainingFileTrainingFiletrainingFiletraining_file and writes it to the protected training data file TrainingFileProtectedTrainingFileProtectedTrainingFileProtectedtrainingFileProtectedtraining_file_protected. 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_protectedTrainfOcrClassMlpProtectedTrainfOcrClassMlpProtectedtrainf_ocr_class_mlp_protected or read_ocr_trainf_names_protectedread_ocr_trainf_names_protectedReadOcrTrainfNamesProtectedReadOcrTrainfNamesProtectedread_ocr_trainf_names_protected. Empty passwords (or passwords containing the empty string) are not allowed. If the number of passwords PasswordPasswordPasswordpasswordpassword equals 1, then every output file TrainingFileProtectedTrainingFileProtectedTrainingFileProtectedtrainingFileProtectedtraining_file_protected 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

TrainingFileTrainingFileTrainingFiletrainingFiletraining_file (input_control)  filename.read → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Names of the training files.

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

File extension: .trf, .otr

PasswordPasswordPasswordpasswordpassword (input_control)  string(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)

Passwords for protecting the training files.

TrainingFileProtectedTrainingFileProtectedTrainingFileProtectedtrainingFileProtectedtraining_file_protected (input_control)  filename.write → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Names of the protected training files.

File extension: .trf

Result

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

Possible Predecessors

write_ocr_trainfwrite_ocr_trainfWriteOcrTrainfWriteOcrTrainfwrite_ocr_trainf, append_ocr_trainfappend_ocr_trainfAppendOcrTrainfAppendOcrTrainfappend_ocr_trainf, concat_ocr_trainfconcat_ocr_trainfConcatOcrTrainfConcatOcrTrainfconcat_ocr_trainf

Possible Successors

read_ocr_trainf_names_protectedread_ocr_trainf_names_protectedReadOcrTrainfNamesProtectedReadOcrTrainfNamesProtectedread_ocr_trainf_names_protected, trainf_ocr_class_mlp_protectedtrainf_ocr_class_mlp_protectedTrainfOcrClassMlpProtectedTrainfOcrClassMlpProtectedtrainf_ocr_class_mlp_protected, trainf_ocr_class_svm_protectedtrainf_ocr_class_svm_protectedTrainfOcrClassSvmProtectedTrainfOcrClassSvmProtectedtrainf_ocr_class_svm_protected, select_feature_set_trainf_mlp_protectedselect_feature_set_trainf_mlp_protectedSelectFeatureSetTrainfMlpProtectedSelectFeatureSetTrainfMlpProtectedselect_feature_set_trainf_mlp_protected, select_feature_set_trainf_svm_protectedselect_feature_set_trainf_svm_protectedSelectFeatureSetTrainfSvmProtectedSelectFeatureSetTrainfSvmProtectedselect_feature_set_trainf_svm_protected

See also

select_feature_set_trainf_mlpselect_feature_set_trainf_mlpSelectFeatureSetTrainfMlpSelectFeatureSetTrainfMlpselect_feature_set_trainf_mlp

Module

OCR/OCV

ClassesClasses | | Operators