Skip to content

get_prep_info_ocr_class_mlpGetPrepInfoOcrClassMlpGetPrepInfoOcrClassMlpget_prep_info_ocr_class_mlpT_get_prep_info_ocr_class_mlp🔗

Short description🔗

get_prep_info_ocr_class_mlpGetPrepInfoOcrClassMlpGetPrepInfoOcrClassMlpget_prep_info_ocr_class_mlpT_get_prep_info_ocr_class_mlp — Compute the information content of the preprocessed feature vectors of an OCR classifier.

Signature🔗

get_prep_info_ocr_class_mlp( ocr_mlp OCRHandle, filename.read TrainingFile, string Preprocessing, out real InformationCont, out real CumInformationCont )void GetPrepInfoOcrClassMlp( const HTuple& OCRHandle, const HTuple& TrainingFile, const HTuple& Preprocessing, HTuple* InformationCont, HTuple* CumInformationCont )static void HOperatorSet.GetPrepInfoOcrClassMlp( HTuple OCRHandle, HTuple trainingFile, HTuple preprocessing, out HTuple informationCont, out HTuple cumInformationCont )def get_prep_info_ocr_class_mlp( ocrhandle: HHandle, training_file: MaybeSequence[str], preprocessing: str ) -> Tuple[Sequence[float], Sequence[float]]

Herror T_get_prep_info_ocr_class_mlp( const Htuple OCRHandle, const Htuple TrainingFile, const Htuple Preprocessing, Htuple* InformationCont, Htuple* CumInformationCont )

HTuple HOCRMlp::GetPrepInfoOcrClassMlp( const HTuple& TrainingFile, const HString& Preprocessing, HTuple* CumInformationCont ) const

HTuple HOCRMlp::GetPrepInfoOcrClassMlp( const HString& TrainingFile, const HString& Preprocessing, HTuple* CumInformationCont ) const

HTuple HOCRMlp::GetPrepInfoOcrClassMlp( const char* TrainingFile, const char* Preprocessing, HTuple* CumInformationCont ) const

HTuple HOCRMlp::GetPrepInfoOcrClassMlp( const wchar_t* TrainingFile, const wchar_t* Preprocessing, HTuple* CumInformationCont ) const (Windows only)

HTuple HOCRMlp.GetPrepInfoOcrClassMlp( HTuple trainingFile, string preprocessing, out HTuple cumInformationCont )

HTuple HOCRMlp.GetPrepInfoOcrClassMlp( string trainingFile, string preprocessing, out HTuple cumInformationCont )

Description🔗

get_prep_info_ocr_class_mlpGetPrepInfoOcrClassMlp computes the information content of the training vectors that have been transformed with the preprocessing given by Preprocessingpreprocessingpreprocessing. Preprocessingpreprocessingpreprocessing can be set to 'principal_components'"principal_components" or 'canonical_variates'"canonical_variates". The OCR classifier OCRHandleOCRHandleocrhandle must have been created with create_ocr_class_mlpCreateOcrClassMlp. The preprocessing methods are described with create_class_mlpCreateClassMlp. The information content is derived from the variations of the transformed components of the feature vector, i.e., it is computed solely based on the training data, independent of any error rate on the training data. The information content is computed for all relevant components of the transformed feature vectors (NumInputnumInputnum_input for 'principal_components'"principal_components" and min(NumOutput - 1, NumInput) for 'canonical_variates'"canonical_variates", see create_class_mlpCreateClassMlp), and is returned in InformationContinformationContinformation_cont as a number between 0 and 1. To convert the information content into a percentage, it simply needs to be multiplied by 100. The cumulative information content of the first \(n\) components is returned in the \(n\)-th component of CumInformationContcumInformationContcum_information_cont, i.e., CumInformationContcumInformationContcum_information_cont contains the sums of the first \(n\) elements of InformationContinformationContinformation_cont. To use get_prep_info_ocr_class_mlpGetPrepInfoOcrClassMlp, a sufficient number of samples must be stored in the training files given by TrainingFiletrainingFiletraining_file (see write_ocr_trainfWriteOcrTrainf).

InformationContinformationContinformation_cont and CumInformationContcumInformationContcum_information_cont can be used to decide how many components of the transformed feature vectors contain relevant information. An often used criterion is to require that the transformed data must represent x% (e.g., 90%) of the total data. This can be decided easily from the first value of CumInformationContcumInformationContcum_information_cont that lies above x%. The number thus obtained can be used as the value for NumComponentsnumComponentsnum_components in a new call to create_ocr_class_mlpCreateOcrClassMlp. The call to get_prep_info_ocr_class_mlpGetPrepInfoOcrClassMlp already requires the creation of a classifier, and hence the setting of NumComponentsnumComponentsnum_components in create_ocr_class_mlpCreateOcrClassMlp to an initial value. However, if get_prep_info_ocr_class_mlpGetPrepInfoOcrClassMlp is called it is typically not known how many components are relevant, and hence how to set NumComponentsnumComponentsnum_components in this call. Therefore, the following two-step approach should typically be used to select NumComponentsnumComponentsnum_components: In a first step, a classifier with the maximum number for NumComponentsnumComponentsnum_components is created (NumInputnumInputnum_input for 'principal_components'"principal_components" and min(NumOutput - 1, NumInput) for 'canonical_variates'"canonical_variates"). Then, the training samples are saved in a training file using write_ocr_trainfWriteOcrTrainf. Subsequently, get_prep_info_ocr_class_mlpGetPrepInfoOcrClassMlp is used to determine the information content of the components, and with this NumComponentsnumComponentsnum_components. After this, a new classifier with the desired number of components is created, and the classifier is trained with trainf_ocr_class_mlpTrainfOcrClassMlp.

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.

Parameters🔗

OCRHandleOCRHandleocrhandle (input_control) ocr_mlp → (handle)HTuple (HHandle)HOCRMlp, 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

Preprocessingpreprocessingpreprocessing (input_control) string → (string)HTuple (HString)HTuple (string)strHtuple (char*)

Type of preprocessing used to transform the feature vectors.

Default: 'principal_components'"principal_components"
List of values: 'canonical_variates', 'principal_components'"canonical_variates", "principal_components"

InformationContinformationContinformation_cont (output_control) real-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Relative information content of the transformed feature vectors.

CumInformationContcumInformationContcum_information_cont (output_control) real-array → (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Cumulative information content of the transformed feature vectors.

Example🔗

(HDevelop)


* Create the initial OCR classifier.
read_ocr_trainf_names ('ocr.trf', CharacterNames, CharacterCount)
create_ocr_class_mlp (8, 10, 'constant', 'default', CharacterNames, 80, \
                      'canonical_variates', |CharacterNames|, 42, OCRHandle)
* Get the information content of the transformed feature vectors.
get_prep_info_ocr_class_mlp (OCRHandle, 'ocr.trf', 'canonical_variates', \
                             InformationCont, CumInformationCont)
* Determine the number of transformed components.
* NumComp = [...]
* Create the final OCR classifier.
create_ocr_class_mlp (8, 10, 'constant', 'default', CharacterNames, 80, \
                      'canonical_variates', NumComp, 42, OCRHandle)
* Train the final classifier.
trainf_ocr_class_mlp (OCRHandle, 'ocr.trf', 100, 1, 0.01, Error, ErrorLog)
write_ocr_class_mlp (OCRHandle, 'ocr.omc')

Result🔗

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

get_prep_info_ocr_class_mlpGetPrepInfoOcrClassMlp 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.

Combinations with other operators🔗

Combinations

Possible predecessors

create_ocr_class_mlpCreateOcrClassMlp, write_ocr_trainfWriteOcrTrainf, append_ocr_trainfAppendOcrTrainf, write_ocr_trainf_imageWriteOcrTrainfImage

Possible successors

clear_ocr_class_mlpClearOcrClassMlp, create_ocr_class_mlpCreateOcrClassMlp

Module🔗

OCR/OCV