C++ EKYC API¶

oneML module to run ekyc pipeline.

struct oneML::face::EKYCOps¶

Operations on EKYC input image.

Public Members

bool blur_check = false¶: Whether to run image blur check.

bool face_blur_check = false¶: Whether to run face blur check.

bool pad_check = false¶: Whether to run digital and paper pad checks.

bool pose_check = false¶: Whether to run face pose check.

class oneML::face::EKYC : public oneML::oneMLAPI¶

The oneML EKYC API object.

Class to create and use oneML EKYC module.

Public Functions

explicit EKYC(oneML::LicenseManager &manager)¶

Construct a EKYC object.

Parameters

manager: LicenseManager instance

explicit EKYC(FaceDetector &face_detector, FaceEmbedder &face_embedder, oneML::LicenseManager &manager)¶

Construct a EKYC object.

Parameters

face_detector: FaceDetector instance
face_embedder: FaceEmbedder instance
manager: LicenseManager instance

explicit EKYC(FaceEmbedder &face_embedder, oneML::LicenseManager &manager)¶

Construct a EKYC object.

Parameters

face_embedder: FaceEmbedder instance
manager: LicenseManager instance

explicit EKYC(FaceDetector &face_detector, oneML::LicenseManager &manager)¶

Construct a EKYC object.

Parameters

face_detector: FaceDetector instance
manager: LicenseManager instance

ReturnStatus run(oneML::Image &image1, oneML::Image &image2, const EKYCOps &image1_ops, const EKYCOps &image2_ops, EKYCResult &result)¶

Run EKYC pipeline.

Return

ReturnStatus

Parameters

[in] image1: oneML::Image object
[in] image2: oneML::Image object
[in] image1_ops: EKYCOps for image1
[in] image2_ops: EKYCOps for image2
[out] result: EKYCResult object

ReturnStatus run(oneML::Image &image1, oneML::Image &image2, const EKYCOps &image1_ops, const EKYCOps &image2_ops, float same_person_dist_threshold, EKYCResult &result)¶

Run EKYC pipeline.

Return

ReturnStatus

Parameters

[in] image1: oneML::Image object
[in] image2: oneML::Image object
[in] image1_ops: EKYCOps for image1
[in] image2_ops: EKYCOps for image2
[in] same_person_dist_threshold: same person distance threshold
[out] result: EKYCResult object

class oneML::face::EKYCResult : public oneML::oneMLResult¶

The result object for oneML EKYC API.

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

Public Functions

float get_distance() const¶

returns distance between the two input images

Return: float

bool is_same_person() const¶

Return whether the two input images are the same person.

Return: bool

void get_bboxes(BBox &bbox1, BBox &bbox2) const¶

Get the image1 and image2 cropped face BBox objects.

Parameters

[out] bbox1: BBox of the cropped face in image1
[out] bbox2: BBox of the cropped face in image2

void get_bbox_scores(float &score1, float &score2) const¶

Get the image1 and image2 cropped face BBox scores.

Parameters

[out] score1: BBox score of the cropped face in image1
[out] score2: BBox score of the cropped face in image2

void get_landmarks(FaceLandmark5 &landmarks1, FaceLandmark5 &landmarks2) const¶

Get the image1 and image2 cropped face FaceLandmark5 objects.

Parameters

[out] landmarks1: cropped face landmarks in image1
[out] landmarks2: cropped face landmarks in image2

void get_face_poses(Pose &pose1, Pose &pose2) const¶

Get the image1 and image2 cropped face Pose objects.

Parameters

[out] pose1: cropped face Pose in image1
[out] pose2: cropped face Pose in image2

oneML::face::EKYCStatus get_return_status() const¶

get return status

Return: return status

enum oneML::face::EKYCStatus¶

EKYCStatus enum to use as return status.

Values:

enumerator Empty¶: Default return status.

enumerator Success¶: Success.

enumerator ImageBlurCheckFail¶: Blurry image check fail.

enumerator DigitalPadFail¶: Digital pad spoof fail.

enumerator PaperPadFail¶: Paper pad spoof fail.

enumerator NoFaceFound¶: No face detected.

enumerator FaceBlurCheckFail¶: Blurry detected face.

enumerator FaceNotFrontal¶: Face is not frontal.