Face Engine SDK  5.16.0
A face detection, recognition and tracking engine.
IWarper.h
Go to the documentation of this file.
1 
8 #pragma once
9 
10 #include <fsdk/IDescriptor.h>
11 #include <fsdk/Types/Span.h>
12 
13 #include <fsdk/vlc/future.h>
14 
15 namespace fsdk {
16  struct EyesEstimation;
17  struct GazeEstimation;
18 }
19 
20 namespace fsdk {
21 
22 #ifndef DOXYGEN_SHOULD_SKIP_THIS
23  DECLARE_SMARTPTR(IWarper);
24 #endif
25 
37  struct Transformation {
38  Vector2<float> centerP = {0, 0}; //From 0, scaled
39  float angleDeg = 0;
40  float scale = 0;
41  Vector2<int> detectionTopLeft = {0, 0}; //From 0, original size
42 
43  bool isValid = false;
44  };
45 
50  struct IWarper : IRefCounted {
58  virtual Transformation
60  const Detection& detection,
61  const Landmarks5& landmarks) const noexcept = 0;
62 
72  virtual Result<FSDKError>
74  const Image& image,
75  const Transformation& transformation,
76  Image& transformedImage) const noexcept = 0;
77 
95  virtual Result<FSDKError>
97  Span<const Image> images,
98  Span<const Transformation> transformations,
99  Span<Image> transformedImages) const noexcept = 0;
100 
111  virtual Result<FSDKError>
113  const Landmarks5& landmarks,
114  const Transformation& transformation,
115  Landmarks5& transformedLandmarks) const noexcept = 0;
116 
127  virtual Result<FSDKError>
129  const Landmarks68& landmarks68,
130  const Transformation& transformation,
131  Landmarks68& transformedLandmarks68) const noexcept = 0;
132 
144  virtual Result<FSDKError>
146  const EyesEstimation& eyesEstimationInWarpCoordinates,
147  const Transformation& transformation,
148  EyesEstimation& eyesEstimation) const noexcept = 0;
149 
158  virtual Result<FSDKError>
160  const Landmarks5& warpedLandmarks5,
161  const Transformation& transformation,
162  Landmarks5& landmarks5) const noexcept = 0;
163 
172  virtual Result<FSDKError>
174  const Landmarks68& warpedLandmarks68,
175  const Transformation& transformation,
176  Landmarks68& landmarks68) const noexcept = 0;
177 
178  virtual Result<FSDKError>
179  unwarp(
180  const GazeEstimation& warpedAngles,
181  const Transformation& transformation,
182  GazeEstimation& angles
183  ) const noexcept = 0;
184 
188  using ImageBatch = std::vector<Image>;
189  using ImageBatchFuture = vlc::future<ImageBatch>;
190 
203  virtual ImageBatchFuture warpAsync(
204  Span<const Image> images,
205  Span<const Transformation> transformations) const = 0;
206  };
208 }
fsdk::Span
Span. @detail Not owning data view. It incapsulated pointer to the continuous array with one or more ...
Definition: Span.h:14
fsdk::IWarper::warp
virtual Result< FSDKError > warp(const Image &image, const Transformation &transformation, Image &transformedImage) const noexcept=0
Warp image.
fsdk::IWarper::unwarp
virtual Result< FSDKError > unwarp(const EyesEstimation &eyesEstimationInWarpCoordinates, const Transformation &transformation, EyesEstimation &eyesEstimation) const noexcept=0
Warp irisLandmarks in EyesEstimation struct for both eyes.
DECLARE_SMARTPTR
#define DECLARE_SMARTPTR(X)
Smart ptr declaration helper macro.
Definition: Def.h:56
fsdk::IWarper::unwarp
virtual Result< FSDKError > unwarp(const Landmarks5 &warpedLandmarks5, const Transformation &transformation, Landmarks5 &landmarks5) const noexcept=0
Warp landmarks of size 5 back to source image coordinates.
fsdk::IWarper
Face detection area warper interface.
Definition: IWarper.h:50
fsdk::Vector2< float >
fsdk::IWarper::warp
virtual Result< FSDKError > warp(Span< const Image > images, Span< const Transformation > transformations, Span< Image > transformedImages) const noexcept=0
Warp faces on multiple images.
fsdk
SDK namespace.
Definition: IAGSEstimator.h:8
fsdk::IWarper::ImageBatch
std::vector< Image > ImageBatch
Common aliases for IWarper asynchronous interface.
Definition: IWarper.h:188
fsdk::IWarper::warpAsync
virtual ImageBatchFuture warpAsync(Span< const Image > images, Span< const Transformation > transformations) const =0
Asynchronously warp faces on multiple images.
fsdk::Landmarks
Face landmarks template structure.
Definition: Landmarks.h:23
fsdk::IWarper::createTransformation
virtual Transformation createTransformation(const Detection &detection, const Landmarks5 &landmarks) const noexcept=0
Create transformation data struct.
fsdk::Detection
Detection structure. @detail Stores a detected bounding box within a source image rect.
Definition: Detection.h:10
fsdk::Result
A structure that encapsulates an action result enumeration.
Definition: Result.h:27
fsdk::EyesEstimation
Eyes estimation output.
Definition: IEyeEstimator.h:23
fsdk::Image
Image.
Definition: Image.h:38
fsdk::IWarper::unwarp
virtual Result< FSDKError > unwarp(const Landmarks68 &warpedLandmarks68, const Transformation &transformation, Landmarks68 &landmarks68) const noexcept=0
Warp landmarks of size 68 back to source image coordinates.
fsdk::Transformation
Transformation data structure, used for warping.
Definition: IWarper.h:37
fsdk::IRefCounted
Base strong reference counted object interface.
Definition: IRefCounted.h:37
fsdk::IWarper::warp
virtual Result< FSDKError > warp(const Landmarks5 &landmarks, const Transformation &transformation, Landmarks5 &transformedLandmarks) const noexcept=0
Warp landmarks of size 5.
fsdk::IWarper::warp
virtual Result< FSDKError > warp(const Landmarks68 &landmarks68, const Transformation &transformation, Landmarks68 &transformedLandmarks68) const noexcept=0
Warp landmarks of size 68.