Java Face ID API

oneML model for face verification and face identification.

class org::sertiscorp::oneml::face::FaceId

Public Functions

inline synchronized void delete ()

Gracefully destroy the object and free memory.

inline FaceId(LicenseManager manager)

Construct a FaceId object.

Parameters

  • manager: LicenseManager instance.

inline FaceId(FaceEmbedder embedder, LicenseManager manager)

Construct a FaceId object.

Parameters

  • embedder: FaceEmbedder instance.

  • manager: LicenseManager instance.

inline FaceIdResultList predict(ImageBatch imgs)

makes a prediction.

Return

an instance of FaceIdResultList.

Parameters

inline FaceIdResultList predict(ImageBatch imgs, float same_person_dist_threshold)

makes a prediction.

Return

an instance of FaceIdResultList.

Parameters

  • imgs: an instance of ImageBatch.

  • same_person_dist_threshold: same person dist threshold

inline FaceIdResult predict(Image img)

makes a prediction.

Return

an instance of FaceIdResult.

Parameters

  • img: an instance of Image.

inline FaceIdResult predict(Image img, float same_person_dist_threshold)

makes a prediction.

Return

an instance of FaceIdResult.

Parameters

  • img: an instance of Image.

  • same_person_dist_threshold: same person dist threshold

inline boolean isTheSamePerson(Image img1, Image img2)

checks whether the two Image’s are of the same person.

Return

bool.

Parameters

  • img1: Image of the first person to compare.

  • img2: Image of the second person to compare.

inline boolean isTheSamePerson(Image img1, Image img2, float same_person_dist_threshold)

checks whether the two Image’s are of the same person.

Return

bool.

Parameters

  • img1: Image of the first person to compare.

  • img2: Image of the second person to compare.

  • same_person_dist_threshold: same person dist threshold

inline SamePersonResult isTheSamePerson (float[] face_emb, Image img)

checks whether the given embedding face_emb is the same person as the one in Image.

Return

an instance of SamePersonResult..

Parameters

  • face_emb: an embedding representing the registered user.

  • img: Image of the second person to compare.

inline SamePersonResult isTheSamePerson (float[] face_emb, Image img, float same_person_dist_threshold)

checks whether the given embedding face_emb is the same person as the one in Image.

Return

an instance of SamePersonResult..

Parameters

  • face_emb: an embedding representing the registered user.

  • img: Image of the second person to compare.

  • same_person_dist_threshold: same person dist threshold

inline int registerId (String id, float[] face_emb)

registers an id with embedding face_emb.

Return

an embedding size.

Parameters

  • id: string id of the registered user.

  • face_emb: an embedding representing the registered user.

inline Embedding registerId(String id, ImageBatch imgs, boolean avg_emb)

registers an id with an ImageBatch.

Return

an instance of EmbeddingList.

Parameters

  • id: string id of the registered user.

  • imgs: a batch of images representing the registered user.

  • avg_emb: a boolean whether to average all images in ImageBatch as face embedding.

inline Embedding registerId(String id, Image img)

registers an id with an Image.

Return

an instance of Embedding.

Parameters

  • id: string id of the registered user.

  • img: an image representing the registered user.

inline IdList getIds()

gets all user ids in the gallery.

Return

an instance of IdList representing all user ids in the gallery.

class org::sertiscorp::oneml::face::FaceIdResult

Public Functions

inline synchronized void delete ()

Gracefully destroy the object and free memory.

inline int getReturnStatus()

returns return status.

Return

an int return status.

org::sertiscorp::oneml::face::FaceIdResultList : public java::util::AbstractList< FaceIdResult > , public java.util.RandomAccess

Public Functions

inline synchronized void delete ()

Gracefully destroy the object and free memory.

namespace org::sertiscorp::oneml::face
enum FaceIdStatus

Public Members

Empty =(FaceJNI.FaceIdStatus_Empty_get())
Success =(FaceJNI.FaceIdStatus_Success_get())
Fail =(FaceJNI.FaceIdStatus_Fail_get())