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

Head pose angles estimator interface. More...

#include <IHeadPoseEstimator.h>

Inheritance diagram for fsdk::IHeadPoseEstimator:
fsdk::IRefCounted

Public Member Functions

virtual Result< FSDKErrorestimate (const Landmarks68 &landmarks, HeadPoseEstimation &out) const noexcept=0
 Estimate the angles. More...
 
virtual Result< FSDKErrorestimate (const Image &image, const Detection &detection, HeadPoseEstimation &out) const noexcept=0
 Estimate the angles. More...
 
virtual Result< FSDKErrorestimate (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< FSDKErrorvalidate (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 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

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

Estimate the angles.

Parameters
[in]landmarksLandmarks68 structure.
[out]outoutput estimation;
See Also
AngleEstimation.
Returns
Error code;
See Also
FSDKError for details.
virtual Result<FSDKError> fsdk::IHeadPoseEstimator::estimate ( const Image image,
const Detection detection,
HeadPoseEstimation out 
) const
pure virtualnoexcept

Estimate the angles.

Parameters
[in]sourceimage in RGB format.
[in]detectionfsdk::Detection structure of corresponding source image.
[out]outoutput estimation;
See Also
HeadPoseEstimation.
Returns
Error code;
See Also
FSDKError for details.
virtual Result<FSDKError> fsdk::IHeadPoseEstimator::estimate ( Span< const Image images,
Span< const Detection detections,
Span< HeadPoseEstimation out 
) const
pure virtualnoexcept

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

Parameters
[in]imagesarray of source images in RGB format.
[in]detectionsfsdk::Detection array of corresponding images.
[out]outestimations array of corresponding images;
See Also
HeadPoseEstimation.
Returns
Error code;
See Also
FSDKError for details.
virtual Result<FSDKError> fsdk::IHeadPoseEstimator::validate ( Span< const Image images,
Span< const Detection detections,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

Validate input of multiple frames in a single function call.

Parameters
[in]imagesspan of input images.
[in]detectionsspan of detection coords of corresponding source images.
[out]errorsoutput span of errors for each image.
Returns
Error code;
See Also
FSDKError for details.
Note
all spans should be based on user owned continuous collections.

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