| Face Engine SDK 5.7.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
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 };
24
31 struct PortraitStyleEstimation {
32 PortraitStyleStatus status;
33 float score;
34 };
35
40 struct IPortraitStyleEstimator : IRefCounted {
41
51 virtual Result<FSDKError>
52 estimate(
53 const Image& image,
54 const Detection& detection,
55 PortraitStyleEstimation& estimation) const noexcept = 0;
56
68 virtual Result<FSDKError>
69 estimate(
70 Span<const Image> images,
71 Span<const Detection> detections,
72 Span<PortraitStyleEstimation> estimations) const noexcept = 0;
73
85 virtual Result<FSDKError>
86 validate(
87 Span<const Image> images,
88 Span<const Detection> detection,
89 Span<Result<FSDKError>> errors) const noexcept = 0;
90 };
91
92 } // namespace fsdk
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:59
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:29
fsdk::PortraitStyleEstimation::score
float score
numerical value in range [0, 1], where 1 - is Portrait, 0 - is NonPortrait.
Definition: IPortraitStyle.h:33
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:40
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:32
fsdk::PortraitStyleStatus::NonPortrait
NonPortrait.
fsdk::PortraitStyleEstimation
PortraitStyle estimator output structure. This structure contains the result of estimation and probab...
Definition: IPortraitStyle.h:31
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