fsdk::IEyeEstimator Struct Reference

Eye estimator interface. More...

#include <IEyeEstimator.h>

Inheritance diagram for fsdk::IEyeEstimator:

List of all members.

Public Member Functions
virtual Result< FSDKError >	estimate (const Image &warp, const EyeCropper::EyesRects &eyeRects, EyesEstimation &eyesEstimation) const noexcept=0
	Estimate the attributes.
virtual Result< FSDKError >	estimate (Span< const Image > warps, Span< const EyeCropper::EyesRects > eyeRects, Span< EyesEstimation > eyesEstimations) const noexcept=0
	Estimate the attributes of multiple warped images in a single estimate function call.
virtual Result< FSDKError >	validate (Span< const Image > warps, Span< const EyeCropper::EyesRects > eyeRects, Span< Result< FSDKError >> errors) const noexcept=0
	Validate input of multiple frames in a single function call.

---

Detailed Description

Eye estimator interface.

Note:

This estimator is designed to work with a person face image; you should pass a warped face detection image.

See also:

IWarper for details. Eye estimator detects:

• eyes state;
• landmarks describing iris.

EyesEstimation for output details

---

Member Function Documentation

virtual Result<FSDKError> fsdk::IEyeEstimator::estimate	(	const Image &	warp,
		const EyeCropper::EyesRects &	eyeRects,
		EyesEstimation &	eyesEstimation
	)		const [pure virtual]

Estimate the attributes.

Parameters:

[in]	warp	image with warped face.
[in]	eyeRects	EyeCropper::EyesRects structure with valid rectangle coordinates of each eye.
[out]	eyesEstimation	Estimation of both eyes. Iris and Eyelid output landmarks are in warpedImage coordinates. If you want them in source of warpedImage image coordinates, use IWarper::unwarp

See also:

IWarper::unwarp.

Returns:

Result with error code.

See also:

EyesEstimation, EyeCropper::EyesRects, Image, Result and FSDKError for details.

Note:

warp 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::IEyeEstimator::estimate	(	Span< const Image >	warps,
		Span< const EyeCropper::EyesRects >	eyeRects,
		Span< EyesEstimation >	eyesEstimations
	)		const [pure virtual]

Estimate the attributes of multiple warped images in a single estimate function call.

Parameters:

[in]	warps	span of images with warped faces.
[in]	eyeRects	span of EyesRects structure of corresponding warped image with valid rectangle coordinates of each eye.
[out]	eyesEstimations	span of EyesEstimation of corresponding warped images. Iris and Eyelid output landmarks are in warpedImage coordinates. If you want them in source of warpedImage image coordinates, use IWarper::unwarp

See also:

IWarper::unwarp.

Returns:

Result with error code.

See also:

Span, EyesEstimation, EyeCropper::EyesRects, Image, Result and FSDKError for details.

Note:

warps 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::IEyeEstimator::validate	(	Span< const Image >	warps,
		Span< const EyeCropper::EyesRects >	eyeRects,
		Span< Result< FSDKError >>	errors
	)		const [pure virtual]

Validate input of multiple frames in a single function call.

Parameters:

[in]	warps	span of images with warped faces.
[in]	eyeRects	span of EyesRects structure of corresponding warped image with valid rectangle coordinates of each eye.
[out]	errors	output span of errors for each image.

Returns:

Result with error code.

See also:

Span, EyeCropper::EyesRects, Image, Result and FSDKError for details.

Note:

warps 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/IEyeEstimator.h