PortraitProcessor.cropPortrait Method

Module: PortraitProcessor

Definition

Creates a portrait image by cropping the source image around the detected face.

Python

crop_portrait(self, portrait: Portrait) -> Image

Parameters

portrait Portrait

in The portrait to extract the face from.

Returns

Image

The output cropped image of the face.

Exceptions

FaceException

An error has occurred during Face Library execution.

Dart

Image cropPortrait(Portrait portrait)

Parameters

portrait Portrait

in The portrait to extract the face from.

Returns

Image

The output cropped image of the face.

Exceptions

FaceException

An error has occurred during Face Library execution.

C#

public Image CropPortrait(Portrait portrait)

Parameters

portrait Portrait

in The portrait to extract the face from.

Returns

Image

The output cropped image of the face.

Exceptions

FaceException

An error has occurred during Face Library execution.

Java

public Image cropPortrait(Portrait portrait) throws FaceException

Parameters

portrait Portrait

in The portrait to extract the face from.

Returns

Image

The output cropped image of the face.

Exceptions

FaceException

An error has occurred during Face Library execution.

Swift

public func cropPortrait(portrait: Portrait) throws -> Image

Parameters

portrait Portrait

in The portrait to extract the face from.

Returns

Image

The output cropped image of the face.

Exceptions

FaceException

An error has occurred during Face Library execution.

C

int id3FacePortraitProcessor_CropPortrait (
    ID3_FACE_PORTRAIT_PROCESSOR hPortraitProcessor,
    ID3_FACE_PORTRAIT hPortrait,
    ID3_FACE_IMAGE hImage)

Parameters

hPortraitProcessor ID3_FACE_PORTRAIT_PROCESSOR

in Handle to the PortraitProcessor object.

hPortrait ID3_FACE_PORTRAIT

in The portrait to extract the face from.

hImage ID3_FACE_IMAGE

out The output cropped image of the face.

Returns

int

An error code.

See id3FaceError file for the list of possible error codes.