.. index:: 
  !HologramAuthenticationResult.correlationScore Property

.. _id3_document_hologram_authentication_result_correlation_score_class_member:

===============================================================================
HologramAuthenticationResult.correlationScore Property
===============================================================================

Module: :ref:`HologramAuthenticationResult<id3_document_hologram_authentication_result_class>`

Type: float

Definition
----------

Correlation of the variation to the background.


.. tab-set::

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

    .. code:: Python

      correlation_score: float


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

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

    .. code:: Dart

      double get correlationScore => getCorrelationScore();


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

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

    .. code:: C#

      public float correlationScore
      {
          get => GetcorrelationScore();
      }


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

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

    .. code:: Java

      public float getCorrelationScore() throws DocumentException


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

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

    .. code:: Swift

      public var correlationScore: Float
          get {
              return try! getCorrelationScore()
          }
      }


    **Exceptions**

      .. line-block::

        :ref:`DocumentException<id3_document_document_exception>`
        An error has occurred during Document Library execution.

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

    .. code:: C

      int id3DocumentHologramAuthenticationResult_GetCorrelationScore (ID3_DOCUMENT_HOLOGRAM_AUTHENTICATION_RESULT hHologramAuthenticationResult, float * correlationScore)

    **Returns**
   
      .. line-block::

        ``int``
        An error code.
        See :ref:`id3DocumentError<id3_document_document_error_enum>` file for the list of possible error codes.

