FaceDetector::Config Class Reference

Face detector configuration. More...

#include <FaceDetector.h>

Collaboration diagram for FaceDetector::Config:

Public Types
enum class	Type : uint8_t { ACCURATE , BALANCED , FAST , ACCURATE_SERVER }
	Type of neural network detector. More...

Public Member Functions
void	SetDetector (Type value)
	Function sets type of detector.
Type	GetDetector () const
	Function gets detection type.
void	SetMaxDetectionSize (float value)
	Function sets max detection size.
float	GetMaxDetectionSize () const
	Function gets max detection size.
void	SetMinDetectionSize (float value)
	Function sets min detection size.
float	GetMinDetectionSize () const
	Function gets min detection size.
void	WriteTo (Writer &writer) const final
	Function serializes configuration via provided Writer.
	Config ()=default
	Creates Default configuration.

Static Public Member Functions
static Config	Default ()
	Provides default Config.

Detailed Description

Face detector configuration.

It is input for detection.

Member Enumeration Documentation

Type

enum class Type : uint8_t

strong

Type of neural network detector.

Enumerator
ACCURATE	Neural network face detector and facial features detector with very high accuracy. It is slower than balanced mode. Required Solvers Total size of solvers is 27 MB. References face-detector-accurate.solver, face-detector-landmarks-mob-0.50.solver, face-detector-eye-validation.solver
BALANCED	Neural network face detector and facial features detector with good accuracy. It is slower than fast mode. Required Solvers Total size of solvers is 14 MB. References face-detector-accurate.solver, face-detector-landmarks-mob-0.25.solver, face-detector-eye-validation.solver
FAST	The fastest face detector in combination with the fastest face validators and facial features detectors are used when fast mode is used. Some faces that are partially occluded faces or faces with sunglasses may be missed. However the speed performance of the face detection is much better as when other modes are used. Required Solvers Total size of solvers is 559 kB. References face-detector-fast.solver, face-detector-eye-validation.solver, face-detector-landmarks-fast.solver
ACCURATE_SERVER	Note Not supported in this variant of Enrollment SDK.

Constructor & Destructor Documentation

Config()

Config ( )

default

Creates Default configuration.

The default configuration is:

• type - BALANCED
• min detection size - 0.05
• max detection size - 0.95

References BALANCED, and Config().

Referenced by Config(), and Default().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

Default()

Config Default ( )

inlinestatic

Provides default Config.

The default configuration is:

• type - BALANCED
• min detection size - 0.05
• max detection size - 0.95

Returns

default config

References Config().

Here is the call graph for this function:

GetDetector()

Type GetDetector ( ) const

inlinenodiscard

Function gets detection type.

Returns

detection type

GetMaxDetectionSize()

float GetMaxDetectionSize ( ) const

inlinenodiscard

Function gets max detection size.

Returns

max detection size.

GetMinDetectionSize()

float GetMinDetectionSize ( ) const

inlinenodiscard

Function gets min detection size.

Returns

min detection size.

SetDetector()

void SetDetector ( Type value )

inline

Function sets type of detector.

Parameters

value

type from Config::Type.

SetMaxDetectionSize()

void SetMaxDetectionSize ( float value )

inline

Function sets max detection size.

It specifies maximal valid size of face which is detectable in current detection mode. Face size is given by maximum of eyes distance and eyes to mouth distance in image.

Parameters

value

In case of (0., 1> range, the value is taken with respect to maximum of image dimensions. Otherwise it is considered as size in pixels.

SetMinDetectionSize()

void SetMinDetectionSize ( float value )

inline

Function sets min detection size.

It specifies minimal valid size of face which is detectable in current detection mode. Face size is given by maximum of eyes distance and eyes to mouth distance in image.

Parameters

value

In case of (0., 1> range, the value is taken with respect to maximum of image dimensions. Otherwise it is considered as size in pixels.

WriteTo()

void WriteTo ( Writer & writer ) const

inlinefinalvirtual

Function serializes configuration via provided Writer.

Parameters

writer

used to serialize Config.

Implements Serializable.

---

The documentation for this class was generated from the following file:

• Face/FaceDetector.h