MRTDField Enumeration

Summary

Represents MRTD Field.

Syntax

Objective-C

C++/CLI

Java

Python

public enum MRTDField

typedef NS_ENUM(NSInteger, LTMRTDField) { 
 LTMRTDFieldType = 0,  
 
 LTMRTDFieldDocumentCode,  
 LTMRTDFieldDocumentNumber,  
 LTMRTDFieldPassportNumber,  
 
 LTMRTDFieldIssuingState,  
 LTMRTDFieldName,  
 LTMRTDFieldLastName,  
 LTMRTDFieldSex,  
 
 LTMRTDFieldNationality,  
 LTMRTDFieldDateOfBirth,  
 LTMRTDFieldDateOfExpiry,  
 LTMRTDFieldValidUntilDate,  
 
 LTMRTDFieldOptionalData,  
 LTMRTDFieldOptionalData2,  
 LTMRTDFieldIDCardNumber,  
 
 LTMRTDFieldPassportNumberCheckDigit = 100,  
 LTMRTDFieldDocumentNumberCheckDigit,  
 LTMRTDFieldIDCardNumberCheckDigit,  
 LTMRTDFieldDateOfBirthCheckDigit,  
 LTMRTDFieldDateOfExpiryCheckDigit,  
 LTMRTDFieldValidUntilDateCheckDigit,  
 LTMRTDFieldOptionalDataCheckDigit,  
 LTMRTDFieldCompositeCheckDigit,  
 LTMRTDFieldOverallCheckDigit 
};

public final class MRTDField 
    extends java.lang.Enum<MRTDField>

public enum class MRTDField

class MRTDField(Enum): 
   Type = 0 
   DocumentCode = 1 
   DocumentNumber = 2 
   PassportNumber = 3 
   IssuingState = 4 
   Name = 5 
   LastName = 6 
   Sex = 7 
   Nationality = 8 
   DateOfBirth = 9 
   DateOfExpiry = 10 
   ValidUntilDate = 11 
   OptionalData = 12 
   OptionalData2 = 13 
   IDCardNumber = 14 
   PassportNumberCheckDigit = 100 
   DocumentNumberCheckDigit = 101 
   IDCardNumberCheckDigit = 102 
   DateOfBirthCheckDigit = 103 
   DateOfExpiryCheckDigit = 104 
   ValidUntilDateCheckDigit = 105 
   OptionalDataCheckDigit = 106 
   CompositeCheckDigit = 107 
   OverallCheckDigit = 108

Members

Value	Member	Description
0	Type	The Type of the Document.
1	DocumentCode	The Code of the Document.
2	DocumentNumber	The Number of the Document.
3	PassportNumber	The Number of the Passport.
4	IssuingState	The Issuing State of the Document.
5	Name	The Name of the Document Holder.
6	LastName	The Last name of the Document Holder.
7	Sex	The Sex of the Document Holder.
8	Nationality	The Nationality of the Document Holder.
9	DateOfBirth	The Date Of Birth for the Document Holder.
10	DateOfExpiry	The Date Of Expiry for the Document.
11	ValidUntilDate	Valid Until Date for the Document.
12	OptionalData	The Optional Data for the Document.
13	OptionalData2	The Optional Data for the Document(some documents has two optional Data).
14	IDCardNumber	The number of the Identification Card.
100	PassportNumberCheckDigit	The Check Digit for Passport number.
101	DocumentNumberCheckDigit	The Check Digit for the Document number.
102	IDCardNumberCheckDigit	The Check Digit for the Id Card number.
103	DateOfBirthCheckDigit	The Check Digit for the Date Of Birth.
104	DateOfExpiryCheckDigit	The Check Digit for the Date Of Expiry.
105	ValidUntilDateCheckDigit	The Check Digit for the "Valid Until Date" field.
106	OptionalDataCheckDigit	The Check Digit for Optional Data.
107	CompositeCheckDigit	The Composite Check Digit.
108	OverallCheckDigit	The Overall Check Digit.

Remarks

MRTDField is used in MRTDDataElement to show the data element related field.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Ocr; 
using Leadtools.Forms.Commands; 
 
 
public void TestMRTDReader() 
{ 
   // Initialize the RasterCodecs class 
   RasterCodecs codecs = new RasterCodecs(); 
 
   // Initialize the MRTDReader class 
   MRTDReader mrtdReader = new MRTDReader(); 
 
   // The MRTD image 
   string mrtdPath = Path.Combine(LEAD_VARS.ImagesDir, "MRZ_SAMPLE.jpg"); 
   RasterImage image = codecs.Load(mrtdPath); 
 
   IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD); 
   ocrEngine.Startup(codecs, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
 
   // Assign Engine to Reader 
   mrtdReader.OcrEngine = ocrEngine; 
 
   // Process Image 
   mrtdReader.ProcessImage(image); 
 
   if (mrtdReader.Errors == MRTDErrors.NoError) 
   { 
      foreach (var value in mrtdReader.Results) 
      { 
         Console.WriteLine(string.Format("Data Element Field: {0}", value.Key.ToString())); 
         Console.WriteLine(string.Format("Data Element Value: {0}", value.Value.ReadableValue)); 
         Console.WriteLine(string.Format("Data Element Code : {0}", value.Value.MrzCharacters)); 
         Console.WriteLine(string.Format("Data Element Valid: {0}", value.Value.IsValid.ToString())); 
         Console.WriteLine("************************************"); 
      } 
   } 
 
   ocrEngine.Shutdown(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS23\Bin\Common\OcrLEADRuntime"; 
}

 
import java.io.File; 
import java.io.IOException; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.forms.commands.BankCheckMicrFontType; 
import leadtools.forms.commands.BankCheckReader; 
import leadtools.forms.commands.MRTDErrors; 
import leadtools.forms.commands.MRTDReader; 
import leadtools.forms.commands.ProcessListener; 
import leadtools.forms.commands.ProcessState; 
import leadtools.forms.commands.ProgressEvent; 
import leadtools.ocr.OcrEngine; 
import leadtools.ocr.OcrEngineManager; 
import leadtools.ocr.OcrEngineType; 
 
 
public void TestMRTDReader() { 
   RasterCodecs codecs = new RasterCodecs(); 
   MRTDReader mrtdReader = new MRTDReader(); 
 
   // The MRTD image 
   String LEAD_VARS_ImagesDir = "C:\\LEADTOOLS23\\Resources\\Images"; 
   String mrtdPath = combine(LEAD_VARS_ImagesDir, "MRZ_SAMPLE.jpg"); 
   RasterImage image = codecs.load(mrtdPath); 
   String LEAD_VARS_OcrLEADRuntimeDir = "C:\\LEADTOOLS23\\Bin\\Common\\OcrLEADRuntime"; 
   OcrEngine ocrEngine = OcrEngineManager.createEngine(OcrEngineType.LEAD); 
   ocrEngine.startup(codecs, null, null, LEAD_VARS_OcrLEADRuntimeDir); 
   assertTrue("OCR engine not started", ocrEngine.isStarted()); 
 
   // Assign Engine to Reader 
   mrtdReader.setOcrEngine(ocrEngine); 
 
   // Process Image 
   mrtdReader.processImage(image); 
 
   if (mrtdReader.getErrors() == MRTDErrors.NO_ERROR.getValue()) { 
      for (var value : mrtdReader.getResults().values()) { 
         System.out.println(String.format("Data Element Field: %s", value)); 
         System.out.println(String.format("Data Element Value: %s", value.getReadableValue())); 
         System.out.println(String.format("Data Element Code : %s", value.getMrzCharacters())); 
         System.out.println(String.format("Data Element Valid: %s", value.isValid())); 
         System.out.println("************************************"); 
      } 
   } 
 
   ocrEngine.shutdown(); 
}

Requirements

Target Platforms

Reference

Leadtools.Forms.Commands Namespace

Download our FREE evaluation

Help Version 23.0.2024.5.23

Leadtools.Forms.Commands Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Commands Namespace

Assemblies