Face Engine SDK  5.8.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 retainLocked () noexcept=0
 Increase strong reference count thread safely. 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.
[in]detectiondetection coordinates in image space.
[out]estimationestimation score;
Returns
Result with error code.
See Also
LivenessFlyingFacesEstimation, Detection, Image, Result and 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%.
image format must be R8G8B8,
See Also
Format.
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 source images.
[in]detectionsspan of detection coordinates in corresponding source images space.
[out]estimationsspan of estimations.
Returns
Result with error code.
See Also
LivenessFlyingFacesEstimation, Span, Detection, Image, Result and 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%.
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::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 source images.
[in]detectionsspan of detection coordinates in corresponding source images space.
[out]errorsoutput 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: