Face Engine SDK  5.3.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
fsdk::ILivenessFlyingFacesEstimator Struct Referenceabstract

Flying Faces Liveness estimator interface. More...

#include <ILivenessFlyingFacesEstimator.h>

Inheritance diagram for fsdk::ILivenessFlyingFacesEstimator:
fsdk::IRefCounted

Public Member Functions

virtual Result< FSDKErrorestimate (const Image &image, const Detection &detection, LivenessFlyingFacesEstimation &estimation) const noexcept=0
 Helps to check if person is real or not. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > images, Span< const Detection > detections, Span< LivenessFlyingFacesEstimation > estimations) const noexcept=0
 Helps to check if persons are real or not. More...
 
virtual Result< FSDKErrorvalidate (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 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

Flying Faces Liveness estimator interface.

Note
This estimator is designed for liveness detection.

Member Function Documentation

virtual Result<FSDKError> fsdk::ILivenessFlyingFacesEstimator::estimate ( const Image image,
const Detection detection,
LivenessFlyingFacesEstimation estimation 
) const
pure virtualnoexcept

Helps to check if person is real or not.

Parameters
[in]imagesource image with R8G8B8 format
[in]detectiondetection to proceed.
[out]scoreestimation score;
Returns
Error code
See Also
FSDKError for details
Note
estimation score normalized between 0.0 and 1.0, where 1.0 equals to 100% confidence that person is real, and 0.0 equals to 0%.
virtual Result<FSDKError> fsdk::ILivenessFlyingFacesEstimator::estimate ( Span< const Image images,
Span< const Detection detections,
Span< LivenessFlyingFacesEstimation estimations 
) const
pure virtualnoexcept

Helps to check if persons are real or not.

Parameters
[in]imagesSpan of Image, format of images must be R8G8B8
[in]detectionsSpan of Detection.
[out]scoresspan of estimations,
See Also
;
Returns
Error code
See Also
FSDKError for details
Note
estimation score normalized between 0.0 and 1.0, where 1.0 equals to 100% confidence that person on image is alive, and 0.0 equals to 0%.
all spans should be based on user owned continuous collections.
all spans should be equal size.
virtual Result<FSDKError> fsdk::ILivenessFlyingFacesEstimator::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 input images.
[in]detectionsspan of detection coords of corresponding source images.
[out]errorsoutput span of errors for each image.
Returns
Error code;
See Also
FSDKError for details.
Note
all spans should be based on user owned continuous collections.

The documentation for this struct was generated from the following file: