Operator Reference

get_text_model_paramT_get_text_model_paramGetTextModelParamGetTextModelParamget_text_model_param (Operator)

get_text_model_paramT_get_text_model_paramGetTextModelParamGetTextModelParamget_text_model_param — Query parameters of a text model.

Signature

get_text_model_param( : : TextModel, GenParamName : GenParamValue)

Herror T_get_text_model_param(const Htuple TextModel, const Htuple GenParamName, Htuple* GenParamValue)

void GetTextModelParam(const HTuple& TextModel, const HTuple& GenParamName, HTuple* GenParamValue)

HTuple HTextModel::GetTextModelParam(const HString& GenParamName) const

HTuple HTextModel::GetTextModelParam(const char* GenParamName) const

HTuple HTextModel::GetTextModelParam(const wchar_t* GenParamName) const   ( Windows only)

static void HOperatorSet.GetTextModelParam(HTuple textModel, HTuple genParamName, out HTuple genParamValue)

HTuple HTextModel.GetTextModelParam(string genParamName)

def get_text_model_param(text_model: HHandle, gen_param_name: str) -> Sequence[Union[int, float, str]]

def get_text_model_param_s(text_model: HHandle, gen_param_name: str) -> Union[int, float, str]

Description

get_text_model_paramget_text_model_paramGetTextModelParamGetTextModelParamget_text_model_param queries the parameters of TextModelTextModelTextModeltextModeltext_model. With the exception of 'ocr_classifier'"ocr_classifier""ocr_classifier""ocr_classifier""ocr_classifier", all valid parameters can be queried. See set_text_model_paramset_text_model_paramSetTextModelParamSetTextModelParamset_text_model_param for a detailed description of the possible values for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name and GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value.

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

TextModelTextModelTextModeltextModeltext_model (input_control)  text_model HTextModel, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Text model.

GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control)  string HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Parameters to be queried.

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

Suggested values: 'add_fragments'"add_fragments""add_fragments""add_fragments""add_fragments", 'dot_print'"dot_print""dot_print""dot_print""dot_print", 'dot_print_max_dot_gap'"dot_print_max_dot_gap""dot_print_max_dot_gap""dot_print_max_dot_gap""dot_print_max_dot_gap", 'dot_print_min_char_gap'"dot_print_min_char_gap""dot_print_min_char_gap""dot_print_min_char_gap""dot_print_min_char_gap", 'dot_print_tight_char_spacing'"dot_print_tight_char_spacing""dot_print_tight_char_spacing""dot_print_tight_char_spacing""dot_print_tight_char_spacing", 'eliminate_border_blobs'"eliminate_border_blobs""eliminate_border_blobs""eliminate_border_blobs""eliminate_border_blobs", 'max_char_height'"max_char_height""max_char_height""max_char_height""max_char_height", 'max_char_width'"max_char_width""max_char_width""max_char_width""max_char_width", 'max_stroke_width'"max_stroke_width""max_stroke_width""max_stroke_width""max_stroke_width", 'min_char_height'"min_char_height""min_char_height""min_char_height""min_char_height", 'min_char_width'"min_char_width""min_char_width""min_char_width""min_char_width", 'min_contrast'"min_contrast""min_contrast""min_contrast""min_contrast", 'min_stroke_width'"min_stroke_width""min_stroke_width""min_stroke_width""min_stroke_width", 'num_classes'"num_classes""num_classes""num_classes""num_classes", 'polarity'"polarity""polarity""polarity""polarity", 'return_punctuation'"return_punctuation""return_punctuation""return_punctuation""return_punctuation", 'return_separators'"return_separators""return_separators""return_separators""return_separators", 'return_whole_line'"return_whole_line""return_whole_line""return_whole_line""return_whole_line", 'separate_touching_chars'"separate_touching_chars""separate_touching_chars""separate_touching_chars""separate_touching_chars", 'text_line_separators'"text_line_separators""text_line_separators""text_line_separators""text_line_separators", 'text_line_structure'"text_line_structure""text_line_structure""text_line_structure""text_line_structure", 'text_line_structure_0'"text_line_structure_0""text_line_structure_0""text_line_structure_0""text_line_structure_0", 'text_line_structure_1'"text_line_structure_1""text_line_structure_1""text_line_structure_1""text_line_structure_1", 'text_line_structure_2'"text_line_structure_2""text_line_structure_2""text_line_structure_2""text_line_structure_2", 'manual_add_fragments'"manual_add_fragments""manual_add_fragments""manual_add_fragments""manual_add_fragments", 'manual_base_line_tolerance'"manual_base_line_tolerance""manual_base_line_tolerance""manual_base_line_tolerance""manual_base_line_tolerance", 'manual_char_height'"manual_char_height""manual_char_height""manual_char_height""manual_char_height", 'manual_char_width'"manual_char_width""manual_char_width""manual_char_width""manual_char_width", 'manual_eliminate_border_blobs'"manual_eliminate_border_blobs""manual_eliminate_border_blobs""manual_eliminate_border_blobs""manual_eliminate_border_blobs", 'manual_eliminate_horizontal_lines'"manual_eliminate_horizontal_lines""manual_eliminate_horizontal_lines""manual_eliminate_horizontal_lines""manual_eliminate_horizontal_lines", 'manual_fragment_size_min'"manual_fragment_size_min""manual_fragment_size_min""manual_fragment_size_min""manual_fragment_size_min", 'manual_is_dotprint'"manual_is_dotprint""manual_is_dotprint""manual_is_dotprint""manual_is_dotprint", 'manual_is_imprinted'"manual_is_imprinted""manual_is_imprinted""manual_is_imprinted""manual_is_imprinted", 'manual_max_line_num'"manual_max_line_num""manual_max_line_num""manual_max_line_num""manual_max_line_num", 'manual_persistence'"manual_persistence""manual_persistence""manual_persistence""manual_persistence", 'manual_polarity'"manual_polarity""manual_polarity""manual_polarity""manual_polarity", 'manual_return_punctuation'"manual_return_punctuation""manual_return_punctuation""manual_return_punctuation""manual_return_punctuation", 'manual_return_separators'"manual_return_separators""manual_return_separators""manual_return_separators""manual_return_separators", 'manual_stroke_width'"manual_stroke_width""manual_stroke_width""manual_stroke_width""manual_stroke_width", 'manual_text_line_structure'"manual_text_line_structure""manual_text_line_structure""manual_text_line_structure""manual_text_line_structure", 'manual_text_line_structure_0'"manual_text_line_structure_0""manual_text_line_structure_0""manual_text_line_structure_0""manual_text_line_structure_0", 'manual_text_line_structure_1'"manual_text_line_structure_1""manual_text_line_structure_1""manual_text_line_structure_1""manual_text_line_structure_1", 'manual_text_line_structure_2'"manual_text_line_structure_2""manual_text_line_structure_2""manual_text_line_structure_2""manual_text_line_structure_2", 'manual_uppercase_only'"manual_uppercase_only""manual_uppercase_only""manual_uppercase_only""manual_uppercase_only"

GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control)  string(-array) HTupleSequence[Union[int, float, str]]HTupleHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*)

Values of Parameters.

Result

If the input parameters are set correctly, the operator get_text_model_paramget_text_model_paramGetTextModelParamGetTextModelParamget_text_model_param returns the value 2 ( H_MSG_TRUE) . Otherwise, an exception will be raised.

See also

set_text_model_paramset_text_model_paramSetTextModelParamSetTextModelParamset_text_model_param

Module

OCR/OCV