Face Engine SDK  5.14.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
IDetector.h
Go to the documentation of this file.
1 
8 #pragma once
9 
10 #include <fsdk/FSDKError.h>
11 #include <fsdk/IFaceDetectionBatch.h>
12 #include <fsdk/IObject.h>
13 #include <fsdk/Types.h>
14 #include <fsdk/Types/Face.h>
15 #include <fsdk/Types/SensorType.h>
16 
17 #include <fsdk/vlc/future.h>
18 
19 #include <functional>
20 
21 namespace fsdk {
22 
23 #ifndef DOXYGEN_SHOULD_SKIP_THIS
24  DECLARE_SMARTPTR(IDetector);
25 #endif
26 
42  };
43 
52  DCT_COUNT
53  };
54 
59  DT_BBOX = 0,
60  DT_LANDMARKS5 = 1<<0,
61  DT_LANDMARKS68 = 1<<1,
62  DT_ALL = 0xffff
63  };
64 
65  inline DetectionType operator | (DetectionType a, DetectionType b)
66  { return static_cast<DetectionType>(static_cast<int>(a) | static_cast<int>(b)); }
67 
72  public:
73  virtual bool compare(const Image& img, const Detection& a, const Detection& b) const = 0;
74  virtual ~IDetectionComparer() = default;
75  };
76 
81  public:
82  typedef std::function<bool(const Image& img, const Detection&, const Detection&)> Function;
83  explicit FunctionDetectionComparer(const Function& function) : func(function)
84  {}
85  bool compare(const Image& img, const Detection& a, const Detection& b) const
86  { return func(img, a, b); }
87  private:
88  Function func;
89  };
90 
108  detect(
109  Span<const Image> images,
110  Span<const Rect> ROIs,
111  uint32_t perImageNum,
112  DetectionType type = DT_BBOX
113  ) noexcept = 0;
114 
125  detectOne(
126  const Image& image,
127  const Rect& rect,
128  DetectionType type = DT_BBOX) noexcept = 0;
129 
147  redetect(
148  Span<const Image> images,
149  Ref<IFaceDetectionBatch> detectionBatch,
150  DetectionType type = DT_BBOX
151  ) noexcept = 0;
152 
169  redetect(
170  Span<const Image> images,
171  Span<Span<const Detection>> detections,
172  DetectionType type = DT_BBOX
173  ) noexcept = 0;
174 
185  redetectOne(
186  const Image& image,
187  const Detection& detection,
188  DetectionType type = DT_BBOX) noexcept = 0;
189 
195  virtual void setDetectionComparer(DetectionComparerType comparerType) noexcept = 0;
196 
203  virtual void setCustomDetectionComparer(const IDetectionComparer* comparer) noexcept = 0;
204 
218  virtual Result<FSDKError>
219  validate(
220  Span<const Image> images,
221  Span<Span<const Detection>> detections,
222  Span<Span<Result<FSDKError>>> errors) const noexcept = 0;
223 
236  virtual Result<FSDKError>
237  validate(
238  Span<const Image> images,
239  Span<const Rect> rects,
240  uint32_t detectionPerImageNum,
241  Span<Result<FSDKError>> outErrors) const noexcept = 0;
242 
255  virtual Result<FSDKError>
256  validate(
257  Span<const Image> images,
258  Ref<IFaceDetectionBatch> detectionBatch,
259  Span<Result<FSDKError>> outErrors) const noexcept = 0;
260 
265  using FaceBatchFuture = vlc::future<IFaceDetectionBatchPtr>;
266 
282  virtual FaceBatchFuture detectAsync(
283  Span<const Image> images,
284  Span<const Rect> rectangles,
285  uint32_t perImageNum,
286  DetectionType type = DT_BBOX) const = 0;
287 
307  virtual FaceBatchFuture redetectAsync(
308  Span<const Image> images,
309  IFaceDetectionBatchPtr detectionBatch,
310  DetectionType type = DT_BBOX) const = 0;
311  };
312 
315 }
virtual ResultValue< FSDKError, Ref< IFaceDetectionBatch > > redetect(Span< const Image > images, Ref< IFaceDetectionBatch > detectionBatch, DetectionType type=DT_BBOX) noexcept=0
Batched redetect faces on multiple images. based on the detection results for the previous frames...
virtual Result< FSDKError > validate(Span< const Image > images, Span< Span< const Detection >> detections, Span< Span< Result< FSDKError >>> errors) const noexcept=0
Validate input of multiple frames in a single function call.
Syntax sugar, allows you to use lambdas to define a BestDetection comparer.
Definition: IDetector.h:80
Detector type 2.
Definition: IDetector.h:39
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:59
BestDetection - most centered detection.
Definition: IDetector.h:49
Default detector cpecified in config file.
Definition: IDetector.h:37
A structure that encapsulates an action result enumeration.
Definition: Result.h:29
Common data types and structures.
virtual void setCustomDetectionComparer(const IDetectionComparer *comparer) noexcept=0
Set custom detection comparer object.
Detector type 3.
Definition: IDetector.h:40
Smart pointer for reference counted objects.
Definition: Ref.h:26
Object system types and interfaces.
Get bounding boxes of faces.
Definition: IDetector.h:59
Common SDK error codes.
DetectionComparerType
Strategy of BestDetections comparer.
Definition: IDetector.h:47
Detector type count.
Definition: IDetector.h:41
virtual ResultValue< FSDKError, Face > detectOne(const Image &image, const Rect &rect, DetectionType type=DT_BBOX) noexcept=0
Light function to get just one best detection from single input image.
Base strong reference counted object interface.
Definition: IRefCounted.h:36
face detector interface.
Definition: IDetector.h:94
virtual ResultValue< FSDKError, Ref< IFaceDetectionBatch > > detect(Span< const Image > images, Span< const Rect > ROIs, uint32_t perImageNum, DetectionType type=DT_BBOX) noexcept=0
Detect faces and their parameters on multiple images.
Detector type 1.
Definition: IDetector.h:38
bestDetection - the largest detection.
Definition: IDetector.h:51
virtual FaceBatchFuture redetectAsync(Span< const Image > images, IFaceDetectionBatchPtr detectionBatch, DetectionType type=DT_BBOX) const =0
Asynchronously redetect faces on multiple images. based on the detection results for the previous fra...
Get all supported parameters.
Definition: IDetector.h:62
BestDetection - detections with highest score.
Definition: IDetector.h:48
Interface of BestDetection comparer. Implement it if you want to use own BestDetection strategy...
Definition: IDetector.h:71
Addon for Result to output some value aside the result. Specialization for copiable types...
Definition: ResultValue.h:25
Image.
Definition: Image.h:39
virtual void setDetectionComparer(DetectionComparerType comparerType) noexcept=0
Set detection comparer from SDK defined list.
virtual ResultValue< FSDKError, Face > redetectOne(const Image &image, const Detection &detection, DetectionType type=DT_BBOX) noexcept=0
Redetect face.
ObjectDetectorClassType
Object detector type enumeration.
Definition: IDetector.h:36
DetectionType
Detection type enumeration.
Definition: IDetector.h:58
Get bounding boxes and 5 facial landmarks.
Definition: IDetector.h:60
Get bounding boxes and 68 facial landmarks.
Definition: IDetector.h:61
virtual FaceBatchFuture detectAsync(Span< const Image > images, Span< const Rect > rectangles, uint32_t perImageNum, DetectionType type=DT_BBOX) const =0
Asynchronously detect faces and their parameters on multiple images.
Detection structure. Stores a detected bounding box within a source image rect.
Definition: Detection.h:10
Span. Not owning data view. It incapsulated pointer to the continuous array with one or more T objec...
Definition: Span.h:14
bestDetection - most centered with high score.
Definition: IDetector.h:50