fsdk::IHeadPoseEstimator Struct Reference

Head pose angles estimator interface. More...

#include <IHeadPoseEstimator.h>

Inheritance diagram for fsdk::IHeadPoseEstimator:

List of all members.

Public Member Functions
virtual Result< FSDKError >	estimate (const Image &image, const Detection &detection, HeadPoseEstimation &out) const noexcept=0
	Estimate the angles.
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.
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.

---

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 Image &	image,
		const Detection &	detection,
		HeadPoseEstimation &	out
	)		const [pure virtual]

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.

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

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.

virtual Result<FSDKError> fsdk::IHeadPoseEstimator::validate	(	Span< const Image >	images,
		Span< const Detection >	detections,
		Span< Result< FSDKError >>	errors
	)		const [pure virtual]

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