MasterFormLoadType Property

Summary

Specifies how to load in memory the master form data found in the repository.

Syntax

C++

Java

public AutoFormsEngineMasterFormLoadType MasterFormLoadType { get; }

public AutoFormsEngineMasterFormLoadType getMasterFormLoadType();

Public ReadOnly Property MasterFormLoadType() As AutoFormsEngineMasterFormLoadType 
   Get

public:  
   property AutoFormsEngineMasterFormLoadType^ MasterFormLoadType 
   { 
      AutoFormsEngineMasterFormLoadType^ get() 
   }

Property Value

Gets the load type for master form data.

Remarks

This property is used to control the amount of memory used to hold master form data while maintaining the AutoFormsEngine's speed. The AutoFormsEngine performs the fastest when all master form data are loaded in memory. If the repository contains too many master forms to be loaded in memory, then there are two options:

Load MasterForm data on demand.
Use cache. Cache is a tradeoff between AutoFormsEngine speed and the needed memory. Notice that the cache option works only when FullTextSearchManager is set, otherwise it will work as in the load on demand option.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Forms.Auto; 
using Leadtools.Ocr; 
using Leadtools.Forms.Recognition; 
using Leadtools.Forms.Processing; 
using Leadtools.Barcode; 
 
public static void AutoFormsEngineCreateOptions_Example() 
{ 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD, false)) 
   { 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
 
      string root = Path.Combine(LEAD_VARS.ImagesDir, @"Forms\MasterForm Sets\Driving License"); 
      DiskMasterFormsRepository formsRepository = new DiskMasterFormsRepository(ocrEngine.RasterCodecsInstance, root); 
 
      // Set the parameters for the AutoFormsEngine 
      AutoFormsEngineCreateOptions autoFormsOptions = new AutoFormsEngineCreateOptions() 
      { 
         Repository = formsRepository, 
         RecognitionOcrEngine = ocrEngine, 
         ProcessingOcrEngine = ocrEngine, 
         BarcodeEngine = null, 
         Managers = AutoFormsRecognitionManager.Ocr | AutoFormsRecognitionManager.Default, 
         MinimumConfidenceKnownForm = 30, 
         MinimumConfidenceRecognized = 80, 
         RecognizeFirstPageOnly = true, 
         MasterFormLoadType = AutoFormsEngineMasterFormLoadType.UseCache 
      }; 
 
      // Create the AutoFormsEngine using the options previously defined 
      using (AutoFormsEngine autoEngine = new AutoFormsEngine(autoFormsOptions)) 
      { 
         // If caching masterform files, load 10 of them at a time 
         if (autoEngine.MasterFormLoadType == AutoFormsEngineMasterFormLoadType.UseCache) 
            autoEngine.MasterFormCacheMaximumSize = 10; 
 
         // Recognize and process the form 
         autoEngine.FilledFormType = FormsPageType.IDCard; 
         autoEngine.EnableQuickPreRecognitionCheck = false; 
         AutoFormsRunResult result = autoEngine.Run(Path.Combine(LEAD_VARS.ImagesDir, @"Forms\Forms to be Recognized\Driving License\License.png"), null); 
 
         if (result != null) 
            Console.WriteLine(String.Format("Recognized as {0} with {1}% confidence.", result.RecognitionResult.MasterForm.Name, result.RecognitionResult.Result.Confidence)); 
         else 
            Console.WriteLine("Form not recognized"); 
      } 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS 20\Bin\Common\OcrLEADRuntime"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Forms.Common 
Imports Leadtools.Forms.Auto 
Imports Leadtools.Ocr 
Imports Leadtools.Forms.Recognition 
Imports Leadtools.Forms.Processing 
Imports Leadtools.Barcode 
 
Public Shared Sub AutoFormsEngineCreateOptions_Example() 
   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD, False) 
      ocrEngine.Startup(Nothing, Nothing, Nothing, LEAD_VARS.OcrLEADRuntimeDir) 
 
      Dim root As String = Path.Combine(LEAD_VARS.ImagesDir, "Forms\MasterForm Sets\Driving License") 
      Dim formsRepository As DiskMasterFormsRepository = New DiskMasterFormsRepository(ocrEngine.RasterCodecsInstance, root) 
 
      ' Set the parameters for the AutoFormsEngine 
      Dim autoFormsOptions As AutoFormsEngineCreateOptions = New AutoFormsEngineCreateOptions() 
      autoFormsOptions.Repository = formsRepository 
      autoFormsOptions.RecognitionOcrEngine = ocrEngine 
      autoFormsOptions.ProcessingOcrEngine = ocrEngine 
      autoFormsOptions.BarcodeEngine = Nothing 
      autoFormsOptions.Managers = AutoFormsRecognitionManager.Ocr Or AutoFormsRecognitionManager.Default 
      autoFormsOptions.MinimumConfidenceKnownForm = 30 
      autoFormsOptions.MinimumConfidenceRecognized = 80 
      autoFormsOptions.RecognizeFirstPageOnly = True 
      autoFormsOptions.MasterFormLoadType = AutoFormsEngineMasterFormLoadType.UseCache 
 
      ' Create the AutoFormsEngine using the options previously defined 
      Using autoEngine As AutoFormsEngine = New AutoFormsEngine(autoFormsOptions) 
         ' If caching masterform files, load 10 of them at a time 
         If autoEngine.MasterFormLoadType = AutoFormsEngineMasterFormLoadType.UseCache Then 
            autoEngine.MasterFormCacheMaximumSize = 10 
         End If 
 
         ' Recognize and process the form 
         autoEngine.FilledFormType = FormsPageType.IDCard 
         autoEngine.EnableQuickPreRecognitionCheck = False 
         Dim result As AutoFormsRunResult = autoEngine.Run(Path.Combine(LEAD_VARS.ImagesDir, "Forms\Forms to be Recognized\Driving License\License.png"), Nothing) 
 
         If Not result Is Nothing Then 
            Console.WriteLine(String.Format("Recognized as {0} with {1}% confidence.", result.RecognitionResult.MasterForm.Name, result.RecognitionResult.Result.Confidence)) 
         Else 
            Console.WriteLine("Form not recognized") 
         End If 
      End Using 
   End Using 
End Sub 
 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
   Public Const OcrLEADRuntimeDir As String = "C:\LEADTOOLS 20\Bin\Common\OcrLEADRuntime" 
End Class

Requirements

Target Platforms

Reference

AutoFormsEngine Class

AutoFormsEngine Members

Leadtools.Forms.Auto Namespace

Download our FREE evaluation

Help Version 20.0.2020.3.31

Leadtools.Forms.Auto Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Auto Namespace

Assemblies