.. index:: 
  !PortraitProcessor.cropEyePositionRatio Property

.. _id3_face_portrait_processor_crop_eye_position_ratio_class_member:

===============================================================================
PortraitProcessor.cropEyePositionRatio Property
===============================================================================

Module: :ref:`PortraitProcessor<id3_face_portrait_processor_class>`

Type: float

Definition
----------

Ratio between the vertical eye position and the image height for ICAO portrait cropping. Must be in the range ]0;1[.

.. hint:: Default value is 0.45.


.. tab-set::

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

    .. code:: Python

      crop_eye_position_ratio: float


    **Exceptions**

      .. line-block::

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

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

    .. code:: Dart

      double get cropEyePositionRatio => getCropEyePositionRatio();
      set cropEyePositionRatio(double value) => setCropEyePositionRatio(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 float cropEyePositionRatio
      {
          get => GetcropEyePositionRatio();
          set => SetcropEyePositionRatio(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 float getCropEyePositionRatio() throws FaceException
      public void setCropEyePositionRatio(float cropEyePositionRatio) 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 cropEyePositionRatio: Float
          get {
              return try! getCropEyePositionRatio()
          }
      }


    **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_GetCropEyePositionRatio (ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor, float * cropEyePositionRatio)
      int id3FacePortraitProcessor_SetCropEyePositionRatio (ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor, float cropEyePositionRatio)

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

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

