.. index:: 
  !HologramAuthenticationResult Class

.. _id3_document_hologram_authentication_result_class:

===============================================================================
HologramAuthenticationResult Class
===============================================================================

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

.. toctree::
  :hidden:

  bounds<bounds>
  clone<clone>
  correlationScore<correlation_score>
  hologramName<hologram_name>
  variationScore<variation_score>


Definition
----------
.. line-block::
    Represents the result of hologram authentication.

.. tab-set::

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

      .. code:: Python

        class HologramAuthenticationResult

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

      .. code:: Dart

        class HologramAuthenticationResult implements Finalizable

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

      .. code:: C#

        public partial class HologramAuthenticationResult

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

      .. code:: Java

        public class HologramAuthenticationResult implements AutoCloseable, Serializable

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

      .. code:: Swift

        public class HologramAuthenticationResult

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

      .. code:: C

        typedef struct id3DocumentHologramAuthenticationResult *ID3_DOCUMENT_HOLOGRAM_AUTHENTICATION_RESULT;



Usage
-----

.. tab-set::

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

      .. code:: Python

        hologramAuthenticationResultInstance = HologramAuthenticationResult()
        # ...

      **Explicit destruction**

      .. code:: Python

        # ...
        del hologramAuthenticationResultInstance

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

      .. code:: Dart

        final hologramAuthenticationResultInstance = sdk.HologramAuthenticationResult();
        // ...

      **Explicit destruction**

      .. code:: Dart

        // ...
        hologramAuthenticationResultInstance.dispose()

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

      .. code:: C#

        using (var hologramAuthenticationResultInstance = new HologramAuthenticationResult())
        {
           // ...
        }

      **Explicit destruction**

      .. code:: C#

        var hologramAuthenticationResultInstance = new HologramAuthenticationResult()
        // ...
        hologramAuthenticationResultInstance.Dispose()

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

      .. code:: Java

        try (HologramAuthenticationResult hologramAuthenticationResultInstance = new HologramAuthenticationResult()) {
        // ...
        }

      **Explicit destruction**

      .. code:: Java

        HologramAuthenticationResult hologramAuthenticationResultInstance = new HologramAuthenticationResult();
        // ...
        hologramAuthenticationResultInstance.close();

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

      .. code:: Swift

        private var hologramAuthenticationResultInstance: HologramAuthenticationResult? = nil
        hologramAuthenticationResultInstance = try HologramAuthenticationResult()

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

      .. code:: C

        ID3_DOCUMENT_HOLOGRAM_AUTHENTICATION_RESULT hHologramAuthenticationResult{};
        int err = id3DocumentHologramAuthenticationResult_Initialize(&hHologramAuthenticationResult);
        if (err == ID3_SUCCESS) {
            // ...
            id3DocumentHologramAuthenticationResult_Dispose(&hHologramAuthenticationResult);
        }


Properties
----------

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

  * - Name
    - Type
    - Description
  * - :ref:`bounds<id3_document_hologram_authentication_result_bounds_class_member>`
    - :ref:`Rectangle<id3_document_rectangle_struct>`
    - Exact bounds of the text in the image.
  * - :ref:`correlationScore<id3_document_hologram_authentication_result_correlation_score_class_member>`
    - float
    - Correlation of the variation to the background.
  * - :ref:`hologramName<id3_document_hologram_authentication_result_hologram_name_class_member>`
    - string
    - Name of the hologram.
  * - :ref:`variationScore<id3_document_hologram_authentication_result_variation_score_class_member>`
    - float
    - Variation of the OVI color.

Methods
-------

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

  * - Name
    - Description
  * - :ref:`clone<id3_document_hologram_authentication_result_clone_class_method>`
    - Clones the HologramAuthenticationResult object.
