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::ILivenessOneShotRGBEstimator Struct Referenceabstract

OneShot RGB Liveness estimator interface. More...

#include <ILivenessOneShotRGBEstimator.h>

Inheritance diagram for fsdk::ILivenessOneShotRGBEstimator:
fsdk::IRefCounted

Public Member Functions

virtual fsdk::Result
< fsdk::FSDKError
estimate (const fsdk::Image &image, const fsdk::Detection &detection, const fsdk::Landmarks5 &landmarks5, fsdk::LivenessOneShotRGBEstimation &estimation, const float qualityThreshold=-1.f) const noexcept=0
 OneShot RGB Liveness estimation. More...
 
virtual fsdk::Result
< fsdk::FSDKError
estimate (fsdk::Span< const fsdk::Image > images, fsdk::Span< const fsdk::Detection > detections, fsdk::Span< const fsdk::Landmarks5 > landmarks5, fsdk::Span< fsdk::LivenessOneShotRGBEstimation > estimations, const float qualityThreshold=-1.f, fsdk::LivenessOneShotRGBEstimation *aggregation=nullptr) const noexcept=0
 OneShot RGB Liveness estimation. More...
 
virtual Result< FSDKErrorvalidate (fsdk::Span< const fsdk::Image > images, fsdk::Span< const fsdk::Detection > detections, Span< const Landmarks5 > landmarks5, 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

OneShot RGB Liveness estimator interface.

Note
This estimator is designed for liveness detection.

Member Function Documentation

virtual fsdk::Result<fsdk::FSDKError> fsdk::ILivenessOneShotRGBEstimator::estimate ( const fsdk::Image image,
const fsdk::Detection detection,
const fsdk::Landmarks5 landmarks5,
fsdk::LivenessOneShotRGBEstimation estimation,
const float  qualityThreshold = -1.f 
) const
pure virtualnoexcept

OneShot RGB Liveness estimation.

Parameters
[in]imageinput image. Format must be R8G8B8;
[in]detectiondetection in the input image space;
[in]landmarks5Landmarks5 for the detection;
[out]estimationestimation results.
See Also
LivenessOneShotRGBEstimation
Parameters
[in]qualityThresholdquality threshold;
Returns
Error code
See Also
FSDKError for details.
virtual fsdk::Result<fsdk::FSDKError> fsdk::ILivenessOneShotRGBEstimator::estimate ( fsdk::Span< const fsdk::Image images,
fsdk::Span< const fsdk::Detection detections,
fsdk::Span< const fsdk::Landmarks5 landmarks5,
fsdk::Span< fsdk::LivenessOneShotRGBEstimation estimations,
const float  qualityThreshold = -1.f,
fsdk::LivenessOneShotRGBEstimation aggregation = nullptr 
) const
pure virtualnoexcept

OneShot RGB Liveness estimation.

Parameters
[in]imagesSpan of images, format of images must be R8G8B8;
[in]detectionsSpan of Detection;
[in]landmarks5Span of Landmarks5;
[out]estimationsspan of estimations,
See Also
LivenessOneShotRGBEstimation;
Parameters
[in]qualityThresholdquality threshold;
[out]aggregationaggregated value based on estimations;
Returns
Error code
See Also
FSDKError for details
Note
all spans should be based on user owned continuous collections.
all spans should be equal size.
virtual Result<FSDKError> fsdk::ILivenessOneShotRGBEstimator::validate ( fsdk::Span< const fsdk::Image images,
fsdk::Span< const fsdk::Detection detections,
Span< const Landmarks5 landmarks5,
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.
[in]landmarks5span of landmarks
[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: