Face Engine SDK  5.8.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
fsdk::IFaceDetectionBatch Struct Referenceabstract

Face detection result batch interface. More...

#include <IFaceDetectionBatch.h>

Inheritance diagram for fsdk::IFaceDetectionBatch:
fsdk::IRefCounted

Public Member Functions

virtual size_t getSize () const noexcept=0
 Returns size. More...
 
virtual size_t getSize (size_t imageIndex) const noexcept=0
 Returns size of the results for the target index. More...
 
virtual Face getFace (const Image &img, size_t imageIndex, size_t detectionIndex) const noexcept=0
 Returns detected face. More...
 
virtual Span< const DetectiongetDetections (size_t index=0) const noexcept=0
 Returns detection Span. More...
 
virtual Span< const Landmarks5getLandmarks5 (size_t index=0) const noexcept=0
 Returns Landmarks5 Span. More...
 
virtual Span< const Landmarks68getLandmarks68 (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 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

Face detection result batch interface.

Member Function Documentation

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

Returns detection Span.

Parameters
[in]indexindex of the detection.
Returns
span of detection coordinates in corresponding source images space.
See Also
Span and Detection for details.
Note
all spans should be based on user owned continuous collections.
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
DetectionType
virtual Face fsdk::IFaceDetectionBatch::getFace ( const Image img,
size_t  imageIndex,
size_t  detectionIndex 
) const
pure virtualnoexcept

Returns detected face.

Parameters
[in]imgsource image.
[in]imageIndexindex of the image.
[in]detectionIndexindex of the detection.
Returns
Detected face.
See Also
Face and Image for details.
Note
images format must be R8G8B8,
See Also
Format.
Note
Result Face could be invalid if no any faces were detected on the target image or parameters are invalid.
virtual Span<const Landmarks5> fsdk::IFaceDetectionBatch::getLandmarks5 ( size_t  index = 0) const
pure virtualnoexcept

Returns Landmarks5 Span.

Parameters
[in]indexindex of the landmarks object.
Returns
Span of Landmarks5.
See Also
Span and Landmarks5 for details.
Note
all spans should be based on user owned continuous collections.
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
DetectionType
virtual Span<const Landmarks68> fsdk::IFaceDetectionBatch::getLandmarks68 ( size_t  index = 0) const
pure virtualnoexcept

Returns Landmarks68 Span.

Parameters
[in]indexindex of the landmarks object.
Returns
Span of Landmarks68.
See Also
Span and Landmarks68 for details.
Note
all spans should be based on user owned continuous collections.
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
DetectionType
virtual size_t fsdk::IFaceDetectionBatch::getSize ( ) const
pure virtualnoexcept

Returns size.

Returns
size of the detections.
virtual size_t fsdk::IFaceDetectionBatch::getSize ( size_t  imageIndex) const
pure virtualnoexcept

Returns size of the results for the target index.

Parameters
[in]imageIndexindex of the image.
Returns
size of the results for the target index.

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