.. index:: 
  !PortraitProcessor.maximumHeadHeightRatio Property

.. _id3_face_portrait_processor_maximum_head_height_ratio_class_member:

===============================================================================
PortraitProcessor.maximumHeadHeightRatio Property
===============================================================================

Module: :ref:`PortraitProcessor<id3_face_portrait_processor_class>`

Type: int

Definition
----------

Maximum distance between the base of the chin and the crown is less than 80% of the total height of the image.

For ICAO compliance, this distance must be in the range 60 to 90.

.. hint:: Default value is 90.


.. tab-set::

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

    .. code:: Python

      maximum_head_height_ratio: int


    **Exceptions**

      .. line-block::

        :ref:`FaceException<id3_face_face_exception>`
        An error has occurred during Face Library execution.

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

    .. code:: Dart

      int get maximumHeadHeightRatio => getMaximumHeadHeightRatio();
      set maximumHeadHeightRatio(int value) => setMaximumHeadHeightRatio(value);


    **Exceptions**

      .. line-block::

        :ref:`FaceException<id3_face_face_exception>`
        An error has occurred during Face Library execution.

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

    .. code:: C#

      public int maximumHeadHeightRatio
      {
          get => GetmaximumHeadHeightRatio();
          set => SetmaximumHeadHeightRatio(ref value);
      }


    **Exceptions**

      .. line-block::

        :ref:`FaceException<id3_face_face_exception>`
        An error has occurred during Face Library execution.

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

    .. code:: Java

      public int getMaximumHeadHeightRatio() throws FaceException
      public void setMaximumHeadHeightRatio(int maximumHeadHeightRatio) throws FaceException


    **Exceptions**

      .. line-block::

        :ref:`FaceException<id3_face_face_exception>`
        An error has occurred during Face Library execution.

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

    .. code:: Swift

      public var maximumHeadHeightRatio: Int
          get {
              return Int(try! getMaximumHeadHeightRatio())
          }
      }


    **Exceptions**

      .. line-block::

        :ref:`FaceException<id3_face_face_exception>`
        An error has occurred during Face Library execution.

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

    .. code:: C

      int id3FacePortraitProcessor_GetMaximumHeadHeightRatio (ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor, int * maximumHeadHeightRatio)
      int id3FacePortraitProcessor_SetMaximumHeadHeightRatio (ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor, int maximumHeadHeightRatio)

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

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

