| Face Engine SDK 5.34.0 A face detection, recognition and tracking engine.

Public Member Functions | List of all members
fsdk::IBackgroundEstimator Struct Referenceabstract
Estimators

Background estimator interface. More...

`#include <IBackgroundEstimator.h>`

Inheritance diagram for fsdk::IBackgroundEstimator:

## 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

## ◆ estimate() [1/2]

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

Estimates background status probability.

Parameters

  [in] | image | source image.
  [in] | detection | detection coordinates in image space.
  [out] | estimation | estimation 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.

## ◆ estimate() [2/2]

virtual Result<FSDKError> fsdk::IBackgroundEstimator::estimate | ( | Span< const Image > | images,
|  | Span< const Detection > | detections,
|  | Span< BackgroundEstimation > | estimations
| ) |  | const
| pure virtual noexcept

Estimates background probabilities of multiple frames in a single estimate function call.

Parameters

  [in] | images | span of source images.
  [in] | detections | span of detection coordinates in corresponding source images space.
  [out] | estimations | span 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.

## ◆ validate()

virtual Result<FSDKError> fsdk::IBackgroundEstimator::validate | ( | Span< const Image > | images,
|  | Span< const Detection > | detection,
|  | Span< Result< FSDKError >> | errors
| ) |  | const
| pure virtual noexcept

Validates input of multiple frames in a single function call.

Parameters

  [in] | images | span of source images.
  [in] | detections | span of detection coordinates in corresponding source images space.
  [out] | errors | span 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:

- include/fsdk/Estimators/IBackgroundEstimator.h