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

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

Head pose angles estimator interface. More...

`#include <IHeadPoseEstimator.h>`

Inheritance diagram for fsdk::IHeadPoseEstimator:

## Public Member Functions
virtual Result< FSDKError > | estimate (const Landmarks68 &landmarks, HeadPoseEstimation &out) const noexcept=0
| Estimate the angles. More...
virtual Result< FSDKError > | estimate (const Image &image, const Detection &detection, HeadPoseEstimation &out) const noexcept=0
| Estimate the angles. More...
virtual Result< FSDKError > | estimate (Span< const Image > images, Span< const Detection > detections, Span< HeadPoseEstimation > out) const noexcept=0
| Estimate headpose angles of multiple frames in a single estimate function call. More...
virtual Result< FSDKError > | validate (Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0
| Validate input of multiple frames in a single function call. 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

Head pose angles estimator interface.

Note
  This estimator is designed to work with 68 facial landmarks or with raw image data;

See also
  IDetector for details.

Estimated angles are:

- pitch;
- yaw;
- roll.
  See also
    HeadPoseEstimation structure for details about how exactly the estimations are reported.

## Member Function Documentation

## ◆ estimate() [1/3]

virtual Result<FSDKError> fsdk::IHeadPoseEstimator::estimate | ( | const Landmarks68 & | landmarks,
|  | HeadPoseEstimation & | out
| ) |  | const
| pure virtual noexcept

Estimate the angles.

Parameters

  [in] | landmarks | Landmarks68 structure.
  [out] | out | output estimation.

Returns
  Result with error code.

See also
  Landmarks, HeadPoseEstimation, Result and FSDKError for details.

## ◆ estimate() [2/3]

virtual Result<FSDKError> fsdk::IHeadPoseEstimator::estimate | ( | const Image & | image,
|  | const Detection & | detection,
|  | HeadPoseEstimation & | out
| ) |  | const
| pure virtual noexcept

Estimate the angles.

Parameters

  [in] | image | source image.
  [in] | detection | detection coordinates in image space.
  [out] | out | output estimation.

Returns
  Result with error code.

See also
  HeadPoseEstimation, Detection, Image, Result and FSDKError for details.

Note
  image format must be R8G8B8,

See also
  Format.

## ◆ estimate() [3/3]

virtual Result<FSDKError> fsdk::IHeadPoseEstimator::estimate | ( | Span< const Image > | images,
|  | Span< const Detection > | detections,
|  | Span< HeadPoseEstimation > | out
| ) |  | const
| pure virtual noexcept

Estimate headpose angles of multiple frames in a single estimate function call.

Parameters

  [in] | images | span of source images.
  [in] | detections | span of detection coordinates in corresponding source images space.
  [out] | out | estimations array of corresponding images.

Returns
  Result with error code.

See also
  Span, HeadPoseEstimation, Detection, Image, Result and FSDKError for details.

Note
  images 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::IHeadPoseEstimator::validate | ( | Span< const Image > | images,
|  | Span< const Detection > | detections,
|  | Span< Result< FSDKError >> | errors
| ) |  | const
| pure virtual noexcept

Validate input of multiple frames in a single function call.

Parameters

  [in] | images | span of source images.
  [in] | detections | span of detection coordinates in corresponding source images space.
  [out] | errors | output span of errors for each image.

Returns
  Result with error code.

See also
  Span, Detection, Image, Result and FSDKError for details.

Note
  images 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/IHeadPoseEstimator.h