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
IOverlapEstimator.h
1 #pragma once
2 
3 #include <fsdk/IObject.h>
4 #include <fsdk/FSDKError.h>
5 #include <fsdk/Optional.h>
6 #include <fsdk/Types.h>
7 
8 namespace fsdk {
9 
10 #ifndef DOXYGEN_SHOULD_SKIP_THIS
11  DECLARE_SMARTPTR(IOverlapEstimator);
12 #endif
13 
23  struct OverlapEstimation {
24  float overlapValue;
25  bool overlapped;
26  };
27 
32  struct IOverlapEstimator : IRefCounted {
42  virtual Result<FSDKError>
43  estimate(
44  const Image& image,
45  const Detection& detection,
46  OverlapEstimation& result) const noexcept = 0;
47  };
49 } // namespace fsdk
50 
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:59
fsdk::OverlapEstimation::overlapped
bool overlapped
Overlapped face (true) or not (false).
Definition: IOverlapEstimator.h:25
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:29
Types.h
Common data types and structures.
IObject.h
Object system types and interfaces.
FSDKError.h
Common SDK error codes.
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:36
fsdk::IOverlapEstimator
Overlap estimator interface.
Definition: IOverlapEstimator.h:32
fsdk::OverlapEstimation::overlapValue
float overlapValue
Numerical value of face overlapping in range [0, 1].
Definition: IOverlapEstimator.h:24
fsdk::OverlapEstimation
Face overlap estimation output.
Definition: IOverlapEstimator.h:23
fsdk::Image
Image.
Definition: Image.h:39
fsdk::IOverlapEstimator::estimate
virtual Result< FSDKError > estimate(const Image &image, const Detection &detection, OverlapEstimation &result) const noexcept=0
Estimate the face overlap.
fsdk::Detection
Detection structure. Stores a detected bounding box within a source image rect.
Definition: Detection.h:10