Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# PortraitProcessor.cropEyePositionRatio Property

Module: PortraitProcessor

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.

Python

    crop_eye_position_ratio: float

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Dart

    double get cropEyePositionRatio => getCropEyePositionRatio();
    set cropEyePositionRatio(double value) => setCropEyePositionRatio(value);

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C#

    public float cropEyePositionRatio
    {
        get => GetcropEyePositionRatio();
        set => SetcropEyePositionRatio(ref value);
    }

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Java

    public float getCropEyePositionRatio() throws FaceException
    public void setCropEyePositionRatio(float cropEyePositionRatio) throws FaceException

Exceptions

> FaceException
> An error has occurred during Face Library execution.

Swift

    public var cropEyePositionRatio: Float
        get {
            return try! getCropEyePositionRatio()
        }
    }

Exceptions

> FaceException
> An error has occurred during Face Library execution.

C

    int id3FacePortraitProcessor_GetCropEyePositionRatio (ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor, float * cropEyePositionRatio)
    int id3FacePortraitProcessor_SetCropEyePositionRatio (ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor, float cropEyePositionRatio)

Returns

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