| Face Engine SDK 5.2.0 A face detection, recognition and tracking engine.

- Main Page
- Modules
- Namespaces
- Classes
- Files

- File List
- File Members

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
ILivenessOneShotRGBEstimator.h
1 #pragma once
2
3 #include <fsdk/IObject.h>
4 #include <fsdk/FSDKError.h>
5 #include <fsdk/Optional.h>
6 #include <fsdk/Types.h>
7
8 namespace fsdk {
9
10 #ifndef DOXYGEN_SHOULD_SKIP_THIS
11 DECLARE_SMARTPTR(ILivenessOneShotRGBEstimator);
12 #endif
13
19 struct LivenessOneShotRGBEstimation {
20 enum class State {
21 Alive = 0,
22 Fake,
23 Unknown
24 };
25
26 float score;
27 State state;
28 float qualityScore;
29 };
30
35 struct ILivenessOneShotRGBEstimator : IRefCounted {
36
46 virtual fsdk::Result<fsdk::FSDKError> estimate(
47 const fsdk::Image& image,
48 const fsdk::Detection& detection,
49 const fsdk::Landmarks5& landmarks5,
50 fsdk::LivenessOneShotRGBEstimation& estimation,
51 const float& qualityThreshold = -1.f) const noexcept = 0;
52
64 virtual fsdk::Result<fsdk::FSDKError> estimate(
65 fsdk::Span<const fsdk::Image> images,
66 fsdk::Span<const fsdk::Detection> detections,
67 fsdk::Span<const fsdk::Landmarks5> landmarks5,
68 fsdk::Span<fsdk::LivenessOneShotRGBEstimation> estimations,
69 const float& qualityThreshold = -1.f) const noexcept = 0;
70
80 virtual Result<FSDKError>
81 validate(
82 fsdk::Span<const fsdk::Image> images,
83 fsdk::Span<const fsdk::Detection> detections,
84 Span<const Landmarks5> landmarks5,
85 Span<Result<FSDKError>> errors) const noexcept = 0;
86 };
87
88 } // namespace fsdk
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:59
fsdk::LivenessOneShotRGBEstimation::State::Unknown
The liveness status of person on image is Unknown.
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:29
Types.h
Common data types and structures.
fsdk::Landmarks
Face landmarks template structure.
Definition: Landmarks.h:20
fsdk::LivenessOneShotRGBEstimation::State::Fake
The person on image is fake (photo, printed image)
fsdk::LivenessOneShotRGBEstimation::State::Alive
The person on image is real.
IObject.h
Object system types and interfaces.
fsdk::ILivenessOneShotRGBEstimator::validate
virtual Result< FSDKError > validate(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.
fsdk::LivenessOneShotRGBEstimation::State
State
Definition: ILivenessOneShotRGBEstimator.h:20
FSDKError.h
Common SDK error codes.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:36
fsdk::ILivenessOneShotRGBEstimator::estimate
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 estiamtion.
fsdk::Image
Image.
Definition: Image.h:37
fsdk::LivenessOneShotRGBEstimation
Liveness OneShotRGB estimation structure.
Definition: ILivenessOneShotRGBEstimator.h:19
fsdk::ILivenessOneShotRGBEstimator
OneShot RGB Liveness estimator interface.
Definition: ILivenessOneShotRGBEstimator.h:35
fsdk::LivenessOneShotRGBEstimation::state
State state
Liveness status.
Definition: ILivenessOneShotRGBEstimator.h:27
fsdk::LivenessOneShotRGBEstimation::score
float score
Estimation score.
Definition: ILivenessOneShotRGBEstimator.h:26
fsdk::Detection
Detection structure. Stores a detected bounding box within a source image rect.
Definition: Detection.h:10
fsdk::LivenessOneShotRGBEstimation::qualityScore
float qualityScore
Liveness quality score.
Definition: ILivenessOneShotRGBEstimator.h:28
fsdk::Span
Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objec...
Definition: Span.h:14