RecognizePage(string,int,AutoFormsEnginePageRecognitionOptions) Method

Summary

Recognize the type of the unknown page in an image disk file with options.

Syntax

C++/CLI

Java

Python

public AutoFormsRecognizePageResult RecognizePage( 
   string fileName, 
   int pageNumber, 
   AutoFormsEnginePageRecognitionOptions options 
)

public:  
   AutoFormsRecognizePageResult^ RecognizePage( 
      String^ fileName, 
      int pageNumber, 
      AutoFormsEnginePageRecognitionOptions^ options 
   )

public AutoFormsRecognizePageResult recognizePage( 
   java.lang.String,  
   int,  
   AutoFormsEnginePageRecognitionOptions 
);

def RecognizePage(self,fileName,pageNumber,options):

Parameters

fileName

Name of the file containing the image of the unknown page. Must not be null.

pageNumber

The 1-based page number in fileName. Must be greather than or equal to 1.

options

Options to use during recognition.

Return Value

The result of the recognition will have the result of the Master Form Page with maximum confidence. If the confidence is less than MinimumConfidenceKnownForm then null is returned, i.e. the form type is unknown and cannot be recognized.

Remarks

This method compares the unknown page with all Master Forms pages in the repository and returns the Master Form and the number of the page in that Master Form with maximum confidence.

The recognition of the page will stop comparing the form with other Master Forms either when the confidence of the recognition result is greater or equal to MinimumConfidenceRecognized or when the Master Forms have all been compared.

This method is useful when you have an unknown page and you want to recognize the Master Form to which the page belongs after which you may process the form and extract the data.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Forms.Auto; 
using Leadtools.Document; 
using Leadtools.Ocr; 
using Leadtools.Forms.Recognition; 
using Leadtools.Forms.Processing; 
using Leadtools.Barcode; 
 
 
public void AutoPageRecognitionAndProcessing1File() 
{ 
   string root = Path.Combine(LEAD_VARS.ImagesDir, @"Forms\FormsDemo\OCR_Test"); 
   RasterCodecs codecs = new RasterCodecs(); 
 
   DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); 
 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
 
      BarcodeEngine barcodeEngine = new BarcodeEngine(); 
 
      AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine); 
      autoEngine.MinimumConfidenceRecognized = autoEngine.GetMinimumRecognizedConfidencePage(); 
 
      AutoFormsRecognizePageResult result = autoEngine.RecognizePage(Path.Combine(LEAD_VARS.ImagesDir, @"Forms\Forms to be Recognized\OCR\FCC-107_OCR_Filled.tif"), 1, new AutoFormsEnginePageRecognitionOptions()); 
      if (result == null) 
         return; 
      FormPage pageFields = autoEngine.ProcessPage(Path.Combine(LEAD_VARS.ImagesDir, @"Forms\Forms to be Recognized\OCR\FCC-107_OCR_Filled.tif"), 1, result); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS22\Bin\Common\OcrLEADRuntime"; 
}

Requirements

Target Platforms

Reference

AutoFormsEngine Class

AutoFormsEngine Members

Leadtools.Forms.Auto Namespace

Download our FREE evaluation

Help Version 22.0.2023.3.31

Leadtools.Forms.Auto Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Auto Namespace

Assemblies