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

IPortraitStyle.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(IPortraitStyleEstimator);
14 #endif
15
25 enum class PortraitStyleStatus : uint8_t {
26 NonPortrait = 0,
27 Portrait = 1,
28 HiddenShoulders = 2
29 };
30
37 struct PortraitStyleEstimation {
38 PortraitStyleStatus status;
39 float nonPortraitScore;
40 float portraitScore;
41 float hiddenShouldersScore;
42 };
43
48 struct IPortraitStyleEstimator : IRefCounted {
49
59 virtual Result<FSDKError> estimate(
60 const Image& image,
61 const Detection& detection,
62 PortraitStyleEstimation& estimation) const noexcept = 0;
63
75 virtual Result<FSDKError> estimate(
76 Span<const Image> images,
77 Span<const Detection> detections,
78 Span<PortraitStyleEstimation> estimations) const noexcept = 0;
79
91 virtual Result<FSDKError> validate(
92 Span<const Image> images,
93 Span<const Detection> detection,
94 Span<Result<FSDKError>> errors) const noexcept = 0;
95 };
96
98 } // namespace fsdk
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:56
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
fsdk::IPortraitStyleEstimator::estimate
virtual Result< FSDKError > estimate(const Image &image, const Detection &detection, PortraitStyleEstimation &estimation) const noexcept=0
Estimates portrait style probability.
fsdk::IPortraitStyleEstimator
PortraitStyle estimator interface.
Definition: IPortraitStyle.h:48
IObject.h
Object system types and interfaces.
FSDKError.h
Common SDK error codes.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:37
fsdk::PortraitStyleEstimation::status
PortraitStyleStatus status
estimation result (
Definition: IPortraitStyle.h:38
fsdk::PortraitStyleEstimation::nonPortraitScore
float nonPortraitScore
numerical value in range [0, 1]
Definition: IPortraitStyle.h:39
fsdk::PortraitStyleEstimation::portraitScore
float portraitScore
numerical value in range [0, 1]
Definition: IPortraitStyle.h:40
fsdk::PortraitStyleEstimation::hiddenShouldersScore
float hiddenShouldersScore
numerical value in range [0, 1]
Definition: IPortraitStyle.h:41
fsdk::PortraitStyleEstimation
PortraitStyle estimator output structure. This structure contains the result of estimation and probab...
Definition: IPortraitStyle.h:37
fsdk::PortraitStyleStatus
PortraitStyleStatus
PortraitStyle estimator output enum. This enum contains all possible estimation results.
Definition: IPortraitStyle.h:25
fsdk::PortraitStyleStatus::NonPortrait
NonPortrait.
fsdk::Image
Image.
Definition: Image.h:38
fsdk::PortraitStyleStatus::HiddenShoulders
HiddenShoulders.
fsdk::IPortraitStyleEstimator::validate
virtual Result< FSDKError > validate(Span< const Image > images, Span< const Detection > detection, Span< Result< FSDKError >> errors) const noexcept=0
Validates input of multiple frames in a single function call.
fsdk::PortraitStyleStatus::Portrait
Portrait.
fsdk::Detection
Detection structure. Stores a detected bounding box within a source image rect.
Definition: Detection.h:10
fsdk::Span
Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objec...
Definition: Span.h:14