Estimators

Estimators public interfaces and related types and structures. More...

Classes
struct	fsdk::IAGSEstimator
	Approximate Garbage Score estimator interface. More...
struct	fsdk::IBestShotQualityEstimator
	BestShotQuality estimator interface. More...
struct	fsdk::DepthLivenessEstimation
	Depth estimator output structure. More...
struct	fsdk::IDepthLivenessEstimator
	Depth estimator interface. More...
struct	fsdk::EyesEstimation
	Eyes estimation output. More...
struct	fsdk::EyeCropper
	EyeCropper is a helper structure for IEyeEstimator interface Methods of this structure crop an input warped image and returns rectangle coordinates of each eye. More...
struct	fsdk::IEyeEstimator
	Eye estimator interface. More...
struct	fsdk::GazeEstimation
	Gaze estimation output. More...
struct	fsdk::IGazeEstimator
	Gaze estimator interface. More...
struct	fsdk::IGlassesEstimator
	Glasses estimator interface. More...
struct	fsdk::HeadPoseEstimation
	Head pose estimation output. More...
struct	fsdk::IHeadPoseEstimator
	Head pose angles estimator interface. More...
struct	fsdk::DepthRGBEstimation
	Depth+RBG liveness estimation output structure. More...
struct	fsdk::ILivenessDepthRGBEstimator
	Depth+RGB estimator interface. More...
struct	fsdk::LivenessOneShotRGBEstimation
	Liveness OneShotRGB estimation structure. More...
struct	fsdk::ILivenessOneShotRGBEstimator
	OneShot RGB Liveness estimator interface. More...
struct	fsdk::MedicalMaskEstimation
	MedicalMask estimator output structure. This structure contains the result of estimation (. More...
struct	fsdk::MedicalMaskEstimationExtended
	MedicalMask estimator output structure. This structure contains the result of estimation (. More...
struct	fsdk::IMedicalMaskEstimator
	MedicalMask estimator interface. More...
struct	fsdk::SmileTypeScores
	Scores of smile type. Probability scores are defined in [0,1] range. Scores in this struct sum up to 1.0. We use them to decide if person is smiling with teeth's exposed or not. More...
struct	fsdk::MouthEstimation
	Mouth estimator output structure. Stores flags that indicates which mouth feature is present. Multiple state flags may be set to true meaning that the final mouth state is a combination of those. Probability scores are defined in [0,1] range. More...
struct	fsdk::MouthEstimationExtended
	Extended mouth estimator output structure. Stores flags that indicates which mouth feature is present. Multiple state flags may be set to true meaning that the final mouth state is a combination of those. Probability scores are defined in [0,1] range. More...
struct	fsdk::IMouthEstimator
	Mouth estimator interface. More...
struct	fsdk::NIRLivenessEstimation
	NIR Liveness estimation structure. Each score in normalized [0, 1] range, state shows real person or not. More...
struct	fsdk::INIRLivenessEstimator
	Infra red liveness estimator interface. More...
struct	fsdk::Quality
	Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: More...
struct	fsdk::SubjectiveQuality
	Subjective Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings: More...
struct	fsdk::IQualityEstimator
	Image quality estimator interface. More...

Enumerations
enum class	fsdk::GlassesEstimation : uint8_t { fsdk::GlassesEstimation::NoGlasses , fsdk::GlassesEstimation::EyeGlasses , fsdk::GlassesEstimation::SunGlasses , fsdk::GlassesEstimation::EstimationError }
	Glasses estimation enum. More...
enum class	fsdk::MedicalMask { fsdk::MedicalMask::Mask = 0 , fsdk::MedicalMask::NoMask , fsdk::MedicalMask::OccludedFace }
	MedicalMask estimator output enum. This enum contains all possible estimation results. More...
enum class	fsdk::MedicalMaskExtended { fsdk::MedicalMaskExtended::Mask = 0 , fsdk::MedicalMaskExtended::NoMask , fsdk::MedicalMaskExtended::MaskNotInPlace , fsdk::MedicalMaskExtended::OccludedFace }
	MedicalMask estimator output enum. This enum contains all possible extended estimation results. More...
enum class	fsdk::DetailedMaskType {   fsdk::DetailedMaskType::CorrectMask = 0 , fsdk::DetailedMaskType::MouthCoveredWithMask , fsdk::DetailedMaskType::ClearFace , fsdk::DetailedMaskType::ClearFaceWithMaskUnderChin ,   fsdk::DetailedMaskType::PartlyCoveredFace , fsdk::DetailedMaskType::FullMask , Count }
	MedicalMask estimator output enum. This enum contains all type of DetailedMaskType results. More...
enum class	fsdk::SmileType { fsdk::SmileType::None , fsdk::SmileType::SmileLips , fsdk::SmileType::SmileOpen }
	MouthEstimationExtended smile type enum. This enum contains all possible smile types. More...
enum class	fsdk::NIRLivenessMode { Default , M1 , M2 }
	NIRLiveness estimation mode. Currently, available values to select the estimation mode are: Default, M1 and M2. The scenario Default means the mode is specified in config file. More...

Functions
IBestShotQualityEstimator::EstimationRequest	fsdk::operator| (IBestShotQualityEstimator::EstimationRequest first, IBestShotQualityEstimator::EstimationRequest second)
FrontalFaceType	fsdk::HeadPoseEstimation::getFrontalFaceType () const
	Returns type of face frontality.
float	fsdk::MedicalMaskEstimation::getScore (DetailedMaskType type) const
	Returns score of required detailed mask type.
float	fsdk::Quality::getQuality () const noexcept
bool	fsdk::SubjectiveQuality::isGood () const noexcept

Detailed Description

Estimators public interfaces and related types and structures.

Enumeration Type Documentation

DetailedMaskType

enum class fsdk::DetailedMaskType

strong

MedicalMask estimator output enum. This enum contains all type of DetailedMaskType results.

Enumerator
CorrectMask	correct mask on the face (mouth and nose are covered correctly)
MouthCoveredWithMask	mask covers only a mouth
ClearFace	clear face - no mask on the face
ClearFaceWithMaskUnderChin	face with a mask around a chin, not covering anything from mouth to eyes
PartlyCoveredFace	face is covered with not a medical mask or a full mask
FullMask	face is covered with a full mask (such as balaclava, sky mask, etc.)

GlassesEstimation

enum class fsdk::GlassesEstimation : uint8_t

strong

Glasses estimation enum.

• noglasses: checks whether person is wearing glasses or not. true - no glasses, false - with glasses;
• eyeglasses: checks whether person is wearing eyeglasses or not. true - eyeglasses, false - not eyeglasses;
• sunglasses: checks whether person is wearing sunglasses or not. true - sunglasses, false - not sunglasses.

Enumerator
NoGlasses	Person is not wearing glasses.
EyeGlasses	Person is wearing eyeglasses.
SunGlasses	Person is wearing sunglasses.
EstimationError	failed to estimate

MedicalMask

enum class fsdk::MedicalMask

strong

MedicalMask estimator output enum. This enum contains all possible estimation results.

Enumerator
Mask	medical mask is on the face
NoMask	no medical mask on the face
OccludedFace	face is occluded by something

MedicalMaskExtended

enum class fsdk::MedicalMaskExtended

strong

MedicalMask estimator output enum. This enum contains all possible extended estimation results.

Enumerator
Mask	medical mask is on the face
NoMask	no medical mask on the face
MaskNotInPlace	mask is not on the right place
OccludedFace	face is occluded by something

NIRLivenessMode

enum class fsdk::NIRLivenessMode

strong

NIRLiveness estimation mode. Currently, available values to select the estimation mode are: Default, M1 and M2. The scenario Default means the mode is specified in config file.

See also

ISettingsProvider.

SmileType

enum class fsdk::SmileType

strong

MouthEstimationExtended smile type enum. This enum contains all possible smile types.

Enumerator
None	No smile.
SmileLips	regular smile, without teeth's exposed
SmileOpen	smile with teeth's exposed

Function Documentation

getQuality()

float fsdk::Quality::getQuality ( ) const

inlinenoexcept

Returns

complex estimation of quality (minimin of flor estimations). 0 - low quality, 1 - high quality.

getScore()

float fsdk::MedicalMaskEstimation::getScore ( DetailedMaskType type ) const

inline

Returns score of required detailed mask type.

Parameters

[in]

type

detailed mask type.

See also

DetailedMaskType for more info.

isGood()

bool fsdk::SubjectiveQuality::isGood ( ) const

inlinenoexcept

Returns

if all boolean flags are false returns true - high quality, else false - low quality.