Face Engine SDK  4.6.0
A face detection, recognition and tracking engine.
fsdk::ILivenessFPREstimator Struct Referenceabstract

FPR Liveness estimator interface. More...

#include <ILivenessFPREstimator.h>

Inheritance diagram for fsdk::ILivenessFPREstimator:
fsdk::IRefCounted

Public Member Functions

virtual fsdk::Result< fsdk::FSDKErrorestimate (const fsdk::Face &face, bool useJpegCompression, LivenessFPREstimation &estimation) const noexcept=0
 Helps to check if person is real or not. More...
 
virtual fsdk::Image getCompressedWarp () const =0
 
virtual void setCompressedWarp (const fsdk::Image &warp) const =0
 
virtual void clearCompessedWarp () const =0
 
- 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

FPR Liveness estimator interface.

Note
This estimator is designed for liveness detection.

Member Function Documentation

◆ estimate()

virtual fsdk::Result<fsdk::FSDKError> fsdk::ILivenessFPREstimator::estimate ( const fsdk::Face face,
bool  useJpegCompression,
LivenessFPREstimation estimation 
) const
pure virtualnoexcept

Helps to check if person is real or not.

Parameters
[in]facestructure with detection and image, these fields should be valid,
See also
fsdk::Face and fsdk::Detection;
Parameters
[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%.

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