Python Face Pad API

oneML model for Presentation Attack Detection (PAD)

oneML.faceAPI.FacePad : public object

The oneML FacePad API object. 

Class to create and use oneML face pad model.

Public Functions

__init__(self, type, manager)

Construct a FacePad object.

Parameters

classify_batch(self, imgvec_, spoof_threshold=- 1.0)

Classify images as spoof or not spoof.

Return

FacePadResultVector: list of FacePadResult objects

Parameters

  • imgvec_: numpy array with shape (batch, height, width, channel)

  • spoof_threshold: spoof threshold, -1.0 means default threshould

classify(self, imgvec_, spoof_threshold=- 1.0)

Classify an image as spoof or not spoof.

Return

FacePadResult: result object

Parameters

  • imgvec_: numpy array with shape (height, width, channel)

  • spoof_threshold: spoof threshold, -1.0 means default threshould

oneML.faceAPI.FacePadResult : public object

The result object for oneML FacePad API. 

Helper class to access all the results from
an API call.

Public Functions

get_spoof_prob(self)

Get spoof probability.

Return

float: spoof probability

is_spoof(self)

Check if result is spoof or not.

Return

bool: true if image is spoof or false if image is not spoof

get_return_status(self)

Get return status.

Return

int: return status

oneML.faceAPI.FacePadResultVector : public object
List of FacePadResult objects.
oneML.faceAPI.FacePadStatus_Empty = _oneMLfacePython.FacePadStatus_Empty
oneML.faceAPI.FacePadStatus_Success = _oneMLfacePython.FacePadStatus_Success
oneML.faceAPI.PadType_Rgb = _oneMLfacePython.PadType_Rgb
oneML.faceAPI.FacePadStatus_DigitalPadFail = _oneMLfacePython.FacePadStatus_DigitalPadFail
oneML.faceAPI.PadType_Paper = _oneMLfacePython.PadType_Paper
oneML.faceAPI.FacePadStatus_PaperPadFail = _oneMLfacePython.FacePadStatus_PaperPadFail