| Face Engine SDK 4.9.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 fsdk::Image &image, const fsdk::Detection &detection, HeadPoseEstimation &out) const noexcept=0
| Estimate the angles. More...
virtual Result< FSDKError > | estimate (const fsdk::Image images[], const fsdk::Detection detections[], const uint32_t batchSize, HeadPoseEstimation out[]) const noexcept=0
| Estimate headpose angles 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

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;

See also
  AngleEstimation.

Returns
  Error code;

See also
  FSDKError for details.

## ◆ estimate() [2/3]

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

Estimate the angles.

Parameters

  [in] | source | image in RGB format.
  [in] | detection | fsdk::Detection structure of corresponding source image.
  [out] | out | output estimation;

See also
  HeadPoseEstimation.

Returns
  Error code;

See also
  FSDKError for details.

## ◆ estimate() [3/3]

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

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

Parameters

  [in] | images | array of source images in RGB format.
  [in] | detections | fsdk::Detection array of corresponding images.
  [in] | batchSize | length of images and detections array
  [out] | out | estimations array of corresponding images;

See also
  HeadPoseEstimation.

Returns
  Error code;

See also
  FSDKError for details.

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

- include/fsdk/Estimators/IHeadPoseEstimator.h