Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
Classes | Typedefs | Functions
Face recognition

Classes

struct  face_sdk__face_recognition
 Class used by tracker class to get the score of the face. More...
 

Typedefs

typedef struct face_sdk__face_recognition face_sdk__face_recognition_t
 Class used by tracker class to get the score of the face. More...
 

Functions

bool face_sdk__face_recognition__get_addr (const face_sdk__face_recognition_t *face_recognition, uint64_t *addr)
 Retrieves face_sdk__face_recognition_t object address * *. More...
 
bool face_sdk__face_recognition__compute_face_score (const face_sdk__face_recognition_t *face_recognition, const face_sdk__image_t *image, float *value)
 The function calculates the score of face, detected on the given image. More...
 
bool face_sdk__face_recognition__get_version (const face_sdk__face_recognition_t *face_recognition, uint32_t *value)
 Algorithm version. See Face Tracker versions. More...
 
bool face_sdk__make_face_recognition (uint32_t version, const face_sdk__license_t *license, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, face_sdk__face_recognition_t **face_recognition)
 Makes the face_sdk::face_recognition object with specified version, license, data container, batch size and compute_device. More...
 
bool face_sdk__make_face_recognition_1 (uint32_t version, const face_sdk__license_t *license, uint32_t batch_size, int32_t compute_device, face_sdk__face_recognition_t **face_recognition)
 Makes the face_sdk::face_recognition object with specified version, license, batch size and compute device. The data container is loaded from known paths (see Known paths). More...
 
bool face_sdk__make_face_recognition_2 (uint32_t version, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, face_sdk__face_recognition_t **face_recognition)
 Makes the face_sdk::face_recognition object with specified version, data container, batch size and compute device. The license is loaded from known paths (see Known paths). More...
 
bool face_sdk__make_face_recognition_3 (uint32_t version, uint32_t batch_size, int32_t compute_device, face_sdk__face_recognition_t **face_recognition)
 Makes the face_sdk::face_recognition object with specified version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths). More...
 
void face_sdk__face_recognition_free (face_sdk__face_recognition_t *face_recognition)
 Destroys face_sdk__face_recognition object. More...
 

Detailed Description

Typedef Documentation

◆ face_sdk__face_recognition_t

Class used by tracker class to get the score of the face.

Function Documentation

◆ face_sdk__face_recognition__compute_face_score()

bool face_sdk__face_recognition__compute_face_score ( const face_sdk__face_recognition_t face_recognition,
const face_sdk__image_t image,
float *  value 
)

The function calculates the score of face, detected on the given image.

Parameters
[in]face_recognitionFace Recognition object made with face_sdk__make_face_recognition() function
[in]imageface_sdk__image object. See Base.
[out]valueFace score
Returns
true on success, false on failure. See last_error

◆ face_sdk__face_recognition__get_addr()

bool face_sdk__face_recognition__get_addr ( const face_sdk__face_recognition_t face_recognition,
uint64_t *  addr 
)

Retrieves face_sdk__face_recognition_t object address * *.

Parameters
[in]face_recognitionface_sdk__face_recognition_t object *
[out]addrObject address * *
Returns
true on success, false on failure. See last_error

◆ face_sdk__face_recognition__get_version()

bool face_sdk__face_recognition__get_version ( const face_sdk__face_recognition_t face_recognition,
uint32_t *  value 
)

Algorithm version. See Face Tracker versions.

Parameters
[in]face_recognitionFace Recognition object made with face_sdk__make_face_recognition() function
[out]valueFace Recognition version
Returns
true on success, false on failure. See last_error

◆ face_sdk__face_recognition_free()

void face_sdk__face_recognition_free ( face_sdk__face_recognition_t face_recognition)

Destroys face_sdk__face_recognition object.

Parameters
[in]face_recognitionFace Recognition object

◆ face_sdk__make_face_recognition()

bool face_sdk__make_face_recognition ( uint32_t  version,
const face_sdk__license_t license,
const face_sdk__data_container_t container,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__face_recognition_t **  face_recognition 
)

Makes the face_sdk::face_recognition object with specified version, license, data container, batch size and compute_device.

Parameters
[in]versionRequired version of the algorithm. See Face Tracker versions.
[in]licenseThe license object. See Licensing.
[in]contanerThe container with algorithm data.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[out]face_recognitionFace Recognition object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_face_recognition_1()

bool face_sdk__make_face_recognition_1 ( uint32_t  version,
const face_sdk__license_t license,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__face_recognition_t **  face_recognition 
)

Makes the face_sdk::face_recognition object with specified version, license, batch size and compute device. The data container is loaded from known paths (see Known paths).

Parameters
[in]versionRequired version of the algorithm. See Face Tracker versions.
[in]licenseThe license object. See Licensing.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[out]face_recognitionFace Recognition object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_face_recognition_2()

bool face_sdk__make_face_recognition_2 ( uint32_t  version,
const face_sdk__data_container_t container,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__face_recognition_t **  face_recognition 
)

Makes the face_sdk::face_recognition object with specified version, data container, batch size and compute device. The license is loaded from known paths (see Known paths).

Parameters
[in]versionRequired version of the algorithm. See Face Tracker versions.
[in]containerThe container with algorithm data.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[out]face_recognitionFace Recognition object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_face_recognition_3()

bool face_sdk__make_face_recognition_3 ( uint32_t  version,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__face_recognition_t **  face_recognition 
)

Makes the face_sdk::face_recognition object with specified version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths).

Parameters
[in]versionRequired version of the algorithm. See Face Tracker versions.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[out]face_recognitionFace Recognition object
Returns
true on success, false on failure. See last_error