Face Engine SDK  5.17.0
A face detection, recognition and tracking engine.
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 
25  enum class MedicalMask {
26  Mask = 0,
27  NoMask,
29  };
30 
35  enum class MedicalMaskExtended {
36  Mask = 0,
37  NoMask,
38  MaskNotInPlace,
40  };
41 
46  enum class DetailedMaskType {
47  CorrectMask = 0,
48  MouthCoveredWithMask,
49  ClearFace,
50  ClearFaceWithMaskUnderChin,
51  PartlyCoveredFace,
52  FullMask,
53  Count
54  };
55 
65 
66  // scores
67  float maskScore;
68  float noMaskScore;
70 
71  float scores[static_cast<int>(DetailedMaskType::Count)];
72 
78  inline float getScore(DetailedMaskType type) const;
79  };
88  // scores
89  float maskScore;
90  float noMaskScore;
93  };
94 
108  virtual Result<FSDKError>
110  const Image& warp,
111  MedicalMaskEstimation& estimation) const noexcept = 0;
112 
121  virtual Result<FSDKError>
123  const Image& warp,
124  MedicalMaskEstimationExtended& estimation) const noexcept = 0;
125 
135  virtual Result<FSDKError>
137  const Image& image,
138  const Detection& detection,
139  MedicalMaskEstimation& estimation) const noexcept = 0;
140 
150  virtual Result<FSDKError>
152  const Image& image,
153  const Detection& detection,
154  MedicalMaskEstimationExtended& estimation) const noexcept = 0;
155 
167  Span<const Image> warps,
168  Span<MedicalMaskEstimation> estimations) const noexcept = 0;
169 
181  Span<const Image> warps,
182  Span<MedicalMaskEstimationExtended> estimations) const noexcept = 0;
183 
196  Span<const Image> images,
197  Span<const Detection> detections,
198  Span<MedicalMaskEstimation> estimations) const noexcept = 0;
199 
212  Span<const Image> images,
213  Span<const Detection> detections,
214  Span<MedicalMaskEstimationExtended> estimations) const noexcept = 0;
225  virtual Result<FSDKError>
227  Span<const Image> warps,
228  Span<Result<FSDKError>> errors) const noexcept = 0;
229 
241  virtual Result<FSDKError>
243  Span<const Image> images,
244  Span<const Detection> detections,
245  Span<Result<FSDKError>> errors) const noexcept = 0;
246  };
247 
248  /*
249  Implementation details.
250  */
252  switch (type) {
253  case DetailedMaskType::CorrectMask:
254  case DetailedMaskType::MouthCoveredWithMask:
255  case DetailedMaskType::ClearFace:
256  case DetailedMaskType::ClearFaceWithMaskUnderChin:
257  case DetailedMaskType::PartlyCoveredFace:
258  case DetailedMaskType::FullMask:
259  return scores[static_cast<int>(type)];
260  default:
261  return 0.f;
262  }
263  }
265 } // namespace fsdk
fsdk::Span
Span. @detail Not owning data view. It incapsulated pointer to the continuous array with one or more ...
Definition: Span.h:14
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(Span< const Image > warps, Span< MedicalMaskEstimationExtended > estimations) const noexcept=0
Estimate Medical Mask probabilities.
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(const Image &warp, MedicalMaskEstimationExtended &estimation) const noexcept=0
Estimate MedicalMask probabilities.
fsdk::MedicalMaskEstimation::maskType
DetailedMaskType maskType
detailed type (
Definition: IMedicalMaskEstimator.h:64
fsdk::MedicalMaskExtended
MedicalMaskExtended
MedicalMask estimator output enum. This enum contains all possible extended estimation results.
Definition: IMedicalMaskEstimator.h:35
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:56
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(Span< const Image > images, Span< const Detection > detections, Span< MedicalMaskEstimation > estimations) const noexcept=0
Estimate Medical Mask probabilities.
fsdk::MedicalMaskEstimation::occludedFaceScore
float occludedFaceScore
face is occluded by something score
Definition: IMedicalMaskEstimator.h:69
fsdk::IMedicalMaskEstimator
MedicalMask estimator interface.
Definition: IMedicalMaskEstimator.h:99
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
fsdk::MedicalMaskEstimationExtended::occludedFaceScore
float occludedFaceScore
face is occluded by something score
Definition: IMedicalMaskEstimator.h:92
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(const Image &image, const Detection &detection, MedicalMaskEstimation &estimation) const noexcept=0
Estimate MedicalMask probabilities.
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(const Image &image, const Detection &detection, MedicalMaskEstimationExtended &estimation) const noexcept=0
Estimate MedicalMask probabilities.
fsdk::MedicalMaskEstimation::noMaskScore
float noMaskScore
no medical mask on the face score
Definition: IMedicalMaskEstimator.h:68
fsdk::MedicalMaskExtended::Mask
@ Mask
medical mask is on the face
fsdk::MedicalMaskEstimation::maskScore
float maskScore
medical mask is on the face score
Definition: IMedicalMaskEstimator.h:67
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(Span< const Image > warps, Span< MedicalMaskEstimation > estimations) const noexcept=0
Estimate Medical Mask probabilities.
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(const Image &warp, MedicalMaskEstimation &estimation) const noexcept=0
Estimate MedicalMask probabilities.
fsdk::IMedicalMaskEstimator::validate
virtual Result< FSDKError > validate(Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0
Validate input of multiple frames in a single function call.
fsdk::MedicalMask::Mask
@ Mask
medical mask is on the face
fsdk::Detection
Detection structure. @detail Stores a detected bounding box within a source image rect.
Definition: Detection.h:10
fsdk::MedicalMaskEstimation::scores
float scores[static_cast< int >(DetailedMaskType::Count)]
detailed estimation scores
Definition: IMedicalMaskEstimator.h:71
fsdk::MedicalMask
MedicalMask
MedicalMask estimator output enum. This enum contains all possible estimation results.
Definition: IMedicalMaskEstimator.h:25
fsdk::DetailedMaskType::CorrectMask
@ CorrectMask
correct mask on the face (mouth and nose are covered correctly)
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
fsdk::MedicalMaskEstimationExtended::noMaskScore
float noMaskScore
no medical mask on the face score
Definition: IMedicalMaskEstimator.h:90
fsdk::MedicalMaskEstimation
MedicalMask estimator output structure. This structure contains the result of estimation (.
Definition: IMedicalMaskEstimator.h:62
fsdk::MedicalMaskEstimationExtended::maskScore
float maskScore
medical mask is on the face score
Definition: IMedicalMaskEstimator.h:89
fsdk::MedicalMaskEstimationExtended::result
MedicalMaskExtended result
estimation result (
Definition: IMedicalMaskEstimator.h:87
fsdk::MedicalMaskEstimationExtended::maskNotInPlace
float maskNotInPlace
mask is not on the right place
Definition: IMedicalMaskEstimator.h:91
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::Image
Image.
Definition: Image.h:38
fsdk::DetailedMaskType
DetailedMaskType
MedicalMask estimator output enum. This enum contains all type of DetailedMaskType results.
Definition: IMedicalMaskEstimator.h:46
fsdk::IMedicalMaskEstimator::estimate
virtual Result< FSDKError > estimate(Span< const Image > images, Span< const Detection > detections, Span< MedicalMaskEstimationExtended > estimations) const noexcept=0
Estimate Medical Mask probabilities.
fsdk::MedicalMaskEstimationExtended
MedicalMask estimator output structure. This structure contains the result of estimation (.
Definition: IMedicalMaskEstimator.h:86
fsdk::MedicalMaskEstimation::result
MedicalMask result
estimation result (
Definition: IMedicalMaskEstimator.h:63
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:37
fsdk::MedicalMaskEstimation::getScore
float getScore(DetailedMaskType type) const
Returns score of required detailed mask type.
Definition: IMedicalMaskEstimator.h:251