ClassesClassesClassesClasses | | | | Operators

get_text_resultget_text_resultGetTextResultget_text_resultGetTextResultGetTextResult (Operator)

Name

get_text_resultget_text_resultGetTextResultget_text_resultGetTextResultGetTextResult — Query a control value of a text segmentation result.

Signature

get_text_result( : : TextResultID, ResultName : ResultValue)

Herror get_text_result(const Hlong TextResultID, const char* ResultName, Hlong* ResultValue)

Herror T_get_text_result(const Htuple TextResultID, const Htuple ResultName, Htuple* ResultValue)

Herror get_text_result(const HTuple& TextResultID, const HTuple& ResultName, Hlong* ResultValue)

Herror get_text_result(const HTuple& TextResultID, const HTuple& ResultName, HTuple* ResultValue)

HTuple HTextResult::GetTextResult(const HTuple& ResultName) const

void GetTextResult(const HTuple& TextResultID, const HTuple& ResultName, HTuple* ResultValue)

HTuple HTextResult::GetTextResult(const HTuple& ResultName) const

HTuple HTextResult::GetTextResult(const HString& ResultName) const

HTuple HTextResult::GetTextResult(const char* ResultName) const

void HOperatorSetX.GetTextResult(
[in] VARIANT TextResultID, [in] VARIANT ResultName, [out] VARIANT* ResultValue)

VARIANT HTextResultX.GetTextResult([in] VARIANT ResultName)

static void HOperatorSet.GetTextResult(HTuple textResultID, HTuple resultName, out HTuple resultValue)

HTuple HTextResult.GetTextResult(HTuple resultName)

HTuple HTextResult.GetTextResult(string resultName)

Description

get_text_resultget_text_resultGetTextResultget_text_resultGetTextResultGetTextResult queries the control 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":

The following results can be queried:

Results for text segmentation with text models with Mode = 'auto'

Note that if the classifier contained in the text model was trained with rejection class, get_text_resultget_text_resultGetTextResultget_text_resultGetTextResultGetTextResult does not return characters classified as rejection class. Instead, the second best classification result is returned.

'num_lines'"num_lines""num_lines""num_lines""num_lines""num_lines":

Number of lines found.

'class'"class""class""class""class""class":

Returns the result of classifying the characters in all segmented text lines with the OCR classifier contained in the corresponding text model. 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.

['class_line',Index]:["class_line",Index]:["class_line",Index]:["class_line",Index]:["class_line",Index]:["class_line",Index]:

Returns the result of classifying the characters within the text line specified by 'Index'"Index""Index""Index""Index""Index" with the OCR classifier contained in the corresponding text model (e.g. ['class_line',0]["class_line",0]["class_line",0]["class_line",0]["class_line",0]["class_line",0] returns the character classes within the first text line). The characters within the text line are sorted from left to right.

'confidence'"confidence""confidence""confidence""confidence""confidence":

Returns the confidences of the above classes for all characters within 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.

['confidence_line',Index]:["confidence_line",Index]:["confidence_line",Index]:["confidence_line",Index]:["confidence_line",Index]:["confidence_line",Index]:

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

'polarity'"polarity""polarity""polarity""polarity""polarity":

Returns the polarity of the 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.

['polarity_line',Index]:["polarity_line",Index]:["polarity_line",Index]:["polarity_line",Index]:["polarity_line",Index]:["polarity_line",Index]:

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

Results for text segmentation with text models with Mode = 'manual'

'num_lines'"num_lines""num_lines""num_lines""num_lines""num_lines":

Number of lines found.

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:

'thresholds'"thresholds""thresholds""thresholds""thresholds""thresholds":

The thresholds used for segmentation.

Parallelization

Parameters

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: 'class' "class" "class" "class" "class" "class"

List of values: 'class'"class""class""class""class""class", 'class_line'"class_line""class_line""class_line""class_line""class_line", 'confidence'"confidence""confidence""confidence""confidence""confidence", 'confidence_line'"confidence_line""confidence_line""confidence_line""confidence_line""confidence_line", 'num_lines'"num_lines""num_lines""num_lines""num_lines""num_lines", 'polarity'"polarity""polarity""polarity""polarity""polarity", 'polarity_line'"polarity_line""polarity_line""polarity_line""polarity_line""polarity_line", 'thresholds'"thresholds""thresholds""thresholds""thresholds""thresholds"

ResultValueResultValueResultValueResultValueResultValueresultValue (output_control)  string(-array) HTupleHTupleHTupleVARIANTHtuple (integer / real / string) (int / long / double / string) (Hlong / double / HString) (Hlong / double / char*) (Hlong / double / BSTR) (Hlong / double / char*)

Value of ResultName.

Result

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

Possible Predecessors

find_textfind_textFindTextfind_textFindTextFindText

See also

get_text_objectget_text_objectGetTextObjectget_text_objectGetTextObjectGetTextObject

Module

Foundation


ClassesClassesClassesClasses | | | | Operators