get_text_objectget_text_objectGetTextObjectget_text_objectGetTextObjectGetTextObject (Operator)

Name

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

Signature

Description

get_text_objectget_text_objectGetTextObjectget_text_objectGetTextObjectGetTextObject queries the iconic result ResultNameResultNameResultNameResultNameResultNameresultName of TextResultIDTextResultIDTextResultIDTextResultIDTextResultIDtextResultID returned by find_textfind_textFindTextfind_textFindTextFindText. The possible parameter values for ResultNameResultNameResultNameResultNameResultNameresultName differ, depending on the text model used within the text segmentation process of find_textfind_textFindTextfind_textFindTextFindText.

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

Result objects for text segmentation with text models with Mode = 'auto'

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

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

['line',Index]:["line",Index]:["line",Index]:["line",Index]:["line",Index]:["line",Index]:

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

Result objects for text segmentation with text models with Mode = 'manual'

'all_lines'"all_lines""all_lines""all_lines""all_lines""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.

['line',Index]:["line",Index]:["line",Index]:["line",Index]:["line",Index]:["line",Index]:

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

If 'persistence'"persistence""persistence""persistence""persistence""persistence" was activated and ModeModeModeModeModemode = 'manual'"manual""manual""manual""manual""manual" for the text model used to create TextResultIDTextResultIDTextResultIDTextResultIDTextResultIDtextResultID, the following additional value can be queried:

'compensated_image'"compensated_image""compensated_image""compensated_image""compensated_image""compensated_image":

the enhanced image used for segmentation.

Parallelization

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

Parameters

Result

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

Possible Predecessors

find_textfind_textFindTextfind_textFindTextFindText

See also

get_text_resultget_text_resultGetTextResultget_text_resultGetTextResultGetTextResult

Module

Foundation