L_OcrAutoRecognizeManager_Run (original) (raw)

Summary

Converts an image file on disk to a document file in the specified document format with optional multipage zone file.

Syntax

#include "ltocr.h"

L_LTOCR_API L_INT EXT_FUNCTION L_OcrAutoRecognizeManager_Run(autoRecognizeManager, imageFileName, documentFileName, format, zonesFileName)

Parameters

L_OcrAutoRecognizeManager autoRecognizeManager

Handle to the OCR engine auto recognize manager.

const L_TCHAR* imageFileName

The name of the file containing the image.

const L_TCHAR* documentFileName

The name of the result document file.

DOCWRTFORMAT format

The output document format.

const L_TCHAR* zonesFileName

Optional name of prepared multipage zone file. This parameter can be NULL.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This method will perform the following operations:

The L_OcrAutoRecognizeRunJobCallback callback will be fired to indicate that job just started.
Creates one ore more L_OcrPage. The number of created OCR pages conforms to the following formula: MIN(8, maximum CPUs/cores), so if you have more than 8 cores on your machine only 8 threads will be created but if you have less that 8 cores then that number will be used to determine the number of threads to be created to participate in the recognition process. Also the internal created OCR document will be created as disk-based.
Loops through all the pages in imageFileName and for each page:
1. The page is created using L_OcrPage_FromBitmap after we load the file into BITMAPHANDLE.
2. If zonesFileName contains a valid multipage zone file name and has an entry for the current page, then the zones are loaded with L_OcrPage_LoadZonesFile and applied to the page. If zonesFileName is a NULL or is empty string or it does not contain an equivalent page number, auto-decomposing of the page is performed instead with L_OcrPage_AutoZone.
3. L_OcrPage_Recognize is called to get the OCR data of the page.
4. The page is added to the internal OCR document using L_OcrDocument_AddPage.
When all pages are processed they will be saved to result file name specified in documentFileName using the format specified format.
All OCR documents and temporary files are deleted.
The L_OcrAutoRecognizeRunJobCallback callback will be fired to indicate that the job has completed or aborted.
You can use the L_OcrAutoRecognizeJobOperationCallback to get information regarding the current operation being performed. For more information and an example, refer to L_OcrAutoRecognizeManager_SetJobOperationCallback.

The L_OcrAutoRecognizeManager also has some options that you can control, For more information about these options, refer to L_OcrAutoRecognizeManager_GetOptions and L_OcrAutoRecognizeManager_SetOptions.

Required DLLs and Libraries

LTOCR
For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Example

L_INT L_OcrAutoRecognizeManager_RunExample() { L_INT retCode = -1; L_OcrEngine ocrEngine = NULL; L_OcrAutoRecognizeManager autoRecognizeManager = NULL; // Create an instance of the engine retCode = L_OcrEngineManager_CreateEngine(L_OcrEngineType_LEAD, &ocrEngine); if(retCode != SUCCESS) return retCode; // Start the engine using default parameters retCode =L_OcrEngine_Startup(ocrEngine, NULL, OCR_LEAD_RUNTIME_DIR); if(retCode != SUCCESS) return retCode; // Get the AutoRecognizeManager L_OcrEngine_GetAutoRecognizeManager(ocrEngine, &autoRecognizeManager); // Recognize the document retCode = L_OcrAutoRecognizeManager_Run(autoRecognizeManager, MAKE_IMAGE_PATH(L_TEXT("OCR1.tif")), MAKE_IMAGE_PATH(L_TEXT("OCR1.pdf")), DOCUMENTFORMAT_PDF, NULL); //CLEANUP L_OcrEngine_Destroy(ocrEngine); return retCode; }