net.idrnd.facesdk

Class Settings

java.lang.Object

net.idrnd.facesdk.Settings

public class Settings
extends java.lang.Object

Provides a way to control global FaceSDK configuration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Settings.ThreadingLevel FaceSDK threading level, used to set different number of threads for different levels

Constructor Summary

Constructors

Constructor and Description
Settings()

Method Summary

Modifier and Type	Method and Description
static void	setEnableClosedEyesDetection(boolean enabled) Toggles closed eyes detection.
static void	setEnableFaceOcclusionDetection(boolean enabled) Toggles face occlusion detection.
static void	setEnableLogging(boolean enableLogging) Sets whether to enable FaceSDK logging.
static void	setNumThreads(int numThreads, Settings.ThreadingLevel threadingLevel) Sets the maximum number of threads available for FaceSDK at the specified level.
static void	setOvBindThreads(boolean ovBindThreads) Sets the CPU bind setting for OpenVINO backend.
static void	setOvMaxBatchSize(int ovMaxBatchSize) Sets the maximum batch size for OpenVINO backend.
static void	setOvNumThroughputStreams(int ovNumThroughputStreams) Sets the number of CPU execution streams for OpenVINO backend.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Settings

public Settings()

Method Detail

setNumThreads

public static void setNumThreads(int numThreads,
                                 Settings.ThreadingLevel threadingLevel)

Sets the maximum number of threads available for FaceSDK at the specified level. If 0 is passed, then the optimal number of threads is detected automatically (the same effect is achieved if setNumThreads is not called). Function call is equivalent to setting FACESDK_NUM_THREADS_PIPELINE, FACESDK_NUM_THREADS_ENGINE or FACESDK_NUM_THREADS_OPERATOR environment variable before loading FaceSDK library. Function call takes precedence over environment variables.

Parameters:

numThreads - Maximum number of threads available for FaceSDK at the specified level

threadingLevel - Threading level to apply setting

setOvNumThroughputStreams

public static void setOvNumThroughputStreams(int ovNumThroughputStreams)

Sets the number of CPU execution streams for OpenVINO backend. Function call is equivalent to setting FACESDK_OV_NUM_THROUGHPUT_STREAMS environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.

Parameters:

ovNumThroughputStreams - Number of CPU execution streams, valid values are -1 (auto-tune number of streams), 0 (use the default setting) and any positive value, other values are dropped without an error

setOvBindThreads

public static void setOvBindThreads(boolean ovBindThreads)

Sets the CPU bind setting for OpenVINO backend. Function call is equivalent to setting FACESDK_OV_BIND_THREADS environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.

Parameters:

ovBindThreads - Whether to bind execution threads to CPU physical cores or not

setOvMaxBatchSize

public static void setOvMaxBatchSize(int ovMaxBatchSize)

Sets the maximum batch size for OpenVINO backend. This is not a hard limit (i.e. passing batches bigger than the limit will not cause an error), however setting this value to the target batch size will increase performance. Function call is equivalent to setting FACESDK_OV_BIND_THREADS environment variable before loading FaceSDK library. Function call takes precedence over environment variables. Function does not take effect if FaceSDK build does not use OpenVINO.

Parameters:

ovMaxBatchSize - Max batch size

setEnableLogging

public static void setEnableLogging(boolean enableLogging)

Sets whether to enable FaceSDK logging. Logging is enabled by default. Function call is equivalent to setting FACESDK_ENABLE_LOGGING environment variable before loading FaceSDK library. Function call takes precedence over environment variables.

Parameters:

enableLogging - Whether to enable logging or not

setEnableFaceOcclusionDetection

public static void setEnableFaceOcclusionDetection(boolean enabled)

Toggles face occlusion detection. When enabled the occluded faces will be rejected.

Function call is equivalent to setting FACESDK_ENABLE_FACE_OCCLUSION_DETECTION environment variable before loading FaceSDK library. Function call takes precedence over environment variables.

Parameters:

enabled - Whether to enable the detection or not

setEnableClosedEyesDetection

public static void setEnableClosedEyesDetection(boolean enabled)

Toggles closed eyes detection. When enabled the faces with closed eyes will be rejected.

Function call is equivalent to setting FACESDK_ENABLE_CLOSED_EYES_DETECTION environment variable before loading FaceSDK library. Function call takes precedence over environment variables.

Parameters:

enabled - Whether to enable the detection or not