ClassesClassesClassesClasses | | | | Operators

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

get_text_object( : Characters : TextResultID, ResultName : )

Herror get_text_object(Hobject* Characters, const Hlong TextResultID, const char* ResultName)

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

Herror 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

void HOperatorSetX.GetTextObject(
[out] IHUntypedObjectX*Characters, [in] VARIANT TextResultID, [in] VARIANT ResultName)

IHUntypedObjectX* HTextResultX.GetTextObject([in] VARIANT ResultName)

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

HObject HTextResult.GetTextObject(HTuple resultName)

HObject HTextResult.GetTextObject(string resultName)

Description

get_text_objectget_text_objectGetTextObjectget_text_objectGetTextObjectGetTextObject queries the iconic result ResultNameResultNameResultNameResultNameResultNameresultName of TextResultIDTextResultIDTextResultIDTextResultIDTextResultIDtextResultID returned by find_textfind_textFindTextfind_textFindTextFindText. The following results can be queried:

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

Returnes all segmented lines, sorted top to bottom and left to the right.

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

Returns the 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).

If 'persistence'"persistence""persistence""persistence""persistence""persistence" was activated with the text model used to create TextResultIDTextResultIDTextResultIDTextResultIDTextResultIDtextResultID, the following additional values can be queried:

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

the enhanced image used for segmentation.

Parallelization

Parameters

CharactersCharactersCharactersCharactersCharacterscharacters (output_object)  object(-array) objectHObjectHObjectHObjectHObjectXHobject *

Returned result.

TextResultIDTextResultIDTextResultIDTextResultIDTextResultIDtextResultID (input_control)  text_result HTextResult, HTupleHTupleHTextResult, HTupleHTextResultX, VARIANTHtuple (integer) (IntPtr) (Hlong) (Hlong) (Hlong) (Hlong)

Text result.

ResultNameResultNameResultNameResultNameResultNameresultName (input_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (string / integer) (string / int / long) (HString / Hlong) (char* / Hlong) (BSTR / Hlong) (char* / Hlong)

Name of the result to be returned.

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

List of values: 'all_lines'"all_lines""all_lines""all_lines""all_lines""all_lines", 'compensated_image'"compensated_image""compensated_image""compensated_image""compensated_image""compensated_image", 'line'"line""line""line""line""line"

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


ClassesClassesClassesClasses | | | | Operators