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

# PortraitProcessor.cropIodRatio Property

Module: PortraitProcessor

Type: float

## Definition

Ratio between the interocular distance (IOD) and the image width for ICAO portrait cropping. Must be in the range ]0;1[.

Hint

Default value is 0.25.

Python

    crop_iod_ratio: float

Exceptions

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

Dart

    double get cropIodRatio => getCropIodRatio();
    set cropIodRatio(double value) => setCropIodRatio(value);

Exceptions

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

C#

    public float cropIodRatio
    {
        get => GetcropIodRatio();
        set => SetcropIodRatio(ref value);
    }

Exceptions

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

Java

    public float getCropIodRatio() throws FaceException
    public void setCropIodRatio(float cropIodRatio) throws FaceException

Exceptions

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

Swift

    public var cropIodRatio: Float
        get {
            return try! getCropIodRatio()
        }
    }

Exceptions

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

C

    int id3FacePortraitProcessor_GetCropIodRatio (ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor, float * cropIodRatio)
    int id3FacePortraitProcessor_SetCropIodRatio (ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor, float cropIodRatio)

Returns

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