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

RGBM Liveness estimator interface. More...

#include <ILivenessRGBMEstimator.h>

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

Public Member Functions

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

RGBM Liveness estimator interface.

Note
This estimator is designed for liveness detection.

Member Function Documentation

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

Check if detection corresponds to person alive or not.

Parameters
[in]imagesource image.
[in]detectiondetection coordinates in image space.
[in]backgroundbackground for the track.
[in,out]estimationestimation structure
Returns
Result with error code.
See Also
LivenessRGBMEstimation, Detection, Image, Result and FSDKError for details.
Note
images format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::ILivenessRGBMEstimator::estimate ( Span< const Image images,
Span< const Detection detections,
Span< const Image backgrounds,
Span< LivenessRGBMEstimation estimation 
) const
pure virtualnoexcept

Check if detections correspond to alive persons.

Parameters
[in]imagesspan of source images, one image per stream
[in]detectionsspan of detection coordinates in image space.
[in]backgroundsspan of backgrounds.
[in,out]estimationspan of estimation results
Returns
Result with error code.
See Also
Span, LivenessRGBMEstimation, 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.
virtual Result<FSDKError> fsdk::ILivenessRGBMEstimator::update ( const Image image,
uint32_t  iFrame,
Image background 
) const
pure virtualnoexcept

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

Parameters
[in]imagesource image.
[in]iFramecurrent frame number.
[in,out]backgroundcurrent background. It will be updated by this call. Memory residence (host/gpu) of background image can be changed because of internal implementation.
Returns
Result with error code.
See Also
Image, Result and FSDKError for details.
Note
image format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::ILivenessRGBMEstimator::update ( fsdk::Span< const Image images,
fsdk::Span< const uint32_t >  iFrames,
fsdk::Span< Image backgrounds 
) const
pure virtualnoexcept

Prepare backgrounds. Pass here every frame from each stream to extract stream backgrounds.

Parameters
[in]imagesspan of source images.
[in]iFramesspan of current frame numbers.
[in,out]backgroundsspan of current background images. The images will be updated by this call. Memory residence (host/gpu) of background images can be changed because of internal implementation.
Returns
Result with error code.
See Also
Span, Image, Result and FSDKError for details.
Note
image 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: