C++ Face Pad API¶
oneML model for Presentation Attack Detection (PAD)
-
class
oneML::face::FacePad: public oneML::oneMLAPI¶ The oneML FacePad API object.
Class to create and use oneML face pad model.
Public Functions
-
explicit
FacePad(PadType type, oneML::LicenseManager &manager)¶ Construct a FacePad object of type PadType.
- Parameters
type: type PadType enummanager: LicenseManager instance
-
ReturnStatus
classify(const MultiImage &imgs, std::vector<FacePadResult> &results)¶ classify images as spoof or not spoof
- Return
ReturnStatus: status of operation
- Parameters
[in] imgs: vector of raw images[out] results: vector of result objects
-
ReturnStatus
classify(const MultiImage &imgs, float spoof_threshold, std::vector<FacePadResult> &results)¶ classify images as spoof or not spoof
- Return
ReturnStatus: status of operation
- Parameters
[in] imgs: vector of raw images[in] spoof_threshold: spoof threshold[out] results: vector of result objects
-
ReturnStatus
classify(const Image &img, FacePadResult &result)¶ classify an image as spoof or not spoof
- Return
ReturnStatus: status of operation
- Parameters
[in] img: raw image[out] result: result object
-
ReturnStatus
classify(const Image &img, float spoof_threshold, FacePadResult &result)¶ classify an image as spoof or not spoof
- Return
ReturnStatus: status of operation
- Parameters
[in] img: raw image[in] spoof_threshold: spoof threshold[out] result: result object
-
explicit
-
class
oneML::face::FacePadResult: public oneML::oneMLResult¶ The result object for oneML FacePad API.
Helper class to access all the results from an API call.
Public Functions
-
float
get_spoof_prob() const¶ get spoof probability
- Return
float: spoof probability
-
bool
is_spoof() const¶ check if result is spoof or not
- Return
bool: true if image is spoof or false if image is not spoof
-
oneML::face::FacePadStatus
get_return_status() const¶ get return status
- Return
return status
-
float