Face Engine SDK  4.6.0
A face detection, recognition and tracking engine.
fsdk::IAttributeEstimator Struct Referenceabstract

Face image attribute estimator interface. More...

#include <IAttributeEstimator.h>

Inheritance diagram for fsdk::IAttributeEstimator:
fsdk::IRefCounted

Classes

struct  EstimationResult
 Unified Attribute Estimator output structure. More...
 

Public Types

enum  EstimationRequest { estimateAge = 1 << 0, estimateGender = 1 << 1, estimateEthnicity = 1 << 2, estimateAll = 0xffff }
 EstimationRequest lists all possible estimation attributes that AttributeEstimator is currently able to estimate. More...
 

Public Member Functions

virtual Result< FSDKErrorestimate (const Image &warp, const IAttributeEstimator::EstimationRequest request, IAttributeEstimator::EstimationResult &out) const noexcept=0
 Estimate unified attributes. More...
 
virtual ResultValue< FSDKError, IAttributeEstimator::EstimationResultestimate (const Span< const Image > warps, const IAttributeEstimator::EstimationRequest request, Span< IAttributeEstimator::EstimationResult > results) const noexcept=0
 Estimate unified attributes of multiple frames in a single estimate function call. More...
 
- Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t retain () noexcept=0
 Increase strong reference count. More...
 
virtual int32_t release () noexcept=0
 Decrease strong reference count. More...
 
virtual int32_t getRefCount () const noexcept=0
 Get actual strong reference count. More...
 
virtual int32_t retainWeak () noexcept=0
 Increase weak reference count. More...
 
virtual int32_t releaseWeak () noexcept=0
 Decrease weak reference count. More...
 
virtual int32_t getWeakRefCount () const noexcept=0
 Get actual weak reference count. More...
 

Detailed Description

Face image attribute estimator interface.

Note
This estimator is designed to work with a person face image; you should pass a warped face detection image.
See also
IWarper for details.

Optional estimated attributes are:

Member Enumeration Documentation

◆ EstimationRequest

EstimationRequest lists all possible estimation attributes that AttributeEstimator is currently able to estimate.

Enumerator
estimateAge 

Estimate age.

estimateGender 

Estimate gender.

estimateEthnicity 

Estimate Ethnicity.

estimateAll 

Make full estimation (all attributes)

Member Function Documentation

◆ estimate() [1/2]

virtual Result<FSDKError> fsdk::IAttributeEstimator::estimate ( const Image warp,
const IAttributeEstimator::EstimationRequest  request,
IAttributeEstimator::EstimationResult out 
) const
pure virtualnoexcept

Estimate unified attributes.

Parameters
[in]warpwith warped face; format must be R8G8B8.
[in]requestEstimationRequest structure;
See also
EstimationRequests for more details.
Parameters
[out]outoutput estimation;
See also
IAttributeEstimator::EstimationResult.
Returns
Error code;
See also
FSDKError for details.

◆ estimate() [2/2]

virtual ResultValue<FSDKError, IAttributeEstimator::EstimationResult> fsdk::IAttributeEstimator::estimate ( const Span< const Image warps,
const IAttributeEstimator::EstimationRequest  request,
Span< IAttributeEstimator::EstimationResult results 
) const
pure virtualnoexcept

Estimate unified attributes of multiple frames in a single estimate function call.

Parameters
[in]warpswarps span; format must be R8G8B8.
[in]requestEstimationRequest structure.
[out]resultsspan of estimations.
Returns
Error code and aggregative estimations result for all warps;
See also
FSDKError for details.
IAttributeEstimator::EstimationResult, IAttributeEstimator::EstimationRequest and Span for more info.
Note
all spans should be based on user owned continuous collections.
all spans should be equal size

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