get_text_object — Query an iconic value of a text segmentation result.
get_text_object queries the iconic result ResultName of TextResultID returned by find_text. The possible parameter values for ResultName differ, depending on the text model used within the text segmentation process of find_text.
In the following, first the possible parameter values for text models with Mode = 'auto' are listed, and then those for text models with Mode = 'manual'.
The following results can be queried:
Result objects for text segmentation with text models with Mode = '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.
Returns all characters in all segmented text lines.
Returns all characters within the text line specified by LineIndex. For example, ['line', 0] returns the first line.
Returns the character at position Index. For example, ['element', 0] returns the first character.
Result objects for text segmentation with text models with Mode = 'manual'
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.
Returns all characters within the text line specified by 'Index' (e.g. ['manual_line',0] to return the first line). The characters within the text line are sorted from left to right.
If 'manual_persistence' was activated for the text model used to create TextResultID, the following additional value can be queried:
the enhanced image used for segmentation.
Name of the result to be returned.
Default value: 'all_lines'
List of values: 'all_lines', 'element', 'line', 'manual_all_lines', 'manual_compensated_image', 'manual_line'
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) clear_text_result (TextResultID) clear_text_model (TextModel)
If the parameters are valid, the operator get_text_object returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.