Face Engine SDK  5.17.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | List of all members
fsdk::IHeadPoseEstimator Struct Referenceabstract
Estimators

Head pose angles estimator interface. More...

#include <IHeadPoseEstimator.h>

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

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

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

Estimate the angles.

Parameters
[in]landmarksLandmarks68 structure.
[out]outoutput estimation.
Returns
Result with error code.
See Also
Landmarks, HeadPoseEstimation, Result and 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]imagesource image.
[in]detectiondetection coordinates in image space.
[out]outoutput 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.
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]imagesspan of source images.
[in]detectionsspan of detection coordinates in corresponding source images space.
[out]outestimations 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.
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 source images.
[in]detectionsspan of detection coordinates in corresponding source images space.
[out]errorsoutput 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: