Face Engine SDK  5.17.0
A face detection, recognition and tracking engine.
fsdk::IBestShotQualityEstimator Struct Reference

BestShotQuality estimator interface. More...

#include <IBestShotQualityEstimator.h>

Inheritance diagram for fsdk::IBestShotQualityEstimator:
fsdk::IRefCounted

List of all members.

Classes

struct  EstimationResult
 BestShotQualityEstimator output structure. More...

Public Types

enum  EstimationRequest { estimateAGS = 1 << 0, estimateHeadPose = 1 << 1, estimateAll = 0xffff }
 EstimationRequest lists all possible estimation attributes that BestShotQuality estimator is able to estimate. More...

Public Member Functions

virtual Result< FSDKErrorestimate (const Image &image, const Detection &detection, const EstimationRequest request, EstimationResult &result) const noexcept=0
 Estimate unified AGS and HeadPose attributes.
virtual Result< FSDKErrorestimate (Span< const Image > images, Span< const Detection > detections, const EstimationRequest request, Span< EstimationResult > results) const noexcept=0
 Estimate unified AGS and HeadPose attributes of multiple frames in a single estimate function call.
virtual EstimationBatchFuture estimateAsync (Span< const Image > images, Span< const Detection > detections, const EstimationRequest request) const =0
 Asynchronously estimate unified AGS and HeadPose attributes of multiple frames in a single estimate function call.
virtual Result< FSDKErrorvalidate (Span< const Image > images, Span< const Detection > detections, const EstimationRequest request, Span< Result< FSDKError >> errors) const noexcept=0
 Validate input of multiple frames in a single function call.

Detailed Description

BestShotQuality estimator interface.

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

Member Enumeration Documentation

EstimationRequest lists all possible estimation attributes that BestShotQuality estimator is able to estimate.

Enumerator:
estimateAGS 

Estimate AGS.

estimateHeadPose 

Estimate HeadPose.

estimateAll 

Make full estimation (all attributes)


Member Function Documentation

virtual Result<FSDKError> fsdk::IBestShotQualityEstimator::estimate ( const Image image,
const Detection detection,
const EstimationRequest  request,
EstimationResult result 
) const [pure virtual]

Estimate unified AGS and HeadPose attributes.

Parameters:
[in]imagesource image;
[in]detectiondetection coordinates in image space;
[in]requestEstimationRequest structure;
[out]resultoutput estimation.
Returns:
Result with error code.
See also:
IBestShotQualityEstimator::EstimationRequest, IBestShotQualityEstimator::EstimationResult, Detection, Image, Result and FSDKError for details.
Note:
image format must be R8G8B8,
See also:
Format.
virtual Result<FSDKError> fsdk::IBestShotQualityEstimator::estimate ( Span< const Image images,
Span< const Detection detections,
const EstimationRequest  request,
Span< EstimationResult results 
) const [pure virtual]

Estimate unified AGS and HeadPose attributes 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.
[in]requestEstimationRequest structure.
[out]resultsspan of estimations.
Returns:
Result with error code.
See also:
IBestShotQualityEstimator::EstimationRequest, IBestShotQualityEstimator::EstimationResult, 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.
virtual EstimationBatchFuture fsdk::IBestShotQualityEstimator::estimateAsync ( Span< const Image images,
Span< const Detection detections,
const EstimationRequest  request 
) const [pure virtual]

Asynchronously estimate unified AGS and HeadPose attributes 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.
[in]requestEstimationRequest structure.
Returns:
Future estimation result object.
See also:
IBestShotQualityEstimator::EstimationRequest, IBestShotQualityEstimator::EstimationResult, Span, Detection, Image, Result, FSDKError and vlc::future 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.
this method is experimental and interface may be changed in the future.
this method is not marked as noexcept and may throw an exception.
virtual Result<FSDKError> fsdk::IBestShotQualityEstimator::validate ( Span< const Image images,
Span< const Detection detections,
const EstimationRequest  request,
Span< Result< FSDKError >>  errors 
) const [pure virtual]

Validate 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.
[in]requestEstimationRequest structure.
[out]errorsoutput span of errors for each image.
Returns:
Result with error code.
See also:
IBestShotQualityEstimator::EstimationRequest, 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:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines