| Face Engine SDK 5.12.0 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
20 enum class PortraitStyleStatus : uint8_t {
21 NonPortrait = 0,
22 Portrait = 1,
23 HiddenShoulders = 2
24 };
25
32 struct PortraitStyleEstimation {
33 PortraitStyleStatus status;
34 float nonPortraitScore;
35 float portraitScore;
36 float hiddenShouldersScore;
37 };
38
43 struct IPortraitStyleEstimator : IRefCounted {
44
54 virtual Result<FSDKError>
55 estimate(
56 const Image& image,
57 const Detection& detection,
58 PortraitStyleEstimation& estimation) const noexcept = 0;
59
71 virtual Result<FSDKError>
72 estimate(
73 Span<const Image> images,
74 Span<const Detection> detections,
75 Span<PortraitStyleEstimation> estimations) const noexcept = 0;
76
88 virtual Result<FSDKError>
89 validate(
90 Span<const Image> images,
91 Span<const Detection> detection,
92 Span<Result<FSDKError>> errors) const noexcept = 0;
93 };
94
95 } // namespace fsdk
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::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:43
IObject.h
Object system types and interfaces.
FSDKError.h
Common SDK error codes.
fsdk::PortraitStyleStatus::Portrait
Portrait.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:36
fsdk::PortraitStyleEstimation::status
PortraitStyleStatus status
estimation result (
Definition: IPortraitStyle.h:33
fsdk::PortraitStyleEstimation::nonPortraitScore
float nonPortraitScore
numerical value in range [0, 1]
Definition: IPortraitStyle.h:34
fsdk::PortraitStyleEstimation::portraitScore
float portraitScore
numerical value in range [0, 1]
Definition: IPortraitStyle.h:35
fsdk::PortraitStyleStatus::HiddenShoulders
HiddenShoulders.
fsdk::PortraitStyleEstimation::hiddenShouldersScore
float hiddenShouldersScore
numerical value in range [0, 1]
Definition: IPortraitStyle.h:36
fsdk::PortraitStyleStatus::NonPortrait
NonPortrait.
fsdk::PortraitStyleEstimation
PortraitStyle estimator output structure. This structure contains the result of estimation and probab...
Definition: IPortraitStyle.h:32
fsdk::Image
Image.
Definition: Image.h:38
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::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
fsdk::PortraitStyleStatus
PortraitStyleStatus
PortraitStyle estimator output enum. This enum contains all possible estimation results.
Definition: IPortraitStyle.h:20