LEADTOOLS OCR (Leadtools.Forms.Ocr assembly) Send comments on this topic. | Back to Introduction - All Topics | Help Version 17.0.3.29
Run(String,String,DocumentFormat,String,OcrProgressCallback) Method
See Also 
Leadtools.Forms.Ocr Namespace > IOcrAutoRecognizeManager Interface > Run Method : Run(String,String,DocumentFormat,String,OcrProgressCallback) Method



imageFileName
The name of the file containing the image.
documentFileName
The name of the result document file.
format
The output document format. If this parameter is DocumentFormat.User, then the document saved using the native engine format set in IOcrDocumentManager.EngineFormat if the engine used supports native formats, otherwise an exception will be thrown.
zonesFileName
Optional name of prepared multi-page zone file. This parameter can be a null (Nothing in Visual Basic) reference.
callback
Optional callback to show operation progress.

The Run(String,String,DocumentFormat,String,OcrProgressCallback) Method is available as an add-on to the LEADTOOLS Document and Medical Imaging toolkits.

imageFileName
The name of the file containing the image.
documentFileName
The name of the result document file.
format
The output document format. If this parameter is DocumentFormat.User, then the document saved using the native engine format set in IOcrDocumentManager.EngineFormat if the engine used supports native formats, otherwise an exception will be thrown.
zonesFileName
Optional name of prepared multi-page zone file. This parameter can be a null (Nothing in Visual Basic) reference.
callback
Optional callback to show operation progress.
Converts an image file on disk to a document file in the specified document format with optional multi-page zone file.

Syntax

Visual Basic (Declaration) 
Overloads Sub Run( _
   ByVal imageFileName As String, _
   ByVal documentFileName As String, _
   ByVal format As DocumentFormat, _
   ByVal zonesFileName As String, _
   ByVal callback As OcrProgressCallback _
) 
Visual Basic (Usage)Copy Code
Dim instance As IOcrAutoRecognizeManager
Dim imageFileName As String
Dim documentFileName As String
Dim format As DocumentFormat
Dim zonesFileName As String
Dim callback As OcrProgressCallback
 
instance.Run(imageFileName, documentFileName, format, zonesFileName, callback)

Parameters

imageFileName
The name of the file containing the image.
documentFileName
The name of the result document file.
format
The output document format. If this parameter is DocumentFormat.User, then the document saved using the native engine format set in IOcrDocumentManager.EngineFormat if the engine used supports native formats, otherwise an exception will be thrown.
zonesFileName
Optional name of prepared multi-page zone file. This parameter can be a null (Nothing in Visual Basic) reference.
callback
Optional callback to show operation progress.

Example

Remarks

This method will perform the following operations:

  1. The IOcrAutoRecognizeManager.JobStarted event is triggered.

  2. Creates one ore more IOcrDocument object to store the pages into. The number of OCR documents created is dependant on MaximumThreadsPerJob. If this value is 0 (maximum CPUs/cores) or is greater than 1 and multiple threads is supported by this engine, then more than one document might be created to participate in the recognition process.

  3. Loops through all the pages in imageFileName and for each page:

    The page is added to its document using IOcrPageCollection.AddPage.

    If zonesFileName contains a valid multi-page zone file name and has an entry for the current page, then the zones are loaded with IOcrPage.LoadZones(fileName, pageNumber) and applied to the page. If zonesFileNames is a null (Nothing in Visual Basic) reference or it does not contain an equivalant page number, auto-decomposing of the page is performed instead with IOcrPage.AutoZone.

    IOcrPage.Recognize is called to get the OCR data of the page.

    If multiple documents are used or current number of recognized pages is greater than the maximum specified in MaximumPagesBeforeLtd, then current recognition data is saved to a temporary LTD file and the OCR document is cleared.

  4. When all pages are processed their saved to result file name specified in documentFileName using the format specified in format. If LTD was used, the temporary file is converted to the final document using DocumentWriter.Convert and optionally DocumentWriter.AppendLtd.

  5. All OCR documents and temporary files are deleted.

  6. The IOcrAutoRecognizeManager.JobCompleted event is triggered.

  7. You can use the IOcrAutoRecognizeManager.JobProgress event or callback to show the operation progress or to abort it if threading is not used. For more information and an example, refer to Leadtools.Forms.Ocr.OcrProgressCallback.

  8. You can use the IOcrAutoRecognizeManager.JobOperation event to get information regarding the current operation being performed. For more information and an example, refer to IOcrAutoRecognizeManager.JobOperation.

The IOcrAutoRecognizeManager interface also has the following options to use with this method:

Option Description
MaximumPagesBeforeLtd

Add support for converting a document with unlimited number of pages. An OCR recognition operation on a document that contains a large amount of pages (10 and more) might result in an out of memory error.

All of the LEADTOOLS OCR engines supports saving the intermediate recognition results to a temporary LTD file (DocumentFormat.LTD). The result of subsequent pages will be appended to this temporary file. When all the pages of the document have been recognized, the engine will convert the temporary LTD file to the desired output format.

The MaximumPagesBeforeLtd property defines the maximum number of pages processed as a whole. For example, if the original document has 20 pages and the value of this property is 8, the engine will recognize the first 8 pages and saves the result to a temporary file, recognizes the second 8 pages and append the results, and finally, recognize the last 4 pages and convert the temporary documentto the final format.

PreprocessPageCommands

Holds an array of OcrAutoPreprocessPageCommand items to control what auto-preprocess operation to perform on each page document prior to recognition.

MaximumThreadsPerJob

Maximum number of threads to use per job. You can instruct IOcrAutoRecognizeManager to use all available machine CPUs/cores when recognizing a document. This will greatly reduce the time required to finish the OCR operation.

JobErrorMode

Ability to resume on none critical errors. For example, if a source document has a page that could not be recognized. The offending page will be added to the final document as a graphics images and recognition will continue to the next page.

IOcrAutoRecognizeManager.JobStarted, IOcrAutoRecognizeManager.JobProgress, IOcrAutoRecognizeManager.JobOperation and IOcrAutoRecognizeManager.JobCompleted events

Events to track when both synchronous and asynchronous jobs has started, being run and completed.

AbortAllJobs

Aborts all running and pending jobs.

EnableTrace

Output debug messages to the standard .NET trace listeners.

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 2000, Windows XP, Windows Server 2003 family, Windows Server 2008 family, Windows Vista, Windows 7

See Also

Run(String,String,DocumentFormat,String,OcrProgressCallback) requires an OCR module license and unlock key. For more information, refer to: Imaging Pro/Document/Medical Features