.. index:: 
  !MrzReadingResult Class

.. _id3_document_mrz_reading_result_class:

===============================================================================
MrzReadingResult Class
===============================================================================

Namespace: :ref:`id3.Document<reference_document>`

.. toctree::
  :hidden:

  bounds<bounds>
  clone<clone>
  confidence<confidence>
  mrz<mrz>
  mrzType<mrz_type>


Definition
----------
.. line-block::
    Represents the result of MRZ reading.

.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        class MrzReadingResult

    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        class MrzReadingResult implements Finalizable

    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        public partial class MrzReadingResult

    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        public class MrzReadingResult implements AutoCloseable, Serializable

    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        public class MrzReadingResult

    .. tab-item:: C
      :sync: C

      .. code:: C

        typedef struct id3DocumentMrzReadingResult *ID3_DOCUMENT_MRZ_READING_RESULT;



Usage
-----

.. tab-set::

    .. tab-item:: Python
      :sync: Python

      .. code:: Python

        mrzReadingResultInstance = MrzReadingResult()
        # ...

      **Explicit destruction**

      .. code:: Python

        # ...
        del mrzReadingResultInstance

    .. tab-item:: Dart
      :sync: Dart

      .. code:: Dart

        final mrzReadingResultInstance = sdk.MrzReadingResult();
        // ...

      **Explicit destruction**

      .. code:: Dart

        // ...
        mrzReadingResultInstance.dispose()

    .. tab-item:: C#
      :sync: C#

      .. code:: C#

        using (var mrzReadingResultInstance = new MrzReadingResult())
        {
           // ...
        }

      **Explicit destruction**

      .. code:: C#

        var mrzReadingResultInstance = new MrzReadingResult()
        // ...
        mrzReadingResultInstance.Dispose()

    .. tab-item:: Java
      :sync: Java

      .. code:: Java

        try (MrzReadingResult mrzReadingResultInstance = new MrzReadingResult()) {
        // ...
        }

      **Explicit destruction**

      .. code:: Java

        MrzReadingResult mrzReadingResultInstance = new MrzReadingResult();
        // ...
        mrzReadingResultInstance.close();

    .. tab-item:: Swift
      :sync: Swift

      .. code:: Swift

        private var mrzReadingResultInstance: MrzReadingResult? = nil
        mrzReadingResultInstance = try MrzReadingResult()

    .. tab-item:: C
      :sync: C

      .. code:: C

        ID3_DOCUMENT_MRZ_READING_RESULT hMrzReadingResult{};
        int err = id3DocumentMrzReadingResult_Initialize(&hMrzReadingResult);
        if (err == ID3_SUCCESS) {
            // ...
            id3DocumentMrzReadingResult_Dispose(&hMrzReadingResult);
        }


Properties
----------

.. list-table:: 
  :width: 100%
  :widths: 30 5 65
  :header-rows: 1

  * - Name
    - Type
    - Description
  * - :ref:`bounds<id3_document_mrz_reading_result_bounds_class_member>`
    - :ref:`PointList<id3_document_point_list_class>`
    - Boundaries of the MRZ detected, in following order: top-left, top-right, bottom-right, bottom-left.
  * - :ref:`confidence<id3_document_mrz_reading_result_confidence_class_member>`
    - float
    - Confidence score for the MRZ detected.
  * - :ref:`mrz<id3_document_mrz_reading_result_mrz_class_member>`
    - string
    - Value of the MRZ detected.
  * - :ref:`mrzType<id3_document_mrz_reading_result_mrz_type_class_member>`
    - :ref:`MrzType<id3_document_mrz_type_enum>`
    - Type of the MRZ detected.

Methods
-------

.. list-table:: 
  :width: 100%
  :widths: 30 70
  :header-rows: 1

  * - Name
    - Description
  * - :ref:`clone<id3_document_mrz_reading_result_clone_class_method>`
    - Clones the MrzReadingResult object.
