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

# FaceAnalyser.detectFaceMask Method

Module: FaceAnalyser

## Definition

Detects the presence of a face mask on a detected face.

A high score means that there is a high chance that the person is wearing a mask.

The minimum recommended threshold is 15.

Important

Loading the `FaceMaskClassifier`, model is required to use this function.

Python

    detect_face_mask(self, image: Image, detected_face: DetectedFace) -> int

Parameters

> `image` Image
> in Source image to process.
> `detected_face` DetectedFace
> in Detected face to process.

Returns

> `int`
> The face mask presence score of the detected face.

Exceptions

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

Dart

    int detectFaceMask(Image image, DetectedFace detectedFace)

Parameters

> `image` Image
> in Source image to process.
> `detectedFace` DetectedFace
> in Detected face to process.

Returns

> `int`
> The face mask presence score of the detected face.

Exceptions

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

C#

    public int DetectFaceMask(Image image, DetectedFace detectedFace)

Parameters

> `image` Image
> in Source image to process.
> `detectedFace` DetectedFace
> in Detected face to process.

Returns

> `int`
> The face mask presence score of the detected face.

Exceptions

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

Java

    public int detectFaceMask(Image image, DetectedFace detectedFace) throws FaceException

Parameters

> `image` Image
> in Source image to process.
> `detectedFace` DetectedFace
> in Detected face to process.

Returns

> `int`
> The face mask presence score of the detected face.

Exceptions

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

Swift

    public func detectFaceMask(image: Image, detectedFace: DetectedFace) throws -> Int32

Parameters

> `image` Image
> in Source image to process.
> `detectedFace` DetectedFace
> in Detected face to process.

Returns

> `Int`
> The face mask presence score of the detected face.

Exceptions

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

C

    int id3FaceAnalyser_DetectFaceMask (
        ID3_FACE_ANALYSER hFaceAnalyser,
        ID3_FACE_IMAGE hImage,
        ID3_DETECTED_FACE hDetectedFace,
        int * score)

Parameters

> `hFaceAnalyser` ID3_FACE_ANALYSER
> in Handle to the FaceAnalyser object.
> `hImage` ID3_FACE_IMAGE
> in Source image to process.
> `hDetectedFace` ID3_DETECTED_FACE
> in Detected face to process.
> `score` int *
> out The face mask presence score of the detected face.

Returns

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