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

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

Overlap estimator interface. More...

`#include <IOverlapEstimator.h>`

Inheritance diagram for fsdk::IOverlapEstimator:

## Public Member Functions
virtual Result< FSDKError > | estimate (const Image &image, const Detection &detection, OverlapEstimation &result) const noexcept=0
| Estimate the face overlap. 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

Overlap estimator interface.

Note
  This estimator is designed to work with Image and detection;

## Member Function Documentation

## ◆ estimate()

virtual Result<FSDKError> fsdk::IOverlapEstimator::estimate | ( | const Image & | image,
|  | const Detection & | detection,
|  | OverlapEstimation & | result
| ) |  | const
| pure virtual noexcept

Estimate the face overlap.

Parameters

  [in] | image | source image.
  [in] | detection | detection coordinates in image space.
  [out] | result | output estimation.

Returns
  Result with error code.

See also
  OverlapEstimation, Detection, Image, Result and FSDKError for details.

Note
  image format must be R8G8B8,

See also
  Format.

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

- include/fsdk/Estimators/IOverlapEstimator.h