Operator Reference

HALCON Operator Reference / OCR / Segmentation
ClassesClasses | | Operators

get_text_objectT_get_text_objectGetTextObjectGetTextObjectget_text_object (Operator)

get_text_objectT_get_text_objectGetTextObjectGetTextObjectget_text_object — Query an iconic value of a text segmentation result.

Signature

get_text_object( : Characters : TextResultID, ResultName : )

Herror T_get_text_object(Hobject* Characters, const Htuple TextResultID, const Htuple ResultName)

void GetTextObject(HObject* Characters, const HTuple& TextResultID, const HTuple& ResultName)

HObject HTextResult::GetTextObject(const HTuple& ResultName) const

HObject HTextResult::GetTextObject(const HString& ResultName) const

HObject HTextResult::GetTextObject(const char* ResultName) const

HObject HTextResult::GetTextObject(const wchar_t* ResultName) const   ( Windows only)

static void HOperatorSet.GetTextObject(out HObject characters, HTuple textResultID, HTuple resultName)

HObject HTextResult.GetTextObject(HTuple resultName)

HObject HTextResult.GetTextObject(string resultName)

def get_text_object(text_result_id: HHandle, result_name: MaybeSequence[Union[str, int]]) -> HObject

Description

get_text_objectget_text_objectGetTextObjectGetTextObjectget_text_object queries the iconic result ResultNameResultNameResultNameresultNameresult_name of TextResultIDTextResultIDTextResultIDtextResultIDtext_result_id returned by find_textfind_textFindTextFindTextfind_text. The possible parameter values for ResultNameResultNameResultNameresultNameresult_name differ, depending on the text model used within the text segmentation process of find_textfind_textFindTextFindTextfind_text.

In the following, first the possible parameter values for text models with ModeModeModemodemode = 'auto'"auto""auto""auto""auto" are listed, and then those for text models with ModeModeModemodemode = 'manual'"manual""manual""manual""manual".

The following results can be queried:

  • Result objects for text segmentation with text models with ModeModeModemodemode = 'auto'"auto""auto""auto""auto"

    For each polarity, the text lines are independently sorted from top to bottom and left to right. The character within the text lines are sorted from left to right.

    'all_lines'"all_lines""all_lines""all_lines""all_lines":

    Returns all characters in all segmented text lines.

    ['line', LineIndex]["line", LineIndex]["line", LineIndex]["line", LineIndex]["line", LineIndex]:

    Returns all characters within the text line specified by LineIndex. For example, ['line', 0]["line", 0]["line", 0]["line", 0]["line", 0] returns the first line.

    ['element', Index]["element", Index]["element", Index]["element", Index]["element", Index]:

    Returns the character at position Index. For example, ['element', 0]["element", 0]["element", 0]["element", 0]["element", 0] returns the first character.

  • Result objects for text segmentation with text models with ModeModeModemodemode = 'manual'"manual""manual""manual""manual"

    'manual_all_lines'"manual_all_lines""manual_all_lines""manual_all_lines""manual_all_lines":

    Returns all characters in all segmented text lines. The text lines are sorted from top to bottom and left to right. The characters within the text lines are sorted from left to right.

    ['manual_line', Index]["manual_line", Index]["manual_line", Index]["manual_line", Index]["manual_line", Index]:

    Returns all characters within the text line specified by Index (e.g., ['manual_line',0]["manual_line",0]["manual_line",0]["manual_line",0]["manual_line",0] to return the first line). The characters within the text line are sorted from left to right.

    If 'manual_persistence'"manual_persistence""manual_persistence""manual_persistence""manual_persistence" was activated for the text model used to create TextResultIDTextResultIDTextResultIDtextResultIDtext_result_id, the following additional value can be queried:

    'manual_compensated_image'"manual_compensated_image""manual_compensated_image""manual_compensated_image""manual_compensated_image":

    the enhanced image used for segmentation.

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

CharactersCharactersCharacterscharacterscharacters (output_object)  object(-array) → objectHObjectHObjectHObjectHobject *

Returned result.

TextResultIDTextResultIDTextResultIDtextResultIDtext_result_id (input_control)  text_result → HTextResult, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)

Text result.

ResultNameResultNameResultNameresultNameresult_name (input_control)  string(-array) → HTupleMaybeSequence[Union[str, int]]HTupleHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong)

Name of the result to be returned.

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

List of values: 'all_lines'"all_lines""all_lines""all_lines""all_lines", 'element'"element""element""element""element", 'line'"line""line""line""line", 'manual_all_lines'"manual_all_lines""manual_all_lines""manual_all_lines""manual_all_lines", 'manual_compensated_image'"manual_compensated_image""manual_compensated_image""manual_compensated_image""manual_compensated_image", 'manual_line'"manual_line""manual_line""manual_line""manual_line"

Example (HDevelop)

read_image (Image, 'numbers_scale')
create_text_model_reader ('auto', 'Document_Rej.omc', TextModel)
* Optionally specify text properties
set_text_model_param (TextModel, 'min_char_height', 20)
find_text (Image, TextModel, TextResultID)
* Return character regions and corresponding classification results
get_text_object (Characters, TextResultID, 'all_lines')
get_text_result (TextResultID, 'class', Class)

Result

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

Possible Predecessors

find_textfind_textFindTextFindTextfind_text

See also

get_text_resultget_text_resultGetTextResultGetTextResultget_text_result

Module

Foundation

ClassesClasses | | Operators