Face Engine SDK  5.17.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | List of all members
fsdk::INaturalLightEstimator Struct Referenceabstract
Estimators

NaturalLight estimator interface. More...

#include <INaturalLightEstimator.h>

Inheritance diagram for fsdk::INaturalLightEstimator:
fsdk::IRefCounted

Public Member Functions

virtual Result< FSDKError > estimate (const Image &warp, NaturalLightEstimation &estimation) const noexcept=0
 Estimate natural light probability. More...
 
virtual Result< FSDKError > estimate (Span< const Image > warps, Span< NaturalLightEstimation > estimations) const noexcept=0
 Estimate natural light probability. More...
 
virtual Result< FSDKError > validate (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

NaturalLight estimator interface.

Note
Estimator predicts natural light.

Member Function Documentation

virtual Result<FSDKError> fsdk::INaturalLightEstimator::estimate ( const Image &  warp,
NaturalLightEstimation &  estimation 
) const
pure virtualnoexcept

Estimate natural light probability.

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

Estimate natural light probability.

Parameters
[in]warpsspan of images with warped faces.
[out]estimationsspan of estimations.
Returns
Result with error code.
See Also
Span, NaturalLightEstimation, 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.
virtual Result<FSDKError> fsdk::INaturalLightEstimator::validate ( Span< const Image >  warps,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

Validate input of multiple frames in a single function call.

Parameters
[in]imagesspan of images with warped faces.
[out]errorsspan 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: