Face Engine SDK  5.17.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 #include <fsdk/Types/Transformation.h>
13 
14 #include <fsdk/vlc/future.h>
15 
16 namespace fsdk {
17  struct EyesEstimation;
18  struct GazeEstimation;
19 }
20 
21 namespace fsdk {
22 
23 #ifndef DOXYGEN_SHOULD_SKIP_THIS
24  DECLARE_SMARTPTR(IWarper);
25 #endif
26 
37  struct IWarper : IRefCounted {
45  virtual Transformation
47  const Detection& detection,
48  const Landmarks5& landmarks) const noexcept = 0;
49 
59  virtual Result<FSDKError>
61  const Image& image,
62  const Transformation& transformation,
63  Image& transformedImage) const noexcept = 0;
64 
82  virtual Result<FSDKError>
84  Span<const Image> images,
85  Span<const Transformation> transformations,
86  Span<Image> transformedImages) const noexcept = 0;
87 
98  virtual Result<FSDKError>
100  const Landmarks5& landmarks,
101  const Transformation& transformation,
102  Landmarks5& transformedLandmarks) const noexcept = 0;
103 
114  virtual Result<FSDKError>
116  const Landmarks68& landmarks68,
117  const Transformation& transformation,
118  Landmarks68& transformedLandmarks68) const noexcept = 0;
119 
131  virtual Result<FSDKError>
133  const EyesEstimation& eyesEstimationInWarpCoordinates,
134  const Transformation& transformation,
135  EyesEstimation& eyesEstimation) const noexcept = 0;
136 
145  virtual Result<FSDKError>
147  const Landmarks5& warpedLandmarks5,
148  const Transformation& transformation,
149  Landmarks5& landmarks5) const noexcept = 0;
150 
159  virtual Result<FSDKError>
161  const Landmarks68& warpedLandmarks68,
162  const Transformation& transformation,
163  Landmarks68& landmarks68) const noexcept = 0;
164 
165  virtual Result<FSDKError>
166  unwarp(
167  const GazeEstimation& warpedAngles,
168  const Transformation& transformation,
169  GazeEstimation& angles
170  ) const noexcept = 0;
171 
175  using ImageBatch = std::vector<Image>;
176  using ImageBatchFuture = vlc::future<ImageBatch>;
177 
190  virtual ImageBatchFuture warpAsync(
191  Span<const Image> images,
192  Span<const Transformation> transformations) const = 0;
193  };
195 }
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:37
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:175
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: Transformation.h:12
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.