Face Engine SDK  5.8.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
fsdk::IHumanAttributeEstimator Struct Referenceabstract

HumanAttribute estimator interface. More...

#include <IHumanAttributeEstimator.h>

Inheritance diagram for fsdk::IHumanAttributeEstimator:
fsdk::IRefCounted

Public Member Functions

virtual Result< FSDKErrorestimate (const Image &humanWarp, HumanAttributeRequest request, HumanAttributeResult &result) const noexcept=0
 Estimate human body attributes. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > humanWarps, HumanAttributeRequest request, Span< HumanAttributeResult > results) const noexcept=0
 Estimate human body attributes. More...
 
virtual Result< FSDKErrorvalidate (Span< const Image > humanWarps, HumanAttributeRequest request, Span< Result< FSDKError >> errors) const noexcept=0
 Validate input of multiple frames in a single function call. More...
 
virtual Result< FSDKErroraggregate (Span< const HumanAttributeResult > estimations, HumanAttributeRequest request, HumanAttributeResult &result) const noexcept=0
 Aggregate human body attributes. More...
 
- Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t retain () noexcept=0
 Increase strong reference count. More...
 
virtual int32_t retainLocked () noexcept=0
 Increase strong reference count thread safely. 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

HumanAttribute estimator interface.

Note
Estimator predicts human body attributes.

Member Function Documentation

virtual Result<FSDKError> fsdk::IHumanAttributeEstimator::aggregate ( Span< const HumanAttributeResult estimations,
HumanAttributeRequest  request,
HumanAttributeResult result 
) const
pure virtualnoexcept

Aggregate human body attributes.

All invalid fields will be skipped and do not influence on aggregation result

Parameters
[in]estimationsspan of estimation results.
[in]requestestimation request.
[out]resultaggregated result.
Returns
Result with error code.
See Also
Span, HumanAttributeResult, IHumanAttributeEstimator::EstimationRequest, Result and FSDKError for details.
Note
all spans should be based on user owned continuous collections.
all spans should be equal size.
virtual Result<FSDKError> fsdk::IHumanAttributeEstimator::estimate ( const Image humanWarp,
HumanAttributeRequest  request,
HumanAttributeResult result 
) const
pure virtualnoexcept

Estimate human body attributes.

Parameters
[in]humanWarpimage with warped human body.
[in]requestestimation request.
[out]resultestimation results.
Returns
Result with error code.
See Also
HumanAttributeResult, IHumanAttributeEstimator::EstimationRequest, Image, Result and FSDKError for details.
Note
warp format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::IHumanAttributeEstimator::estimate ( Span< const Image humanWarps,
HumanAttributeRequest  request,
Span< HumanAttributeResult results 
) const
pure virtualnoexcept

Estimate human body attributes.

Parameters
[in]humanWarpsspan of images with warped human bodies.
[in]requestestimation request.
[out]resultsspan of estimation results.
Returns
Result with error code.
See Also
Span, HumanAttributeResult, IHumanAttributeEstimator::EstimationRequest, Image, Result and FSDKError for details.
Note
warps format must be R8G8B8,
See Also
Format.
Note
all spans should be based on user owned continuous collections.
all spans should be equal size.
virtual Result<FSDKError> fsdk::IHumanAttributeEstimator::validate ( Span< const Image humanWarps,
HumanAttributeRequest  request,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

Validate input of multiple frames in a single function call.

Parameters
[in]imagesspan of images with warped faces.
[in]requestestimation request.
[out]errorsspan of errors for each image.
Returns
Result with error code.
See Also
Span, IHumanAttributeEstimator::EstimationRequest, Image, Result and FSDKError for details.
Note
warps format must be R8G8B8,
See Also
Format.
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: