Configuration¶

IDLive Face parameters can be edited via the API by calling the static methods of the FaceSDK/Settings class before creating the pipeline:

facesdk::FaceSDK::setEnableFaceOcclusionDetection(false);

FaceSDK.setEnableFaceOcclusionDetection(False)

Settings.setEnableFaceOcclusionDetection(false);

Settings.SetEnableFaceOcclusionDetection(false);

These parameters can also be set via the environment variables:

FACESDK_ENABLE_FACE_OCCLUSION_DETECTION=0 ./application

Some additional IDLive Face parameters can be adjusted by editing configuration files.

API parameters¶

Face occlusion detection ¶

setEnableFaceOcclusionDetection() / FACESDK_ENABLE_FACE_OCCLUSION_DETECTION

Controls whether to validate if a face is not occluded. If it is occluded the FACE_IS_OCCLUDED error will be thrown. Allowed values are 0 (disabled) and 1 (enabled). Enabled by default.

Closed eyes detection ¶

setEnableClosedEyesDetection() / FACESDK_ENABLE_CLOSED_EYES_DETECTION

Controls whether to validate if eyes on a face were not closed. If they were closed the EYES_CLOSED error will be thrown. Allowed values are 0 (disabled) and 1 (enabled). Disabled by default.

Configuration files¶

It is possible to change internal parameters used to validate the image. Lower values will lead to less images being rejected, but the accuracy might degrade for such images.

The parameters are defined in data/preprocessing/face_params.conf file.

Available parameters:

• min_face_size – Minimal width and height of the face box, in pixels.

• min_face_size_relative – Minimal relative width and height of the face box, as a ratio of the face's width and height to the image's width and height. Defined as a value between 0 and 1. For example, if the value is 0.25, one side of the face box should be at least a quarter of the image's corresponding side.

• detectable_face_size_relative – Similar to the parameter above, but if the size of the face box is smaller than the value, the face is just being skipped. It is used as a filter for small faces in the background.

• min_pupillary_distance – Minimal distance between the pupils on the face, in pixels.

• min_face_padding – Minimal distance from the image's border to the face box, in pixels.

• max_roll – Max roll angle of the head, in degrees.

• max_yaw – Max yaw angle of the head, in degrees.

• max_pitch – Max pitch angle of the head, in degrees.

Default values¶