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

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

Face detection result batch interface. More...

`#include <IFaceDetectionBatch.h>`

Inheritance diagram for fsdk::IFaceDetectionBatch:

## Public Member Functions
virtual size_t | getSize () const noexcept=0
| Returns size.
virtual size_t | getSize (size_t imageIndex) const noexcept=0
| Returns size of the results for the target index.
virtual Face | getFace (const fsdk::Image &img, size_t imageIndex, size_t detectionIndex) const noexcept=0
| Returns detected face. More...
virtual Span< const Detection > | getDetections (size_t index=0) const noexcept=0
| Returns detection Span. More...
virtual Span< const Landmarks5 > | getLandmarks5 (size_t index=0) const noexcept=0
| Returns Landmarks5 Span. More...
virtual Span< const Landmarks68 > | getLandmarks68 (size_t index=0) const noexcept=0
| Returns Landmarks68 Span. More...
Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t | retain () noexcept=0
| Increase strong reference count. 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

Face detection result batch interface.

## Member Function Documentation

## ◆ getDetections()

virtual Span<const Detection> fsdk::IFaceDetectionBatch::getDetections | ( | size_t | index = `0` | ) | const
| pure virtual noexcept

Returns detection Span.

Note
  Result Span could be empty in two cases:
  1. If no any faces were detected on the target image.
  2. If detection request didn't contain the DT_BOX flag.

See also
  fsdk::DetectionType

## ◆ getFace()

virtual Face fsdk::IFaceDetectionBatch::getFace | ( | const fsdk::Image & | img,
|  | size_t | imageIndex,
|  | size_t | detectionIndex
| ) |  | const
| pure virtual noexcept

Returns detected face.

Parameters

  [in] | imageIndex | - index of the image
  [in] | detectionIndex | - index of the detection

Returns
  Detected face.

Note
  Result Face could be invalid if no any faces were detected on the target image or parameters are invalid.

## ◆ getLandmarks5()

virtual Span<const Landmarks5> fsdk::IFaceDetectionBatch::getLandmarks5 | ( | size_t | index = `0` | ) | const
| pure virtual noexcept

Returns Landmarks5 Span.

Note
  Result Span could be empty in two cases:
  1. If no any faces were detected on the target image.
  2. If detection request didn't contain the DT_LANDMARKS5 flag.

See also
  fsdk::DetectionType

## ◆ getLandmarks68()

virtual Span<const Landmarks68> fsdk::IFaceDetectionBatch::getLandmarks68 | ( | size_t | index = `0` | ) | const
| pure virtual noexcept

Returns Landmarks68 Span.

Note
  Result Span could be empty in two cases:
  1. If no any faces were detected on the target image.
  2. If detection request didn't contain the DT_LANDMARKS68 flag.

See also
  fsdk::DetectionType

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

- fsdk.framework/Headers/IFaceDetectionBatch.h