fsdk::IEyeEstimator Struct Reference

Eye estimator interface. More...

#include <IEyeEstimator.h>

Inheritance diagram for fsdk::IEyeEstimator:

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.
Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t	retain () noexcept=0
	Increase strong reference count.
virtual int32_t	retainLocked () noexcept=0
	Increase strong reference count thread safely.
virtual int32_t	release () noexcept=0
	Decrease strong reference count.
virtual int32_t	getRefCount () const noexcept=0
	Get actual strong reference count.
virtual int32_t	retainWeak () noexcept=0
	Increase weak reference count.
virtual int32_t	releaseWeak () noexcept=0
	Decrease weak reference count.
virtual int32_t	getWeakRefCount () const noexcept=0
	Get actual weak reference count.

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

estimate() [1/2]

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

pure virtualnoexcept

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.

estimate() [2/2]

virtual Result< FSDKError > fsdk::IEyeEstimator::estimate ( Span< const Image > warps, Span< const EyeCropper::EyesRects > eyeRects, Span< EyesEstimation > eyesEstimations ) const

pure virtualnoexcept

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.

validate()

virtual Result< FSDKError > fsdk::IEyeEstimator::validate ( Span< const Image > warps, Span< const EyeCropper::EyesRects > eyeRects, Span< Result< FSDKError > > errors ) const

pure virtualnoexcept

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:

• fsdk.framework/Headers/Estimators/IEyeEstimator.h