HALCON Website / HALCON Operator Reference / OCR / Segmentation
ClassesClassesClassesClasses | | | | Operators

create_text_model_readercreate_text_model_readerCreateTextModelReadercreate_text_model_readerCreateTextModelReaderCreateTextModelReader (Operator)

Name

create_text_model_readercreate_text_model_readerCreateTextModelReadercreate_text_model_readerCreateTextModelReaderCreateTextModelReader — Create a text model.

Signature

create_text_model_reader( : : Mode, OCRClassifierMLP : TextModel)

Herror create_text_model_reader(const char* Mode, const char* OCRClassifierMLP, Hlong* TextModel)

Herror T_create_text_model_reader(const Htuple Mode, const Htuple OCRClassifierMLP, Htuple* TextModel)

Herror create_text_model_reader(const HTuple& Mode, const HTuple& OCRClassifierMLP, Hlong* TextModel)

void HTextModel::CreateTextModelReader(const HTuple& Mode, const HTuple& OCRClassifierMLP)

void CreateTextModelReader(const HTuple& Mode, const HTuple& OCRClassifierMLP, HTuple* TextModel)

void HTextModel::HTextModel(const HString& Mode, const HTuple& OCRClassifierMLP)

void HTextModel::HTextModel(const HString& Mode, const HString& OCRClassifierMLP)

void HTextModel::HTextModel(const char* Mode, const char* OCRClassifierMLP)

void HTextModel::CreateTextModelReader(const HString& Mode, const HTuple& OCRClassifierMLP)

void HTextModel::CreateTextModelReader(const HString& Mode, const HString& OCRClassifierMLP)

void HTextModel::CreateTextModelReader(const char* Mode, const char* OCRClassifierMLP)

void HOperatorSetX.CreateTextModelReader(
[in] VARIANT Mode, [in] VARIANT OCRClassifierMLP, [out] VARIANT* TextModel)

void HTextModelX.CreateTextModelReader(
[in] BSTR Mode, [in] VARIANT OCRClassifierMLP)

static void HOperatorSet.CreateTextModelReader(HTuple mode, HTuple OCRClassifierMLP, out HTuple textModel)

public HTextModel(string mode, HTuple OCRClassifierMLP)

public HTextModel(string mode, string OCRClassifierMLP)

void HTextModel.CreateTextModelReader(string mode, HTuple OCRClassifierMLP)

void HTextModel.CreateTextModelReader(string mode, string OCRClassifierMLP)

Description

create_text_model_readercreate_text_model_readerCreateTextModelReadercreate_text_model_readerCreateTextModelReaderCreateTextModelReader creates a TextModelTextModelTextModelTextModelTextModeltextModel, which describes the text to be segmented with find_textfind_textFindTextfind_textFindTextFindText.

The parameter value of ModeModeModeModeModemode determines which text segmentation approach is used. Possible values are 'auto'"auto""auto""auto""auto""auto" and 'manual'"manual""manual""manual""manual""manual".

Typically, the parameter ModeModeModeModeModemode should be set to 'auto'"auto""auto""auto""auto""auto" because this mode is more stable and requires less configuration effort. Note that in this case, also an OCR classifier must be passed in OCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLP. Only if one of the following restrictions apply, ModeModeModeModeModemode must be set to 'manual'"manual""manual""manual""manual""manual":

If ModeModeModeModeModemode = 'auto'"auto""auto""auto""auto""auto", find_textfind_textFindTextfind_textFindTextFindText is able to extract text of arbitrary size. It is possible to restrict the search to characters with specific attributes, see set_text_model_paramset_text_model_paramSetTextModelParamset_text_model_paramSetTextModelParamSetTextModelParam for details. Furthermore, an OCR classifier must be passed in OCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLP. This OCR classifier must be based on a multilayer perceptron (MLP). Moreover, it is strongly recommended to use an OCR classifier that provides a rejection class (see set_rejection_params_ocr_class_mlpset_rejection_params_ocr_class_mlpSetRejectionParamsOcrClassMlpset_rejection_params_ocr_class_mlpSetRejectionParamsOcrClassMlpSetRejectionParamsOcrClassMlp) and has been trained with regularization parameters (see set_regularization_params_ocr_class_mlpset_regularization_params_ocr_class_mlpSetRegularizationParamsOcrClassMlpset_regularization_params_ocr_class_mlpSetRegularizationParamsOcrClassMlpSetRegularizationParamsOcrClassMlp). A suitable OCR classifier can either be created with create_ocr_class_mlpcreate_ocr_class_mlpCreateOcrClassMlpcreate_ocr_class_mlpCreateOcrClassMlpCreateOcrClassMlp or read with read_ocr_class_mlpread_ocr_class_mlpReadOcrClassMlpread_ocr_class_mlpReadOcrClassMlpReadOcrClassMlp. It is also possible to pass a string containing the path to an OCR classifier that has been stored with write_ocr_class_mlpwrite_ocr_class_mlpWriteOcrClassMlpwrite_ocr_class_mlpWriteOcrClassMlpWriteOcrClassMlp.

To enable text segmentation when ModeModeModeModeModemode = 'manual'"manual""manual""manual""manual""manual", reasonable parameters for the text model, including the expected character height and width, must be set using set_text_model_paramset_text_model_paramSetTextModelParamset_text_model_paramSetTextModelParamSetTextModelParam. In this case, the value of OCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLP is ignored.

The parameters of the TextModelTextModelTextModelTextModelTextModeltextModel can be set and queried with set_text_model_paramset_text_model_paramSetTextModelParamset_text_model_paramSetTextModelParamSetTextModelParam and get_text_model_paramget_text_model_paramGetTextModelParamget_text_model_paramGetTextModelParamGetTextModelParam.

Since memory is allocated for the text model during the call of create_text_model_readercreate_text_model_readerCreateTextModelReadercreate_text_model_readerCreateTextModelReaderCreateTextModelReader and during the following operations, the model should be freed explicitly by the operator clear_text_modelclear_text_modelClearTextModelclear_text_modelClearTextModelClearTextModel as soon as it is no longer used.

Parallelization

This operator returns a handle. Note that the state of an instance of this handle type may be changed by specific operators even though the handle is used as an input parameter by those operators.

Parameters

ModeModeModeModeModemode (input_control)  string → HTupleHTupleHTupleVARIANTHtuple (string) (string) (HString) (char*) (BSTR) (char*)

The Mode of the text model.

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

List of values: 'auto'"auto""auto""auto""auto""auto", 'manual'"manual""manual""manual""manual""manual"

OCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLPOCRClassifierMLP (input_control)  string → HTupleHTupleHTupleVARIANTHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong) (BSTR / Hlong) (char* / Hlong)

OCR Classifier.

Default value: 'Industrial_Rej.omc' "Industrial_Rej.omc" "Industrial_Rej.omc" "Industrial_Rej.omc" "Industrial_Rej.omc" "Industrial_Rej.omc"

Suggested values: 'Document_A-Z+_NoRej.omc'"Document_A-Z+_NoRej.omc""Document_A-Z+_NoRej.omc""Document_A-Z+_NoRej.omc""Document_A-Z+_NoRej.omc""Document_A-Z+_NoRej.omc", 'Document_A-Z+_Rej.omc'"Document_A-Z+_Rej.omc""Document_A-Z+_Rej.omc""Document_A-Z+_Rej.omc""Document_A-Z+_Rej.omc""Document_A-Z+_Rej.omc", 'Document_0-9A-Z_NoRej.omc'"Document_0-9A-Z_NoRej.omc""Document_0-9A-Z_NoRej.omc""Document_0-9A-Z_NoRej.omc""Document_0-9A-Z_NoRej.omc""Document_0-9A-Z_NoRej.omc", 'Document_0-9A-Z_Rej.omc'"Document_0-9A-Z_Rej.omc""Document_0-9A-Z_Rej.omc""Document_0-9A-Z_Rej.omc""Document_0-9A-Z_Rej.omc""Document_0-9A-Z_Rej.omc", 'Document_0-9_NoRej.omc'"Document_0-9_NoRej.omc""Document_0-9_NoRej.omc""Document_0-9_NoRej.omc""Document_0-9_NoRej.omc""Document_0-9_NoRej.omc", 'Document_0-9_Rej.omc'"Document_0-9_Rej.omc""Document_0-9_Rej.omc""Document_0-9_Rej.omc""Document_0-9_Rej.omc""Document_0-9_Rej.omc", 'Document_NoRej.omc'"Document_NoRej.omc""Document_NoRej.omc""Document_NoRej.omc""Document_NoRej.omc""Document_NoRej.omc", 'Document_Rej.omc'"Document_Rej.omc""Document_Rej.omc""Document_Rej.omc""Document_Rej.omc""Document_Rej.omc", 'DotPrint_A-Z+_NoRej.omc'"DotPrint_A-Z+_NoRej.omc""DotPrint_A-Z+_NoRej.omc""DotPrint_A-Z+_NoRej.omc""DotPrint_A-Z+_NoRej.omc""DotPrint_A-Z+_NoRej.omc", 'DotPrint_A-Z+_Rej.omc'"DotPrint_A-Z+_Rej.omc""DotPrint_A-Z+_Rej.omc""DotPrint_A-Z+_Rej.omc""DotPrint_A-Z+_Rej.omc""DotPrint_A-Z+_Rej.omc", 'DotPrint_0-9A-Z_NoRej.omc'"DotPrint_0-9A-Z_NoRej.omc""DotPrint_0-9A-Z_NoRej.omc""DotPrint_0-9A-Z_NoRej.omc""DotPrint_0-9A-Z_NoRej.omc""DotPrint_0-9A-Z_NoRej.omc", 'DotPrint_0-9A-Z_Rej.omc'"DotPrint_0-9A-Z_Rej.omc""DotPrint_0-9A-Z_Rej.omc""DotPrint_0-9A-Z_Rej.omc""DotPrint_0-9A-Z_Rej.omc""DotPrint_0-9A-Z_Rej.omc", 'DotPrint_0-9_NoRej.omc'"DotPrint_0-9_NoRej.omc""DotPrint_0-9_NoRej.omc""DotPrint_0-9_NoRej.omc""DotPrint_0-9_NoRej.omc""DotPrint_0-9_NoRej.omc", 'DotPrint_0-9_Rej.omc'"DotPrint_0-9_Rej.omc""DotPrint_0-9_Rej.omc""DotPrint_0-9_Rej.omc""DotPrint_0-9_Rej.omc""DotPrint_0-9_Rej.omc", 'DotPrint_0-9+_NoRej.omc'"DotPrint_0-9+_NoRej.omc""DotPrint_0-9+_NoRej.omc""DotPrint_0-9+_NoRej.omc""DotPrint_0-9+_NoRej.omc""DotPrint_0-9+_NoRej.omc", 'DotPrint_0-9+_Rej.omc'"DotPrint_0-9+_Rej.omc""DotPrint_0-9+_Rej.omc""DotPrint_0-9+_Rej.omc""DotPrint_0-9+_Rej.omc""DotPrint_0-9+_Rej.omc", 'DotPrint_NoRej.omc'"DotPrint_NoRej.omc""DotPrint_NoRej.omc""DotPrint_NoRej.omc""DotPrint_NoRej.omc""DotPrint_NoRej.omc", 'DotPrint_Rej.omc'"DotPrint_Rej.omc""DotPrint_Rej.omc""DotPrint_Rej.omc""DotPrint_Rej.omc""DotPrint_Rej.omc", 'HandWritten_0-9_NoRej.omc'"HandWritten_0-9_NoRej.omc""HandWritten_0-9_NoRej.omc""HandWritten_0-9_NoRej.omc""HandWritten_0-9_NoRej.omc""HandWritten_0-9_NoRej.omc", 'HandWritten_0-9_Rej.omc'"HandWritten_0-9_Rej.omc""HandWritten_0-9_Rej.omc""HandWritten_0-9_Rej.omc""HandWritten_0-9_Rej.omc""HandWritten_0-9_Rej.omc", 'Industrial_A-Z+_NoRej.omc'"Industrial_A-Z+_NoRej.omc""Industrial_A-Z+_NoRej.omc""Industrial_A-Z+_NoRej.omc""Industrial_A-Z+_NoRej.omc""Industrial_A-Z+_NoRej.omc", 'Industrial_A-Z+_Rej.omc'"Industrial_A-Z+_Rej.omc""Industrial_A-Z+_Rej.omc""Industrial_A-Z+_Rej.omc""Industrial_A-Z+_Rej.omc""Industrial_A-Z+_Rej.omc", 'Industrial_0-9A-Z_NoRej.omc'"Industrial_0-9A-Z_NoRej.omc""Industrial_0-9A-Z_NoRej.omc""Industrial_0-9A-Z_NoRej.omc""Industrial_0-9A-Z_NoRej.omc""Industrial_0-9A-Z_NoRej.omc", 'Industrial_0-9A-Z_Rej.omc'"Industrial_0-9A-Z_Rej.omc""Industrial_0-9A-Z_Rej.omc""Industrial_0-9A-Z_Rej.omc""Industrial_0-9A-Z_Rej.omc""Industrial_0-9A-Z_Rej.omc", 'Industrial_0-9_NoRej.omc'"Industrial_0-9_NoRej.omc""Industrial_0-9_NoRej.omc""Industrial_0-9_NoRej.omc""Industrial_0-9_NoRej.omc""Industrial_0-9_NoRej.omc", 'Industrial_0-9_Rej.omc'"Industrial_0-9_Rej.omc""Industrial_0-9_Rej.omc""Industrial_0-9_Rej.omc""Industrial_0-9_Rej.omc""Industrial_0-9_Rej.omc", 'Industrial_0-9+_NoRej.omc'"Industrial_0-9+_NoRej.omc""Industrial_0-9+_NoRej.omc""Industrial_0-9+_NoRej.omc""Industrial_0-9+_NoRej.omc""Industrial_0-9+_NoRej.omc", 'Industrial_0-9+_Rej.omc'"Industrial_0-9+_Rej.omc""Industrial_0-9+_Rej.omc""Industrial_0-9+_Rej.omc""Industrial_0-9+_Rej.omc""Industrial_0-9+_Rej.omc", 'Industrial_NoRej.omc'"Industrial_NoRej.omc""Industrial_NoRej.omc""Industrial_NoRej.omc""Industrial_NoRej.omc""Industrial_NoRej.omc", 'Industrial_Rej.omc'"Industrial_Rej.omc""Industrial_Rej.omc""Industrial_Rej.omc""Industrial_Rej.omc""Industrial_Rej.omc", 'OCRA_A-Z+_NoRej.omc'"OCRA_A-Z+_NoRej.omc""OCRA_A-Z+_NoRej.omc""OCRA_A-Z+_NoRej.omc""OCRA_A-Z+_NoRej.omc""OCRA_A-Z+_NoRej.omc", 'OCRA_A-Z+_Rej.omc'"OCRA_A-Z+_Rej.omc""OCRA_A-Z+_Rej.omc""OCRA_A-Z+_Rej.omc""OCRA_A-Z+_Rej.omc""OCRA_A-Z+_Rej.omc", 'OCRA_0-9A-Z_NoRej.omc'"OCRA_0-9A-Z_NoRej.omc""OCRA_0-9A-Z_NoRej.omc""OCRA_0-9A-Z_NoRej.omc""OCRA_0-9A-Z_NoRej.omc""OCRA_0-9A-Z_NoRej.omc", 'OCRA_0-9A-Z_Rej.omc'"OCRA_0-9A-Z_Rej.omc""OCRA_0-9A-Z_Rej.omc""OCRA_0-9A-Z_Rej.omc""OCRA_0-9A-Z_Rej.omc""OCRA_0-9A-Z_Rej.omc", 'OCRA_0-9_NoRej.omc'"OCRA_0-9_NoRej.omc""OCRA_0-9_NoRej.omc""OCRA_0-9_NoRej.omc""OCRA_0-9_NoRej.omc""OCRA_0-9_NoRej.omc", 'OCRA_0-9_Rej.omc'"OCRA_0-9_Rej.omc""OCRA_0-9_Rej.omc""OCRA_0-9_Rej.omc""OCRA_0-9_Rej.omc""OCRA_0-9_Rej.omc", 'OCRA_NoRej.omc'"OCRA_NoRej.omc""OCRA_NoRej.omc""OCRA_NoRej.omc""OCRA_NoRej.omc""OCRA_NoRej.omc", 'OCRA_Rej.omc'"OCRA_Rej.omc""OCRA_Rej.omc""OCRA_Rej.omc""OCRA_Rej.omc""OCRA_Rej.omc", 'OCRB_A-Z+_NoRej.omc'"OCRB_A-Z+_NoRej.omc""OCRB_A-Z+_NoRej.omc""OCRB_A-Z+_NoRej.omc""OCRB_A-Z+_NoRej.omc""OCRB_A-Z+_NoRej.omc", 'OCRB_A-Z+_Rej.omc'"OCRB_A-Z+_Rej.omc""OCRB_A-Z+_Rej.omc""OCRB_A-Z+_Rej.omc""OCRB_A-Z+_Rej.omc""OCRB_A-Z+_Rej.omc", 'OCRB_0-9A-Z_NoRej.omc'"OCRB_0-9A-Z_NoRej.omc""OCRB_0-9A-Z_NoRej.omc""OCRB_0-9A-Z_NoRej.omc""OCRB_0-9A-Z_NoRej.omc""OCRB_0-9A-Z_NoRej.omc", 'OCRB_0-9A-Z_Rej.omc'"OCRB_0-9A-Z_Rej.omc""OCRB_0-9A-Z_Rej.omc""OCRB_0-9A-Z_Rej.omc""OCRB_0-9A-Z_Rej.omc""OCRB_0-9A-Z_Rej.omc", 'OCRB_0-9_NoRej.omc'"OCRB_0-9_NoRej.omc""OCRB_0-9_NoRej.omc""OCRB_0-9_NoRej.omc""OCRB_0-9_NoRej.omc""OCRB_0-9_NoRej.omc", 'OCRB_0-9_Rej.omc'"OCRB_0-9_Rej.omc""OCRB_0-9_Rej.omc""OCRB_0-9_Rej.omc""OCRB_0-9_Rej.omc""OCRB_0-9_Rej.omc", 'OCRB_NoRej.omc'"OCRB_NoRej.omc""OCRB_NoRej.omc""OCRB_NoRej.omc""OCRB_NoRej.omc""OCRB_NoRej.omc", 'OCRB_Rej.omc'"OCRB_Rej.omc""OCRB_Rej.omc""OCRB_Rej.omc""OCRB_Rej.omc""OCRB_Rej.omc", 'OCRB_passport_NoRej.omc'"OCRB_passport_NoRej.omc""OCRB_passport_NoRej.omc""OCRB_passport_NoRej.omc""OCRB_passport_NoRej.omc""OCRB_passport_NoRej.omc", 'OCRB_passport_Rej.omc'"OCRB_passport_Rej.omc""OCRB_passport_Rej.omc""OCRB_passport_Rej.omc""OCRB_passport_Rej.omc""OCRB_passport_Rej.omc", 'Pharma_0-9A-Z_NoRej.omc'"Pharma_0-9A-Z_NoRej.omc""Pharma_0-9A-Z_NoRej.omc""Pharma_0-9A-Z_NoRej.omc""Pharma_0-9A-Z_NoRej.omc""Pharma_0-9A-Z_NoRej.omc", 'Pharma_0-9A-Z_Rej.omc'"Pharma_0-9A-Z_Rej.omc""Pharma_0-9A-Z_Rej.omc""Pharma_0-9A-Z_Rej.omc""Pharma_0-9A-Z_Rej.omc""Pharma_0-9A-Z_Rej.omc", 'Pharma_0-9_NoRej.omc'"Pharma_0-9_NoRej.omc""Pharma_0-9_NoRej.omc""Pharma_0-9_NoRej.omc""Pharma_0-9_NoRej.omc""Pharma_0-9_NoRej.omc", 'Pharma_0-9_Rej.omc'"Pharma_0-9_Rej.omc""Pharma_0-9_Rej.omc""Pharma_0-9_Rej.omc""Pharma_0-9_Rej.omc""Pharma_0-9_Rej.omc", 'Pharma_0-9+_NoRej.omc'"Pharma_0-9+_NoRej.omc""Pharma_0-9+_NoRej.omc""Pharma_0-9+_NoRej.omc""Pharma_0-9+_NoRej.omc""Pharma_0-9+_NoRej.omc", 'Pharma_0-9+_Rej.omc'"Pharma_0-9+_Rej.omc""Pharma_0-9+_Rej.omc""Pharma_0-9+_Rej.omc""Pharma_0-9+_Rej.omc""Pharma_0-9+_Rej.omc", 'Pharma_NoRej.omc'"Pharma_NoRej.omc""Pharma_NoRej.omc""Pharma_NoRej.omc""Pharma_NoRej.omc""Pharma_NoRej.omc", 'Pharma_Rej.omc'"Pharma_Rej.omc""Pharma_Rej.omc""Pharma_Rej.omc""Pharma_Rej.omc""Pharma_Rej.omc", 'SEMI_NoRej.omc'"SEMI_NoRej.omc""SEMI_NoRej.omc""SEMI_NoRej.omc""SEMI_NoRej.omc""SEMI_NoRej.omc", 'SEMI_Rej.omc'"SEMI_Rej.omc""SEMI_Rej.omc""SEMI_Rej.omc""SEMI_Rej.omc""SEMI_Rej.omc"

TextModelTextModelTextModelTextModelTextModeltextModel (output_control)  text_model → HTextModel, HTupleHTupleHTextModel, HTupleHTextModelX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

New text model.

Result

create_text_model_readercreate_text_model_readerCreateTextModelReadercreate_text_model_readerCreateTextModelReaderCreateTextModelReader returns the value 2 (H_MSG_TRUE).

Possible Successors

set_text_model_paramset_text_model_paramSetTextModelParamset_text_model_paramSetTextModelParamSetTextModelParam, get_text_model_paramget_text_model_paramGetTextModelParamget_text_model_paramGetTextModelParamGetTextModelParam, find_textfind_textFindTextfind_textFindTextFindText

See also

clear_text_modelclear_text_modelClearTextModelclear_text_modelClearTextModelClearTextModel

Module

OCR/OCV

ClassesClassesClassesClasses | | | | Operators
HALCON Operator Reference 12.0.2 Copyright © 1996-2016 MVTec Software GmbH