fsdk::IFaceOcclusionEstimator Struct Reference

FaceOcclusion estimator interface. More...

#include <IFaceOcclusionEstimator.h>

Inheritance diagram for fsdk::IFaceOcclusionEstimator:

Public Member Functions
virtual ResultValue< FSDKError, FaceOcclusionEstimation >	estimate (const Image &warp, const Landmarks5 &landmarks5) const noexcept=0
	Checks whether persons face is occluded or not.
virtual Result< FSDKError >	estimate (Span< const Image > warps, Span< const Landmarks5 > landmarks, Span< FaceOcclusionEstimation > faceOcclusionEstimations) const noexcept=0
	This structure is used to check for occlusions in various parts of the face (such as the lower face, nose, eyes, or forehead) across multiple warped images in a single estimate function call.
virtual Result< FSDKError >	validate (Span< const Image > warps, Span< const Landmarks5 > landmarks, 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

FaceOcclusion estimator interface.

Note

This estimator is designed to work with a person face image;

Member Function Documentation

estimate() [1/2]

virtual ResultValue< FSDKError, FaceOcclusionEstimation > fsdk::IFaceOcclusionEstimator::estimate ( const Image & warp, const Landmarks5 & landmarks5 ) const

pure virtualnoexcept

Checks whether persons face is occluded or not.

Parameters

[in]

warp

image with warped face;

See also

IWarper for details.

Parameters

[in]

Landmarks

warped Landmarks.

Returns

ResultValue with error code and output enum value inside.

See also

FaceOcclusionEstimation, IWarper, Landmarks5, Image, ResultValue and FSDKError for details.

Note

warp format must be R8G8B8,

See also

Format.

estimate() [2/2]

virtual Result< FSDKError > fsdk::IFaceOcclusionEstimator::estimate ( Span< const Image > warps, Span< const Landmarks5 > landmarks, Span< FaceOcclusionEstimation > faceOcclusionEstimations ) const

pure virtualnoexcept

This structure is used to check for occlusions in various parts of the face (such as the lower face, nose, eyes, or forehead) across multiple warped images in a single estimate function call.

Parameters

[in]	warps	span of images with warped faces.
[in]	landmarks	span of warped landmarks.
[out]	faceOcclusionEstimations	output FaceOcclusionEstimation span.

Returns

Result with error code.

See also

Span, FaceOcclusionEstimation, IWarper, Image, Landmarks5, 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::IFaceOcclusionEstimator::validate ( Span< const Image > warps, Span< const Landmarks5 > landmarks, 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]	landmarks	span of landmarks.
[out]	errors	output span of errors for each image.

Returns

Result with error code.

See also

Span, IWarper, Image, Landmarks5, 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/IFaceOcclusionEstimator.h