RecognizePage(Stream,int,AutoFormsEnginePageRecognitionOptions) Method

Summary

Recognize the type of the unknown page in a stream with options.

Syntax

C++/CLI

Java

Python

public AutoFormsRecognizePageResult RecognizePage( 
   Stream stream, 
   int pageNumber, 
   AutoFormsEnginePageRecognitionOptions options 
)

public:  
   AutoFormsRecognizePageResult^ RecognizePage( 
      System::IO::Stream^ stream, 
      int pageNumber, 
      AutoFormsEnginePageRecognitionOptions^ options 
   )

public AutoFormsRecognizePageResult recognizePage( 
   ILeadStream stream, 
   int pageNumber, 
   AutoFormsEnginePageRecognitionOptions options 
);

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

Parameters

stream

Stream containing the image of the unknown page. Must not be null.

pageNumber

The 1-based page number in stream. 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; 
 
using Leadtools.Forms; 
 
public void AutoPageRecognitionAndProcessing1Stream() 
{ 
   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(); 
 
      FileStream fs = File.OpenRead(Path.Combine(LEAD_VARS.ImagesDir, @"Forms\Forms to be Recognized\OCR\FCC-107_OCR_Filled.tif")); 
 
      AutoFormsRecognizePageResult result = autoEngine.RecognizePage(fs, 1, new AutoFormsEnginePageRecognitionOptions()); 
      if (result == null) 
         return; 
      FormPage pageFields = autoEngine.ProcessPage(fs, 1, result); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS23\Bin\Common\OcrLEADRuntime"; 
}

Requirements

Target Platforms

Reference

AutoFormsEngine Class

AutoFormsEngine Members

Leadtools.Forms.Auto Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Forms.Auto Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Auto Namespace

Assemblies