Run(Stream,string,DocumentFormat,string,OcrProgressCallback) Method

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

public void Run( 
   Stream imageStream, 
   string documentFileName, 
   DocumentFormat format, 
   string zonesFileName, 
   OcrProgressCallback callback 
) 

public:  
   void Run( 
      Stream^ imageStream, 
      String^ documentFileName, 
      DocumentFormat^ format, 
      String^ zonesFileName, 
      OcrProgressCallback^ callback 
   ) 

def Run(self,imageStream,documentFileName,format,zonesFileName,callback): 

Parameters

This method will perform the following operations:

1. The JobStarted event is triggered.

2. Creates one or more IOcrDocument object to store the pages into. The number of OCR documents created is dependent 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. The document will be created as disk-based.

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

   • The page is created using IOcrEngine.CreatePage.

   • If  zonesFileName contains a valid multipage 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  zonesFileName is a null (Nothing in VB) reference or it does not contain an equivalent 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.

   • For LEADTOOLS OCR Module - LEAD Engine, the page is added to the document using IOcrDocument.Pages.Add.

   • For engines other than LEADTOOLS OCR Module - LEAD Engine: 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 they are 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 JobCompleted event is triggered.

7. You can use the 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 OcrProgressCallback.

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

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

Target Platforms

Reference

IOcrAutoRecognizeManager Interface

IOcrAutoRecognizeManager Members

Overload List

Programming with the LEADTOOLS .NET OCR

Multi-Threading with LEADTOOLS OCR