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

RGBM Liveness estimator interface. More...

#include <ILivenessRGBMEstimator.h>

Inheritance diagram for fsdk::ILivenessRGBMEstimator:
fsdk::IRefCounted

Public Member Functions

virtual fsdk::Result< fsdk::FSDKErrorupdate (const fsdk::Image &image, uint32_t iFrame, fsdk::Image &background) const noexcept=0
 Prepare background method. Pass here every frame from the stream to extract background. More...
 
virtual fsdk::Result< fsdk::FSDKErrorestimate (const fsdk::Image &image, const fsdk::Detection &detection, const fsdk::Image &background, fsdk::LivenessRGBMEstimation &estimation) const noexcept=0
 Check if detection corresponds to person alive or not. 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

RGBM Liveness estimator interface.

Note
This estimator is designed for liveness detection.

Member Function Documentation

◆ estimate()

virtual fsdk::Result<fsdk::FSDKError> fsdk::ILivenessRGBMEstimator::estimate ( const fsdk::Image image,
const fsdk::Detection detection,
const fsdk::Image background,
fsdk::LivenessRGBMEstimation estimation 
) const
pure virtualnoexcept

Check if detection corresponds to person alive or not.

Parameters
[in]currentframe with person.
[in]facedetection on the frame.
[in]fixedbackground for the track.
[in/out]LivenessRGBMEstimation estimation structure
Returns
Error code
See also
FSDKError for details.
LivenessRGBMEstimation for details.

◆ update()

virtual fsdk::Result<fsdk::FSDKError> fsdk::ILivenessRGBMEstimator::update ( const fsdk::Image image,
uint32_t  iFrame,
fsdk::Image background 
) const
pure virtualnoexcept

Prepare background method. Pass here every frame from the stream to extract background.

Parameters
[in]imagecurrent frame. Format must be R8G8B8.
[in]iFramecurrent frame number.
[int/out]background current background. It will be updated by this call.
Returns
Error code
See also
FSDKError for details.

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