Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# MrzReader Class

Namespace: id3.Document

## Definition

Detects and reads an MRZ in an image.
Python

    class MrzReader

Dart

    class MrzReader implements Finalizable

C#

    public partial class MrzReader

Java

    public class MrzReader implements AutoCloseable, Serializable

Swift

    public class MrzReader

C

    typedef struct id3DocumentMrzReader *ID3_DOCUMENT_MRZ_READER;

## Usage

Python

    mrzReaderInstance = MrzReader()
    # ...

Explicit destruction

    # ...
    del mrzReaderInstance

Dart

    final mrzReaderInstance = sdk.MrzReader();
    // ...

Explicit destruction

    // ...
    mrzReaderInstance.dispose()

C#

    using (var mrzReaderInstance = new MrzReader())
    {
       // ...
    }

Explicit destruction

    var mrzReaderInstance = new MrzReader()
    // ...
    mrzReaderInstance.Dispose()

Java

    try (MrzReader mrzReaderInstance = new MrzReader()) {
    // ...
    }

Explicit destruction

    MrzReader mrzReaderInstance = new MrzReader();
    // ...
    mrzReaderInstance.close();

Swift

    private var mrzReaderInstance: MrzReader? = nil
    mrzReaderInstance = try MrzReader()

C

    ID3_DOCUMENT_MRZ_READER hMrzReader{};
    int err = id3DocumentMrzReader_Initialize(&hMrzReader);
    if (err == ID3_SUCCESS) {
        // ...
        id3DocumentMrzReader_Dispose(&hMrzReader);
    }

## Properties

Name | Type | Description
--- | --- | ---
binarizationMethod | int | Selection of the binarization method internally used in the algorithm.
model | DocumentModel | AI model used to detect the MRZ.
processingUnit | ProcessingUnit | Processing unit where to run the detection process.
threadCount | int | Number of threads to use for reading.

## Methods

Name | Description
--- | ---
readMrz | Detects and reads an MRZ in an image.