FaceAnalyser.segmentBackground Method

Module: FaceAnalyser

Definition

Computes face segmentation mask for background removal.

Important

This methods requires the FaceBackgroundSegmenter model to be loaded.

Python

segment_background(self, image: Image) -> Image

Parameters

image Image

in Source image to process.

Returns

Image

The mask of segmented face.

Exceptions

FaceException

An error has occurred during Face Library execution.

Dart

Image segmentBackground(Image image)

Parameters

image Image

in Source image to process.

Returns

Image

The mask of segmented face.

Exceptions

FaceException

An error has occurred during Face Library execution.

C#

public Image SegmentBackground(Image image)

Parameters

image Image

in Source image to process.

Returns

Image

The mask of segmented face.

Exceptions

FaceException

An error has occurred during Face Library execution.

Java

public Image segmentBackground(Image image) throws FaceException

Parameters

image Image

in Source image to process.

Returns

Image

The mask of segmented face.

Exceptions

FaceException

An error has occurred during Face Library execution.

Swift

public func segmentBackground(image: Image) throws -> Image

Parameters

image Image

in Source image to process.

Returns

Image

The mask of segmented face.

Exceptions

FaceException

An error has occurred during Face Library execution.

C

int id3FaceAnalyser_SegmentBackground (
    ID3_FACE_ANALYSER hFaceAnalyser,
    ID3_FACE_IMAGE hImage,
    ID3_FACE_IMAGE hSegmentationMask)

Parameters

hFaceAnalyser ID3_FACE_ANALYSER

in Handle to the FaceAnalyser object.

hImage ID3_FACE_IMAGE

in Source image to process.

hSegmentationMask ID3_FACE_IMAGE

out The mask of segmented face.

Returns

int

An error code.

See id3FaceError file for the list of possible error codes.