Go to: Contents |
Native Library API Reference |
Functions
FineRecognizeImage Function
This function recognizes all text lines on the image.
C Syntax
TFineErrorCode FineRecognizeImage(
const TLanguageID languages[],
const TFinePatternsPtr patterns,
const TFinePatternsPtr* cjkPatterns,
const TFineDictionaryPtr dictionaries[],
const CFineImage* image,
TFineImageProcessingOptions imageProcessingOptions,
TFineRecognitionMode recMode,
TFineRecognitionConfidenceLevel confidenceLevel,
CFineLayout** layoutBuff,
TFineRotationType* rotation,
TFineProgressCallbackFunction progressCallback,
TFinePrebuiltDataCallbackFunction prebuiltDataCallback
);
Parameters
- languages[]
- [in] The list of language IDs as an array of the
TLanguageID constants terminated by LID_Undefined.
We do not recommend adding more than two recognition
languages to the list.
- patterns
- [in] The address of
patterns as a
TFinePatternsPtr variable.
- cjkPatterns
- [in] The zero-terminated list of pointers to the
patterns for
CJK languages.
- dictionaries[]
- [in] The zero-terminated list of
dictionaries as an
array of
TFineDictionaryPtr variables.
- image
- [in] The image to be recognized as a
CFineImage variable.
- imageProcessingOptions
- [in] OR combination of the
TFineImageProcessingOptionsFlags
constants
that define the image processing parameters.
- recMode
- [in] The TFineRecognitionMode
constant that sets the recognition mode.
- confidenceLevel
- [in] The
TFineRecognitionConfidenceLevel
constant that sets the
recognition confidence level.
- layoutBuff
- [out] A pointer to pointer variable that receives the interface pointer of
a CFineLayout variable that describes the
recognized text. This pointer must be released afterwards with the help of the
FineFreeMemory function.
- rotation
- [out] The
TFineRotationType
constant that specifies the rotation angle of an input image before
recognition if the
FIPO_DetectPageOrientation flag is set in the imageProcessingOptions
parameter, otherwise, it contains 0.
Note: The recognized text
coordinates correspond to a rotated image.
- progressCallback
- [in] The TFineProgressCallbackFunction
callback function that delivers the progress information.
It can be 0.
- prebuiltDataCallback
- [in] The
TFinePrebuiltDataCallbackFunction callback function that delivers the
information about the document layout, text blocks and lines before the
text recognition.
It can be 0.
Return value
The function returns the standard return values of ABBYY Mobile OCR Engine functions.
See also
Working with Languages
Working with Dictionaries