Face Engine SDK  5.21.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
fsdk::IFishEyeEstimator Struct Referenceabstract

FishEye estimator interface. More...

#include <IFishEyeEstimator.h>

Inheritance diagram for fsdk::IFishEyeEstimator:
fsdk::IRefCounted

Public Member Functions

virtual Result< FSDKErrorestimate (const Image &image, const Detection &detection, FishEyeEstimation &estimation) const noexcept=0
 Estimate fisheye effect probability. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > images, Span< const Detection > detections, Span< FishEyeEstimation > estimations) const noexcept=0
 Estimate fisheye effect probabilities of multiple frames in a single estimate function call. More...
 
virtual Result< FSDKErrorestimate (const Image &warp, FishEyeEstimation &estimation) const noexcept=0
 Estimate fisheye effect probability. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > warps, Span< FishEyeEstimation > estimations) const noexcept=0
 Estimate fisheye effect probabilities of multiple frames in a single estimate function call. More...
 
virtual Result< FSDKErrorvalidate (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. More...
 
virtual Result< FSDKErrorvalidate (Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0
 Validate input of multiple frames in a single function call. More...
 
- Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t retain () noexcept=0
 Increase strong reference count. More...
 
virtual int32_t retainLocked () noexcept=0
 Increase strong reference count thread safely. More...
 
virtual int32_t release () noexcept=0
 Decrease strong reference count. More...
 
virtual int32_t getRefCount () const noexcept=0
 Get actual strong reference count. More...
 
virtual int32_t retainWeak () noexcept=0
 Increase weak reference count. More...
 
virtual int32_t releaseWeak () noexcept=0
 Decrease weak reference count. More...
 
virtual int32_t getWeakRefCount () const noexcept=0
 Get actual weak reference count. More...
 

Detailed Description

FishEye estimator interface.

Note
Estimator predicts fish eye effect.

Member Function Documentation

virtual Result<FSDKError> fsdk::IFishEyeEstimator::estimate ( const Image image,
const Detection detection,
FishEyeEstimation estimation 
) const
pure virtualnoexcept

Estimate fisheye effect probability.

Parameters
[in]imagesource image;
[in]detectiondetection coordinates in image space;
[out]estimationestimation results.
Returns
Result with error code.
See Also
FishEyeEstimation, Image, Detection, Result and FSDKError for details.
Note
warp format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::IFishEyeEstimator::estimate ( Span< const Image images,
Span< const Detection detections,
Span< FishEyeEstimation estimations 
) const
pure virtualnoexcept

Estimate fisheye effect probabilities of multiple frames in a single estimate function call.

Parameters
[in]imagesspan of source images.
[in]detectionsspan of detection coordinates in corresponding source images space.
[out]resultsspan of estimations.
Returns
Result with error code.
See Also
FishEyeEstimation, Span, Image, Detection, Result and FSDKError for details.
Note
images format must be R8G8B8,
See Also
Format.
Note
all spans should be based on user owned continuous collections.
all spans should be equal size.
virtual Result<FSDKError> fsdk::IFishEyeEstimator::estimate ( const Image warp,
FishEyeEstimation estimation 
) const
pure virtualnoexcept

Estimate fisheye effect probability.

Parameters
[in]warpimage with warped face.
[out]estimationestimation results.
Returns
Result with error code.
See Also
FishEyeEstimation, Image, Result and FSDKError for details.
Note
warp format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::IFishEyeEstimator::estimate ( Span< const Image warps,
Span< FishEyeEstimation estimations 
) const
pure virtualnoexcept

Estimate fisheye effect probabilities of multiple frames in a single estimate function call.

Parameters
[in]warpsspan of images with warped faces.
[out]resultsspan of estimations.
Returns
Result with error code.
See Also
FishEyeEstimation, Span, Image, Detection, Result and FSDKError for details.
Note
warps format must be R8G8B8,
See Also
Format.
Note
all spans should be based on user owned continuous collections.
all spans should be equal size.
virtual Result<FSDKError> fsdk::IFishEyeEstimator::validate ( Span< const Image images,
Span< const Detection detections,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

Validate input of multiple frames in a single function call.

Parameters
[in]imagesspan of source images.
[in]detectionsspan of detection coordinates in corresponding source images space.
[out]errorsoutput span of errors for each image.
Returns
Result with error code.
See Also
Span, Image, Detection, Result, FSDKError for details.
Note
images format must be R8G8B8,
See Also
Format.
Note
all spans should be based on user owned continuous collections.
all spans should be equal size.
virtual Result<FSDKError> fsdk::IFishEyeEstimator::validate ( Span< const Image warps,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

Validate input of multiple frames in a single function call.

Parameters
[in]warpsspan of images with warped faces.
[out]errorsoutput span of errors for each image.
Returns
Result with error code.
See Also
Span, Image, Result and FSDKError for details.
Note
warps format must be R8G8B8,
See Also
Format.
Note
all spans should be based on user owned continuous collections.
all spans should be equal size.

The documentation for this struct was generated from the following file: