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
Public Member Functions | List of all members
fsdk::IBackgroundEstimator Struct Referenceabstract
Estimators

Background estimator interface. More...

#include <IBackgroundEstimator.h>

Inheritance diagram for fsdk::IBackgroundEstimator:
fsdk::IRefCounted

Public Member Functions

virtual Result< FSDKError > estimate (const Image &image, const Detection &detection, BackgroundEstimation &estimation) const noexcept=0
 Estimates background status probability. More...
 
virtual Result< FSDKError > estimate (Span< const Image > images, Span< const Detection > detections, Span< BackgroundEstimation > estimations) const noexcept=0
 Estimates background probabilities of multiple frames in a single estimate function call. More...
 
virtual Result< FSDKError > validate (Span< const Image > images, Span< const Detection > detection, Span< Result< FSDKError >> errors) const noexcept=0
 Validates 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

Background estimator interface.

Note
Estimator predicts background status.

Member Function Documentation

virtual Result<FSDKError> fsdk::IBackgroundEstimator::estimate ( const Image &  image,
const Detection &  detection,
BackgroundEstimation &  estimation 
) const
pure virtualnoexcept

Estimates background status probability.

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

Estimates background 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]estimationsspan of estimations.
Returns
Result with error code.
See Also
Span, BackgroundEstimation, 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::IBackgroundEstimator::validate ( Span< const Image >  images,
Span< const Detection >  detection,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

Validates 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]errorsspan of errors for each image.
Returns
Result with error code.
See Also
Span, Detection, Image, 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.
The documentation for this struct was generated from the following file: