←Select platform

OcrProgressOperation Enumeration

Summary
OCR progress callback operation identification.
Syntax
C#
Objective-C
C++/CLI
Java
Python
[SerializableAttribute()] 
public enum OcrProgressOperation   
typedef NS_ENUM(NSInteger, LTOcrProgressOperation) { 
 LTOcrProgressOperationLoadImage = 0,  
 LTOcrProgressOperationSaveImage,  
 LTOcrProgressOperationPreprocessImage,  
 LTOcrProgressOperationAutoZone,  
 LTOcrProgressOperationRecognize,  
 LTOcrProgressOperationSaveDocumentPrepare,  
 LTOcrProgressOperationSaveDocument,  
 LTOcrProgressOperationSaveDocumentConvertImage,  
 LTOcrProgressOperationFormatting,  
 LTOcrProgressOperationRecognizeOMR,  
 LTOcrProgressOperationLast = LTOcrProgressOperationRecognizeOMR 
}; 
public enum OcrProgressOperation 
[SerializableAttribute()] 
public enum class OcrProgressOperation   
class OcrProgressOperation(Enum): 
   LoadImage = 0 
   SaveImage = 1 
   ProcessImage = 2 
   FindZones = 3 
   RecognizeFirstPass = 4 
   RecognizeSecondPass = 5 
   RecognizeThirdPass = 6 
   SaveDocumentPrepare = 7 
   SaveDocument = 8 
   SaveDocumentConvertImage = 9 
   Formatting = 10 
   RecognizeOmr = 11 
Members
ValueMemberDescription
0LoadImage Image load operation. Used when pages are added to an OCR document through one of IOcrPageCollection.AddPage, IOcrPageCollection.AddPages, IOcrPageCollection.InsertPage or IOcrPageCollection.InsertPages methods.
1SaveImage Image save operation. Used when IOcrPage.Recognize is called.
2ProcessImage Image preprocessing operation. Used when IOcrPage.AutoPreprocess is called.
3FindZones Page-layout decomposition operation. Used when IOcrPage.AutoZone is called.
4RecognizeFirstPass First pass recognition operation that may be used when IOcrPage.Recognize is used with the MOR recognition module
5RecognizeSecondPass Second pass recognition operation. Used when IOcrPage.Recognize is called.
6RecognizeThirdPass Third pass recognition operation. Used when IOcrPage.Recognize is called.
7SaveDocumentPrepare Prepare the document operation. Used when IOcrDocument.Save is called.
8SaveDocument Save document operation. Used when IOcrDocument.Save is called.
9SaveDocumentConvertImage Convert the document images operation. Used when IOcrDocument.Save is called.
10Formatting Format the document before saving. Used when IOcrDocument.Save is called.
11RecognizeOmr Recognizing OMR zones operation. Used when IOcrPage.Recognize is called on a page with zones containing OcrZoneType.Omr.
Remarks

OcrProgressOperation is the value of IOcrProgressData.Operation. Use this value to examine the current operation of the process.

Each operation listed represents one of the fundamental services provided by the OCR engine. Any application program will use at least some of these processes.

Each operation can be initiated by the methods shown. OcrProgressCallback can be used to generate progress monitoring on any of these operations.

Example
C#
using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Ocr; 
using Leadtools.Document.Writer; 
using Leadtools.Forms.Common; 
using Leadtools.WinForms; 
 
public void OcrProgressCallbackExample() 
{ 
   string logFileName = Path.Combine(LEAD_VARS.ImagesDir, "log.txt"); 
   string multiPageTifFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr.tif"); 
   string pdfFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.pdf"); 
 
   // Create the log text writer 
   _log = File.CreateText(logFileName); 
 
   // Create an instance of the engine 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      // Start the engine using default parameters 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
 
      // Create an OCR document 
      using (IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument()) 
      { 
         // Add this image to the document 
         _log.WriteLine("Adding the pages"); 
         _log.WriteLine("********************************"); 
         ocrDocument.Pages.AddPages(multiPageTifFileName, 1, -1, new OcrProgressCallback(MyOcrProgressCallback)); 
 
         // Auto-recognize the zones in all the pages 
         _log.WriteLine("Auto-zoning"); 
         _log.WriteLine("********************************"); 
         ocrDocument.Pages.AutoZone(new OcrProgressCallback(MyOcrProgressCallback)); 
 
         // Recognize it and save it as PDF 
         _log.WriteLine("Recognizing"); 
         _log.WriteLine("********************************"); 
         ocrDocument.Pages.Recognize(new OcrProgressCallback(MyOcrProgressCallback)); 
         _log.WriteLine("Saving to PDF"); 
         _log.WriteLine("********************************"); 
         ocrDocument.Save(pdfFileName, DocumentFormat.Pdf, new OcrProgressCallback(MyOcrProgressCallback)); 
      } 
 
      // Shutdown the engine 
      // Note: calling Dispose will also automatically shutdown the engine if it has been started 
      ocrEngine.Shutdown(); 
   } 
 
   _log.WriteLine("********************************"); 
   _log.WriteLine("Complete"); 
   _log.Flush(); 
   _log.Close(); 
} 
// Text writer to save the log to 
private StreamWriter _log; 
 
private void MyOcrProgressCallback(IOcrProgressData data) 
{ 
   if (data.Percentage == 0) 
      _log.WriteLine("--------------------------"); 
 
   _log.WriteLine("Page:{0}({1}:{2}) {3}% Operation:{4}", 
      data.CurrentPageIndex.ToString("00"), 
      data.FirstPageIndex.ToString("00"), 
      data.LastPageIndex.ToString("00"), 
      data.Percentage.ToString("000"), 
      data.Operation); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS22\Bin\Common\OcrLEADRuntime"; 
} 
Requirements

Target Platforms

Help Version 22.0.2023.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Ocr Assembly

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.