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

MedicalMask estimator interface. More...

#include <IMedicalMaskEstimator.h>

Inheritance diagram for fsdk::IMedicalMaskEstimator:
fsdk::IRefCounted

Public Member Functions

virtual Result< FSDKErrorestimate (const Image &warp, MedicalMaskEstimation &estimation) const noexcept=0
 Estimate MedicalMask probabilities. More...
 
virtual Result< FSDKErrorestimate (const Image &warp, MedicalMaskEstimationExtended &estimation) const noexcept=0
 Estimate MedicalMask probabilities. More...
 
virtual Result< FSDKErrorestimate (const Image &image, const Detection &detection, MedicalMaskEstimation &estimation) const noexcept=0
 Estimate MedicalMask probabilities. More...
 
virtual Result< FSDKErrorestimate (const Image &image, const Detection &detection, MedicalMaskEstimationExtended &estimation) const noexcept=0
 Estimate MedicalMask probabilities. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > warps, Span< MedicalMaskEstimation > estimations) const noexcept=0
 Estimate Medical Mask probabilities. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > warps, Span< MedicalMaskEstimationExtended > estimations) const noexcept=0
 Estimate Medical Mask probabilities. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > images, Span< const Detection > detections, Span< MedicalMaskEstimation > estimations) const noexcept=0
 Estimate Medical Mask probabilities. More...
 
virtual Result< FSDKErrorestimate (Span< const Image > images, Span< const Detection > detections, Span< MedicalMaskEstimationExtended > estimations) const noexcept=0
 Estimate Medical Mask probabilities. More...
 
virtual Result< FSDKErrorvalidate (Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0
 Validate input of multiple frames in a single function call. More...
 
virtual Result< FSDKErrorvalidate (Span< const Image > images, Span< const Detection > detections, Span< Result< FSDKError >> errors) const noexcept=0
 Validate input of multiple frames in a single function call. 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

MedicalMask estimator interface.

Note
Estimator predicts mask.

Member Function Documentation

virtual Result<FSDKError> fsdk::IMedicalMaskEstimator::estimate ( const Image warp,
MedicalMaskEstimation estimation 
) const
pure virtualnoexcept

Estimate MedicalMask probabilities.

Parameters
[in]warpimage with warped face.
[out]estimationestimation results.
Returns
Result with error code.
See Also
MedicalMaskEstimation, Image, Result and FSDKError for details.
Note
images format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::IMedicalMaskEstimator::estimate ( const Image warp,
MedicalMaskEstimationExtended estimation 
) const
pure virtualnoexcept

Estimate MedicalMask probabilities.

Parameters
[in]warpimage with warped face.
[out]estimationestimation results.
Returns
Result with error code.
See Also
MedicalMaskEstimationExtended, Image, Result and FSDKError for details.
Note
images format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::IMedicalMaskEstimator::estimate ( const Image image,
const Detection detection,
MedicalMaskEstimation estimation 
) const
pure virtualnoexcept

Estimate MedicalMask probabilities.

Parameters
[in]imagesource image.
[in]detectiondetection coordinates in image space.
[out]estimationestimation results.
Returns
Result with error code.
See Also
MedicalMaskEstimation, Detection, Image, Result and FSDKError for details.
Note
images format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::IMedicalMaskEstimator::estimate ( const Image image,
const Detection detection,
MedicalMaskEstimationExtended estimation 
) const
pure virtualnoexcept

Estimate MedicalMask probabilities.

Parameters
[in]imagesource image.
[in]detectiondetection coordinates in image space.
[out]estimationestimation results.
Returns
Result with error code.
See Also
MedicalMaskEstimationExtended, Detection, Image, Result and FSDKError for details.
Note
images format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::IMedicalMaskEstimator::estimate ( Span< const Image warps,
Span< MedicalMaskEstimation estimations 
) const
pure virtualnoexcept

Estimate Medical Mask probabilities.

Parameters
[in]warpsspan of images with warped faces.
[out]estimationsspan of estimations.
Returns
Result with error code.
See Also
Span, MedicalMaskEstimation, 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 Result<FSDKError> fsdk::IMedicalMaskEstimator::estimate ( Span< const Image warps,
Span< MedicalMaskEstimationExtended estimations 
) const
pure virtualnoexcept

Estimate Medical Mask probabilities.

Parameters
[in]warpsspan of images with warped faces.
[out]estimationsspan of estimations.
Returns
Result with error code.
See Also
Span, MedicalMaskEstimationExtended, 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 Result<FSDKError> fsdk::IMedicalMaskEstimator::estimate ( Span< const Image images,
Span< const Detection detections,
Span< MedicalMaskEstimation estimations 
) const
pure virtualnoexcept

Estimate Medical Mask probabilities.

Parameters
[in]imagesspan of source images.
[in]detectionsspan of detection coordinates in corresponding source images space.
[out]estimationsspan of estimations.
Returns
Result with error code.
See Also
Span, Detection, MedicalMaskEstimation, 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 Result<FSDKError> fsdk::IMedicalMaskEstimator::estimate ( Span< const Image images,
Span< const Detection detections,
Span< MedicalMaskEstimationExtended estimations 
) const
pure virtualnoexcept

Estimate Medical Mask probabilities.

Parameters
[in]imagesspan of source images;
[in]detectionsspan of detection coordinates in corresponding source images space.
[out]estimationsspan of estimations;
Returns
Result with error code.
See Also
Span, Detection, MedicalMaskEstimationExtended, 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 Result<FSDKError> fsdk::IMedicalMaskEstimator::validate ( Span< const Image warps,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

Validate input of multiple frames in a single function call.

Parameters
[in]warpsspan of images with warped faces.
[out]errorsoutput span of errors for each image.
Returns
Result with error code.
See Also
Span, 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 Result<FSDKError> fsdk::IMedicalMaskEstimator::validate ( Span< const Image images,
Span< const Detection detections,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

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.
[out]errorsoutput span of errors for each image.
Returns
Result with error code.
See Also
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: