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

Classes
struct	fsdk::IAGSEstimator
	Approximate Garbage Score estimator interface. More...

struct	fsdk::BackgroundEstimation
	Background estimator output structure. This structure contains the result of estimation and probability scores for each possible estimation result. Probability scores are defined in [0,1] range. More...

struct	fsdk::IBackgroundEstimator
	Background estimator interface. More...

struct	fsdk::IBestShotQualityEstimator
	BestShotQuality estimator interface. More...

struct	fsdk::ImageColorEstimation
	Image color type estimator interface. More...

struct	fsdk::IBlackWhiteEstimator

struct	fsdk::ChildEstimation
	Child estimation output. More...

struct	fsdk::IChildEstimator
	Child estimator interface. More...

struct	fsdk::CredibilityCheckEstimation
	CredibilityCheck estimator output structure. More...

struct	fsdk::ICredibilityCheckEstimator
	CredibilityCheck estimator interface. More...

struct	fsdk::CrowdEstimation
	Crowd estimation structure. More...

struct	fsdk::ICrowdEstimator
	Crowd estimator interface. More...

struct	fsdk::DynamicRangeEstimation
	DynamicRange estimator output structure. This structure contains score for possible estimation result. Probability score is defined in [0,1] range. More...

struct	fsdk::IDynamicRangeEstimator
	DynamicRange estimator interface. More...

struct	fsdk::EmotionsEstimation
	Emotions estimation structure. Each estimation is given in normalized [0, 1] range. More...

struct	fsdk::IEmotionsEstimator
	Emotions estimator interface. More...

struct	fsdk::IEthnicityEstimator

struct	fsdk::EyeBrowEstimation
	EyeBrow estimation structure. More...

struct	fsdk::IEyeBrowEstimator
	EyeBrow 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::FacialHairEstimation
	FacialHair estimator output structure. This structure contains the result of estimation (. More...

struct	fsdk::IFacialHairEstimator
	FacialHair estimator interface. More...

struct	fsdk::FishEyeEstimation
	FishEye estimator output structure. This structure contains the result of estimation (. More...

struct	fsdk::IFishEyeEstimator
	FishEye 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::IHeadAndShouldersLivenessEstimator
	Head And Shoulders estimator interface. More...

struct	fsdk::HeadPoseEstimation
	Head pose estimation output. More...

struct	fsdk::IHeadPoseEstimator
	Head pose angles estimator interface. More...

struct	fsdk::HeadWearStateEstimation
	HeadWearState estimator output structure. This structure contains the result of estimation (. More...

struct	fsdk::HeadWearTypeEstimation
	HeadWearType estimator output structure. This structure contains the result of estimation (. More...

struct	fsdk::HeadWearEstimation
	HeadWear estimator output structure. This structure contains the result of HeadWearState and HeadWearType estimations. More...

struct	fsdk::IHeadWearEstimator
	HeadWear estimator interface. More...

struct	fsdk::HumanAttributeResult
	Unified HumanAttribute estimator output structure. More...

struct	fsdk::IHumanAttributeEstimator
	HumanAttribute estimator interface. More...

struct	fsdk::DepthRange
	Depth range configuration structure in millimeters. More...

struct	fsdk::DepthEstimation
	Depth estimator output structure. More...

struct	fsdk::ILivenessDepthEstimator
	Depth estimator interface. More...

struct	fsdk::ILivenessFlowEstimator
	Liveness flow estimator interface. More...

struct	fsdk::LivenessFlyingFacesEstimation
	Liveness Flying Faces estimation output. More...

struct	fsdk::ILivenessFlyingFacesEstimator
	Flying Faces Liveness estimator interface. More...

struct	fsdk::LivenessFPREstimation
	Liveness FPR estimation output. More...

struct	fsdk::ILivenessFPREstimator
	FPR Liveness estimator interface. More...

struct	fsdk::IREstimation
	IR estimation structure. Each score in normalized [0, 1] range, isReal shows real person or not. More...

struct	fsdk::ILivenessIREstimator
	Infra red liveness estimator interface. More...

struct	fsdk::LivenessOneShotRGBEstimation
	Liveness OneShotRGB estimation structure. More...

struct	fsdk::ILivenessOneShotRGBEstimator
	OneShot RGB Liveness estimator interface. More...

struct	fsdk::LivenessRGBMEstimation
	LivenessRGBM estimation structure. More...

struct	fsdk::ILivenessRGBMEstimator
	RGBM 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::NaturalLightEstimation
	NaturalLight estimator output structure. This structure contains the result of estimation and probability scores for each possible estimation result. Probability scores are defined in [0,1] range. More...

struct	fsdk::INaturalLightEstimator
	NaturalLight estimator interface. More...

struct	fsdk::IOrientationEstimator
	Image orientation estimator interface. More...

struct	fsdk::OverlapEstimation
	Face overlap estimation output. More...

struct	fsdk::IOverlapEstimator
	Overlap estimator interface. More...

struct	fsdk::PortraitStyleEstimation
	PortraitStyle estimator output structure. This structure contains the result of estimation and probability scores for each possible estimation result. Probability scores are defined in [0,1] range. More...

struct	fsdk::IPortraitStyleEstimator
	PortraitStyle estimator interface. More...

struct	fsdk::OnePPEEstimation
	Personal Protection Equipment estimation structure (a.k.a. PPE) This structure contains prediction scores per each personal equipment attribute. More...

struct	fsdk::PPEEstimation
	Personal Protection Equipment output structure. This structure aggregates multiple PPE attributes predictions. More...

struct	fsdk::IPPEEstimator
	Personal Protection Equipment 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...

struct	fsdk::RedEyeEstimation
	Red eye estimation output. More...

struct	fsdk::IRedEyeEstimator
	Red eye estimator interface. More...

Typedefs
using	fsdk::PPEState = OnePPEEstimation::PPEState

Enumerations
enum	fsdk::BackgroundStatus : uint8_t { fsdk::BackgroundStatus::NonSolid = 0, fsdk::BackgroundStatus::Solid = 1 }
	Background estimator output enum. This enum contains all possible estimation results. More...

enum	fsdk::CredibilityStatus : uint8_t { fsdk::CredibilityStatus::Reliable = 1, fsdk::CredibilityStatus::NonReliable = 2 }
	CredibilityCheck estimator output enum. This enum contains all possible estimation results. More...

enum	fsdk::CrowdEstimatorType { fsdk::CET_DEFAULT = 0, fsdk::CET_SINGLE_NET = 1, fsdk::CET_TWO_NETS = 2, CET_COUNT }
	CrowdEstimator type enumeration. More...

enum	fsdk::FacialHair { fsdk::FacialHair::NoHair = 0, fsdk::FacialHair::Stubble, fsdk::FacialHair::Mustache, fsdk::FacialHair::Beard }
	FacialHair estimator output enum. This enum contains all possible estimation results. More...

enum	fsdk::FishEye { fsdk::FishEye::NoFishEyeEffect = 0, fsdk::FishEye::FishEyeEffect = 1 }
	FishEye estimator output enum. This enum contains all possible estimation results. More...

enum	fsdk::GlassesEstimation : uint8_t { fsdk::GlassesEstimation::NoGlasses, fsdk::GlassesEstimation::EyeGlasses, fsdk::GlassesEstimation::SunGlasses, fsdk::GlassesEstimation::EstimationError }
	Glasses estimation enum. More...

enum	fsdk::HeadWearState { Yes = 0, No, Count }
	HeadWearState estimator output enum. This enum contains all possible estimation results.

enum	fsdk::HeadWearType : uint8_t { NoHeadWear = 0, BaseballCap, Beanie, PeakedCap, Shawl, HatWithEarFlaps, Helmet, Hood, Hat, Other, Count }
	HeadWearType estimator output enum. This enum contains all possible estimation results.

enum	fsdk::HumanAttributeRequest { fsdk::HumanAttributeRequest::EstimateAge = 1 << 0, fsdk::HumanAttributeRequest::EstimateGender = 1 << 1, fsdk::HumanAttributeRequest::EstimateSleeveSize = 1 << 2, fsdk::HumanAttributeRequest::EstimateBackpack = 1 << 3, fsdk::HumanAttributeRequest::EstimateOutwearColor = 1 << 4, fsdk::HumanAttributeRequest::EstimateHeadwear = 1 << 5, fsdk::HumanAttributeRequest::EstimateLowerBodyClothing = 1 << 7, fsdk::HumanAttributeRequest::EstimateShoeColor = 1 << 8, fsdk::HumanAttributeRequest::EstimateAll = 0xffff }
	HumanAttributeRequest lists all possible estimation attributes that HumanAttributeEstimator is currently able to estimate. More...

enum	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	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	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	fsdk::SmileType { fsdk::SmileType::None, fsdk::SmileType::SmileLips, fsdk::SmileType::SmileOpen }
	MouthEstimationExtended smile type enum. This enum contains all possible smile types. More...

enum	fsdk::LightStatus : uint8_t { fsdk::LightStatus::NonNatural = 0, fsdk::LightStatus::Natural = 1 }
	NaturalLight estimator output enum. This enum contains all possible estimation results. More...

enum	fsdk::PortraitStyleStatus : uint8_t { fsdk::PortraitStyleStatus::NonPortrait = 0, fsdk::PortraitStyleStatus::Portrait = 1, fsdk::PortraitStyleStatus::HiddenShoulders = 2 }
	PortraitStyle estimator output enum. This enum contains all possible estimation results. More...

enum	fsdk::RedEyeStatus : uint8_t { fsdk::RedEyeStatus::NonRed, fsdk::RedEyeStatus::Red }
	Enumeration of possible red eye statuses. More...

Functions
IBestShotQualityEstimator::EstimationRequest	fsdk::operator\| (IBestShotQualityEstimator::EstimationRequest first, IBestShotQualityEstimator::EstimationRequest second)

HumanAttributeRequest	fsdk::operator\| (HumanAttributeRequest lhs, HumanAttributeRequest rhs)

bool	fsdk::operator& (HumanAttributeRequest lhs, HumanAttributeRequest rhs)

Emotions	fsdk::EmotionsEstimation::getPredominantEmotion () const
	Returns emotion with greatest score.

float	fsdk::EmotionsEstimation::getEmotionScore (Emotions emotion) const
	Returns score of required emotion. More...

float	fsdk::IEthnicityEstimator::EstimationResult::getEthnicityScore (Ethnicities ethnicity) const
	the result ethnicity

FrontalFaceType	fsdk::HeadPoseEstimation::getFrontalFaceType () const
	Returns type of face frontality.

float	fsdk::HeadWearStateEstimation::getScore (HeadWearState state) const
	Returns score of required headwear state. More...

float	fsdk::HeadWearTypeEstimation::getScore (HeadWearType type) const
	Returns score of required headwear type. More...

float	fsdk::HumanAttributeResult::OutwearColorEstimation::getScore (Color color) const
	Returns score of required outwear color. More...

float	fsdk::HumanAttributeResult::ApparentColorEstimation::getScore (ApparentColor color) const
	Returns score of required color. More...

float	fsdk::MedicalMaskEstimation::getScore (DetailedMaskType type) const
	Returns score of required detailed mask type. More...

PPEState	fsdk::OnePPEEstimation::getPredominantState ()
	returns predominant personal equipment state

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

enum fsdk::BackgroundStatus : uint8_t

strong

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

Enumerator
NonSolid	NonSolid.
Solid	Solid.

enum fsdk::CredibilityStatus : uint8_t

strong

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

Enumerator
Reliable	person is reliable
NonReliable	person is not reliable

enum fsdk::CrowdEstimatorType

CrowdEstimator type enumeration.

Enumerator

CET_DEFAULT

Default type which is specified in config file.

See Also: ISettingsProvider.

CET_SINGLE_NET

Single network mode - only Crowd estimation will be used.

CET_TWO_NETS

Double network mode - Crowd + HeadDetector.

enum 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	clear face with a mask around of a chin, mask does not cover anything in the face region (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.)

enum fsdk::FacialHair

strong

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

Enumerator
NoHair	no hair on the face
Stubble	stubble on the face
Mustache	mustache on the face
Beard	beard on the face

enum fsdk::FishEye

strong

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

Enumerator
NoFishEyeEffect	no fish eye effect
FishEyeEffect	with fish eye effect

enum 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

enum fsdk::HumanAttributeRequest

strong

HumanAttributeRequest lists all possible estimation attributes that HumanAttributeEstimator is currently able to estimate.

Enumerator
EstimateAge	estimate age
EstimateGender	estimate gender
EstimateSleeveSize	estimate sleeves size
EstimateBackpack	estimate backpack state
EstimateOutwearColor	estimate outwear color
EstimateHeadwear	estimate headwear state
EstimateLowerBodyClothing	estimate lower body clothing state
EstimateShoeColor	estimate shoe color
EstimateAll	estimate all attributes

enum fsdk::LightStatus : uint8_t

strong

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

Enumerator
NonNatural	light is not natural
Natural	light is natural

enum 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

enum 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

enum fsdk::PortraitStyleStatus : uint8_t

strong

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

Enumerator
NonPortrait	NonPortrait.
Portrait	Portrait.
HiddenShoulders	HiddenShoulders.

enum fsdk::RedEyeStatus : uint8_t

strong

Enumeration of possible red eye statuses.

Enumerator
NonRed	Eye is not red.
Red	Eye is red.

enum 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

float fsdk::EmotionsEstimation::getEmotionScore ( Emotions emotion ) const

inline

Returns score of required emotion.

Parameters

[in] emotion emotion

See Also: Emotions for details.

float fsdk::Quality::getQuality ( ) const

inlinenoexcept

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

float fsdk::HeadWearStateEstimation::getScore ( HeadWearState state ) const

inline

Returns score of required headwear state.

Parameters

[in] state headwear state.

See Also: HeadWearState for more info.

float fsdk::HumanAttributeResult::OutwearColorEstimation::getScore ( HumanAttributeResult::Color color ) const

inline

Returns score of required outwear color.

Parameters

[in] color outwear color.

See Also: Color for more info.

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.

float fsdk::HeadWearTypeEstimation::getScore ( HeadWearType type ) const

inline

Returns score of required headwear type.

Parameters

[in] type headwear type.

See Also: HeadWearType for more info.

float fsdk::HumanAttributeResult::ApparentColorEstimation::getScore ( HumanAttributeResult::ApparentColor color ) const

inline

Returns score of required color.

Parameters

[in] color color.

See Also: ApparentColor for more info.

bool fsdk::SubjectiveQuality::isGood ( ) const

inlinenoexcept

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

Classes

Typedefs

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation