| 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
IMedicalMaskEstimator.h
1 #pragma once
2
3 #pragma once
4
5 #include <fsdk/IObject.h>
6 #include <fsdk/FSDKError.h>
7 #include <fsdk/Optional.h>
8 #include <fsdk/Types.h>
9
10 namespace fsdk {
11
12 #ifndef DOXYGEN_SHOULD_SKIP_THIS
13 DECLARE_SMARTPTR(IMedicalMaskEstimator);
14 #endif
15
20 enum class MedicalMask {
21 Mask = 0,
22 NoMask,
23 OccludedFace
24 };
25
30 enum class MedicalMaskExtended {
31 Mask = 0,
32 NoMask,
33 MaskNotInPlace,
34 OccludedFace
35 };
36
43 struct MedicalMaskEstimation {
44 MedicalMask result;
45 // scores
46 float maskScore;
47 float noMaskScore;
48 float occludedFaceScore;
49 };
50
57 struct MedicalMaskEstimationExtended {
58 MedicalMaskExtended result;
59 // scores
60 float maskScore;
61 float noMaskScore;
62 float maskNotInPlace;
63 float occludedFaceScore;
64 };
65
70 struct IMedicalMaskEstimator : IRefCounted {
71
78 virtual Result<FSDKError>
79 estimate(
80 const Image& warp,
81 MedicalMaskEstimation& estimation) const noexcept = 0;
82
89 virtual Result<FSDKError>
90 estimate(
91 const Image& warp,
92 MedicalMaskEstimationExtended& estimation) const noexcept = 0;
93
101 virtual Result<FSDKError>
102 estimate(
103 const Image& image,
104 const Detection& detection,
105 MedicalMaskEstimation& estimation) const noexcept = 0;
106
114 virtual Result<FSDKError>
115 estimate(
116 const Image& image,
117 const Detection& detection,
118 MedicalMaskEstimationExtended& estimation) const noexcept = 0;
119
128 virtual Result<FSDKError> estimate(
129 Span<const Image> warps,
130 Span<MedicalMaskEstimation> estimations) const noexcept = 0;
131
140 virtual Result<FSDKError> estimate(
141 Span<const Image> warps,
142 Span<MedicalMaskEstimationExtended> estimations) const noexcept = 0;
143
153 virtual Result<FSDKError> estimate(
154 Span<const Image> images,
155 Span<const Detection> detections,
156 Span<MedicalMaskEstimation> estimations) const noexcept = 0;
157
167 virtual Result<FSDKError> estimate(
168 Span<const Image> images,
169 Span<const Detection> detections,
170 Span<MedicalMaskEstimationExtended> estimations) const noexcept = 0;
178 virtual Result<FSDKError>
179 validate(
180 Span<const Image> warps,
181 Span<Result<FSDKError>> errors) const noexcept = 0;
182
191 virtual Result<FSDKError>
192 validate(
193 Span<const Image> images,
194 Span<const Detection> detections,
195 Span<Result<FSDKError>> errors) const noexcept = 0;
196 };
197
198 } // namespace fsdk
fsdk::IMedicalMaskEstimator::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::MedicalMask::NoMask
no medical mask on the face
fsdk::MedicalMaskExtended::MaskNotInPlace
mask is not on the right place
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
Types.h
Common data types and structures.
fsdk::MedicalMask::Mask
medical mask is on the face
fsdk::MedicalMaskExtended
MedicalMaskExtended
MedicalMask estimator output enum. This enum contains all possible extended estimation results...
Definition: IMedicalMaskEstimator.h:30
IObject.h
Object system types and interfaces.
fsdk::MedicalMaskEstimationExtended::occludedFaceScore
float occludedFaceScore
face is occluded by something score
Definition: IMedicalMaskEstimator.h:63
FSDKError.h
Common SDK error codes.
fsdk::MedicalMaskEstimation::noMaskScore
float noMaskScore
no medical mask on the face score
Definition: IMedicalMaskEstimator.h:47
fsdk::MedicalMaskEstimation::result
MedicalMask result
estimation result (
Definition: IMedicalMaskEstimator.h:44
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:36
fsdk::MedicalMaskEstimationExtended::noMaskScore
float noMaskScore
no medical mask on the face score
Definition: IMedicalMaskEstimator.h:61
fsdk::MedicalMaskEstimation::occludedFaceScore
float occludedFaceScore
face is occluded by something score
Definition: IMedicalMaskEstimator.h:48
fsdk::IMedicalMaskEstimator
MedicalMask estimator interface.
Definition: IMedicalMaskEstimator.h:70
fsdk::MedicalMaskEstimationExtended::maskScore
float maskScore
medical mask is on the face score
Definition: IMedicalMaskEstimator.h:60
fsdk::MedicalMaskEstimationExtended
MedicalMask estimator output structure. This structure contains the result of estimation (...
Definition: IMedicalMaskEstimator.h:57
fsdk::MedicalMaskEstimationExtended::maskNotInPlace
float maskNotInPlace
mask is not on the right place
Definition: IMedicalMaskEstimator.h:62
fsdk::Image
Image.
Definition: Image.h:37
fsdk::MedicalMaskEstimation
MedicalMask estimator output structure. This structure contains the result of estimation (...
Definition: IMedicalMaskEstimator.h:43
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(const Image &warp, MedicalMaskEstimation &estimation) const noexcept=0
Estimate MedicalMask probabilities.
fsdk::MedicalMask
MedicalMask
MedicalMask estimator output enum. This enum contains all possible estimation results.
Definition: IMedicalMaskEstimator.h:20
fsdk::MedicalMaskEstimation::maskScore
float maskScore
medical mask is on the face score
Definition: IMedicalMaskEstimator.h:46
fsdk::MedicalMaskEstimationExtended::result
MedicalMaskExtended result
estimation result (
Definition: IMedicalMaskEstimator.h:58
fsdk::Detection
Detection structure. Stores a detected bounding box within a source image rect.
Definition: Detection.h:10
fsdk::MedicalMask::OccludedFace
face is occluded by something
fsdk::Span
Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objec...
Definition: Span.h:14