Face Engine SDK  5.17.0
A face detection, recognition and tracking engine.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Public Member Functions | List of all members
fsdk::IBlackWhiteEstimator Struct Referenceabstract
Estimators
Inheritance diagram for fsdk::IBlackWhiteEstimator:
fsdk::IRefCounted

Public Member Functions

virtual Result< FSDKError > estimate (const Image &image, bool &outIsGrayscale) const noexcept=0
 Check if image is grayscale or color. More...
 
virtual Result< FSDKError > estimate (const Image &warp, ImageColorEstimation &estimation) const noexcept=0
 Estimates if image is color, grayscale or infrared. More...
 
virtual Result< FSDKError > estimate (Span< const Image > warps, Span< ImageColorEstimation > estimations) const noexcept=0
 Estimates if images are color, grayscale or infrared. More...
 
virtual Result< FSDKError > validate (Span< const Image > warps, Span< Result< FSDKError >> errors) const noexcept=0
 Validates 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...
 

Member Function Documentation

virtual Result<FSDKError> fsdk::IBlackWhiteEstimator::estimate ( const Image &  image,
bool &  outIsGrayscale 
) const
pure virtualnoexcept

Check if image is grayscale or color.

Parameters
[in]imagesource image.
[out]outIsGrayscaleestimation result; true if image is grayscale, false if not.
Returns
Result with error code.
See Also
Image, Result and FSDKError for details.
Note
image format must be R8G8B8,
See Also
Format.
virtual Result<FSDKError> fsdk::IBlackWhiteEstimator::estimate ( const Image &  warp,
ImageColorEstimation &  estimation 
) const
pure virtualnoexcept

Estimates if image is color, grayscale or infrared.

Parameters
[in]warpimage with warped face.
[out]estimationestimation.
Returns
Result with error code.
See Also
ImageColorEstimation, Image, Result and FSDKError for details.
Note
warp format must be R8G8B8 or R8,
See Also
Format.
virtual Result<FSDKError> fsdk::IBlackWhiteEstimator::estimate ( Span< const Image >  warps,
Span< ImageColorEstimation >  estimations 
) const
pure virtualnoexcept

Estimates if images are color, grayscale or infrared.

Parameters
[in]warpsspan of images with warped faces.
[out]estimationsarray of estimations.
Returns
Result with error code.
See Also
Span, ImageColorEstimation, Image, Result and FSDKError for details.
Note
warps format must be R8G8B8 or R8,
See Also
Format.
Note
all spans should be based on user owned continuous collections.
all spans should be equal size.
virtual Result<FSDKError> fsdk::IBlackWhiteEstimator::validate ( Span< const Image >  warps,
Span< Result< FSDKError >>  errors 
) const
pure virtualnoexcept

Validates 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
warps format must be R8G8B8 or R8,
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: