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

Crowd estimator interface. More...

#include <ICrowdEstimator.h>

Inheritance diagram for fsdk::ICrowdEstimator:
fsdk::IRefCounted

Public Types

enum  EstimationRequest { estimateHeadCount = 0, estimateHeadCountAndCoords = 1 << 0 }
 EstimationRequest lists all possible estimation types that ICrowdEstimator can estimate. More...
 

Public Member Functions

virtual Result< FSDKErrorestimate (const Image &image, const Rect &rect, CrowdEstimation &estimation, EstimationRequest request=EstimationRequest::estimateHeadCount) const noexcept=0
 Estimates the crowd on the target image. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > images, Span< const Rect > rects, Span< CrowdEstimation > estimations, EstimationRequest request=EstimationRequest::estimateHeadCount) const noexcept=0
 Estimates the the crowd on multiple images in a single estimate function call. More...
 
virtual Result< FSDKErrorvalidate (Span< const Image > images, Span< const Rect > rects, Span< Result< FSDKError >> errors, EstimationRequest request=EstimationRequest::estimateHeadCount) const noexcept=0
 Validate input of multiple frames in a single function call. More...
 
virtual CrowdEstimatorType getType () const noexcept=0
 Returns a type of the estimator. 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

Crowd estimator interface.

Note
This estimator is designed to work with an image or with a batch of images. Crowd estimator returns the number and center coordinates of people heads on the image.
See Also
CrowdEstimation for output details.

Member Enumeration Documentation

EstimationRequest lists all possible estimation types that ICrowdEstimator can estimate.

Enumerator
estimateHeadCount 

Get number of peoples (heads)

estimateHeadCountAndCoords 

Get number of people (heads) and head coordinates.

Member Function Documentation

virtual Result<FSDKError> fsdk::ICrowdEstimator::estimate ( const Image image,
const Rect rect,
CrowdEstimation estimation,
EstimationRequest  request = EstimationRequest::estimateHeadCount 
) const
pure virtualnoexcept

Estimates the crowd on the target image.

Parameters
[in]imagesource image. Format must be R8G8B8.
[in]rectrectangle of interest in the image.
[out]estimationestimation of crowd.
[in]requestEstimationRequest structure.
See Also
CrowdEstimation for details
Returns
Result with error code.
See Also
CrowdEstimation, Image, Rect, Result and FSDKError for details.
virtual Result<FSDKError> fsdk::ICrowdEstimator::estimate ( Span< const Image images,
Span< const Rect rects,
Span< CrowdEstimation estimations,
EstimationRequest  request = EstimationRequest::estimateHeadCount 
) const
pure virtualnoexcept

Estimates the the crowd on multiple images in a single estimate function call.

Parameters
[in]imagesspan of source images. Format must be R8G8B8.
[in]rectsinput rectangles of interest (ROI) span.
[out]estimationsoutput CrowdEstimation span.
[in]requestEstimationRequest structure.
See Also
CrowdEstimation for details
Returns
Result with error code.
See Also
Span, CrowdEstimation, Image, Rect, 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 CrowdEstimatorType fsdk::ICrowdEstimator::getType ( ) const
pure virtualnoexcept

Returns a type of the estimator.

Returns
Type of the estimator.
See Also
CrowdEstimatorType
virtual Result<FSDKError> fsdk::ICrowdEstimator::validate ( Span< const Image images,
Span< const Rect rects,
Span< Result< FSDKError >>  errors,
EstimationRequest  request = EstimationRequest::estimateHeadCount 
) const
pure virtualnoexcept

Validate input of multiple frames in a single function call.

Parameters
[in]imagesspan of source images.
[in]rectsspan of rectangle coordinates of corresponding source images.
[out]errorsoutput span of errors for each image.
[in]requestEstimationRequest structure.
Returns
Result with error code.
See Also
Span, Image, Rect, 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: