DetectedFace

interface DetectedFace

Detected face.

Functions

Link copied to clipboard

Create an ICAO full frontal image of the face. If boundaries of the normalized image leak outside of the original image, a white background is applied. This operation should be called on background thread.

Link copied to clipboard
abstract fun createTemplate(): Template

Create the face template which can be used for matching. This method requires dot-face-verification module. This operation should be called on a background thread.

Link copied to clipboard

Evaluation of face aspects. This operation should be called on background thread.

Link copied to clipboard

Evaluation of all available face quality attributes. If an attribute requires a module which is not activated, it is not evaluated and null is returned. If you need only one or a specific set of attributes, use .evaluateFaceQuality method for better performance. This operation should be called on background thread.

abstract fun evaluateFaceQuality(faceQualityQuery: FaceQualityQuery): FaceQuality

Evaluation of specific set of face quality attributes. This is the recommended way for face quality evaluation due to performance reasons. If an attribute in the query requires a module which is not activated, exception is thrown. This operation should be called on background thread.

Link copied to clipboard

Evaluation of passive liveness. This method requires dot-face-passive-liveness module. This operation should be called on background thread.

Link copied to clipboard
abstract fun getConfidence(): Double

The confidence score of the face detection. It also represents the quality of the detected face.

Properties

Link copied to clipboard
abstract val image: BgrRawImage

Full size (camera preview) image.