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

INaturalLightEstimator.h
1 #pragma once
2
3 #include <fsdk/IObject.h>
4 #include <fsdk/FSDKError.h>
5
6 #include <fsdk/Types/Image.h>
7 #include <fsdk/Types/Result.h>
8 #include <fsdk/Types/Span.h>
9
10 namespace fsdk {
11
12 #ifndef DOXYGEN_SHOULD_SKIP_THIS
13 DECLARE_SMARTPTR(INaturalLightEstimator);
14 #endif
15
20 enum class LightStatus : uint8_t {
21 NonNatural = 0,
22 Natural = 1
23 };
24
31 struct NaturalLightEstimation {
32 LightStatus status;
33 float score;
34 };
35
40 struct INaturalLightEstimator : IRefCounted {
41
50 virtual Result<FSDKError>
51 estimate(
52 const Image& warp,
53 NaturalLightEstimation& estimation) const noexcept = 0;
54
65 virtual Result<FSDKError>
66 estimate(
67 Span<const Image> warps,
68 Span<NaturalLightEstimation> estimations) const noexcept = 0;
69
80 virtual Result<FSDKError>
81 validate(
82 Span<const Image> warps,
83 Span<Result<FSDKError>> errors) const noexcept = 0;
84 };
85
86 } // namespace fsdk
fsdk::NaturalLightEstimation::status
LightStatus status
estimation result (
Definition: INaturalLightEstimator.h:32
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:59
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:29
fsdk::NaturalLightEstimation::score
float score
Numerical value in range [0, 1].
Definition: INaturalLightEstimator.h:33
fsdk::LightStatus
LightStatus
NaturalLight estimator output enum. This enum contains all possible estimation results.
Definition: INaturalLightEstimator.h:20
IObject.h
Object system types and interfaces.
FSDKError.h
Common SDK error codes.
fsdk::LightStatus::NonNatural
light is not natural
fsdk::INaturalLightEstimator::estimate
virtual Result< FSDKError > estimate(const Image &warp, NaturalLightEstimation &estimation) const noexcept=0
Estimate natural light probability.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:36
fsdk::INaturalLightEstimator
NaturalLight estimator interface.
Definition: INaturalLightEstimator.h:40
fsdk::INaturalLightEstimator::validate
virtual Result< FSDKError > validate(Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0
Validate input of multiple frames in a single function call.
fsdk::Image
Image.
Definition: Image.h:38
fsdk::LightStatus::Natural
light is natural
fsdk::NaturalLightEstimation
NaturalLight estimator output structure. This structure contains the result of estimation and probabi...
Definition: INaturalLightEstimator.h:31
fsdk::Span
Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objec...
Definition: Span.h:14