| Face Engine SDK 5.34.0 A face detection, recognition and tracking engine.

Public Member Functions | List of all members
fsdk::IHumanAttributeEstimator Struct Referenceabstract
Estimators

HumanAttribute estimator interface. More...

`#include <IHumanAttributeEstimator.h>`

Inheritance diagram for fsdk::IHumanAttributeEstimator:

## Public Member Functions
virtual Result< FSDKError > | estimate (const Image &humanWarp, HumanAttributeRequest request, HumanAttributeResult &result) const noexcept=0
| Estimate human body attributes. More...
virtual Result< FSDKError > | estimate (Span< const Image > humanWarps, HumanAttributeRequest request, Span< HumanAttributeResult > results) const noexcept=0
| Estimate human body attributes. More...
virtual Result< FSDKError > | validate (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< FSDKError > | aggregate (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

## ◆ aggregate()

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

Aggregate human body attributes.

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

Parameters

  [in] | estimations | span of estimation results.
  [in] | request | estimation request.
  [out] | result | aggregated 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.

## ◆ estimate() [1/2]

virtual Result<FSDKError> fsdk::IHumanAttributeEstimator::estimate | ( | const Image & | humanWarp,
|  | HumanAttributeRequest | request,
|  | HumanAttributeResult & | result
| ) |  | const
| pure virtual noexcept

Estimate human body attributes.

Parameters

  [in] | humanWarp | image with warped human body.
  [in] | request | estimation request.
  [out] | result | estimation 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.

## ◆ estimate() [2/2]

virtual Result<FSDKError> fsdk::IHumanAttributeEstimator::estimate | ( | Span< const Image > | humanWarps,
|  | HumanAttributeRequest | request,
|  | Span< HumanAttributeResult > | results
| ) |  | const
| pure virtual noexcept

Estimate human body attributes.

Parameters

  [in] | humanWarps | span of images with warped human bodies.
  [in] | request | estimation request.
  [out] | results | span 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.

## ◆ validate()

virtual Result<FSDKError> fsdk::IHumanAttributeEstimator::validate | ( | Span< const Image > | humanWarps,
|  | HumanAttributeRequest | request,
|  | Span< Result< FSDKError >> | errors
| ) |  | const
| pure virtual noexcept

Validate input of multiple frames in a single function call.

Parameters

  [in] | images | span of images with warped faces.
  [in] | request | estimation request.
  [out] | errors | span 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:

- include/fsdk/Estimators/IHumanAttributeEstimator.h