Face SDK  1.14.1 Mozart release
Face Recognition Software Development Kit
Classes | Typedefs | Enumerations | Functions
c interface

Classes

struct  face_sdk__face_selector
 Face selector. Face Selector selects the best face from input set, using specified algorithm. More...
 

Typedefs

typedef struct face_sdk__face_selector face_sdk__face_selector_t
 Face selector. Face Selector selects the best face from input set, using specified algorithm. More...
 

Enumerations

enum  face_sdk__face_selection_algs : uint32_t { widest_face, biggest_confidence, closest_to_img_center }
 Face selection algorithms variants. Use in face_sdk__make_face_selector() functions. More...
 

Functions

bool face_sdk__face_selector__get_addr (const face_sdk__face_selector_t *face_selector, uint64_t *addr)
 Retrieves face_sdk__face_selector_t object address * *. More...
 
bool face_sdk__face_selector__select_face (const face_sdk__face_selector_t *face_selector, const face_sdk__alignment_info_set_t *alignment_info_set, face_sdk__alignment_info_t **alignment_info)
 Select face on specified aligned images. More...
 
bool face_sdk__face_selector__select_face_1 (const face_sdk__face_selector_t *face_selector, const face_sdk__face_set_t *face_set, face_sdk__face_t **face)
 Select face on specified set of faces. More...
 
bool face_sdk__make_face_selector (enum face_sdk__face_selection_algs algorithm, uint32_t face_detector_version, face_sdk__face_selector_t **face_selector)
 Makes the face_sdk::face_selector object with specified algorithm and face detector version. More...
 
void face_sdk__face_selector_free (face_sdk__face_selector_t *face_selector)
 Destroys face_sdk__face_selector object. More...
 

Detailed Description

Module gets set of faces and selects the best one depending on specified algorithm.
You can choose widest_face, biggest_confidence and closest_to_img_center algorithms.

Typedef Documentation

◆ face_sdk__face_selector_t

Face selector. Face Selector selects the best face from input set, using specified algorithm.

Use face_sdk__make_face_selector() function to instantiate Face Selector.

Enumeration Type Documentation

◆ face_sdk__face_selection_algs

Face selection algorithms variants. Use in face_sdk__make_face_selector() functions.

closest_to_img_center can be used only with face detector version > 200.

Enumerator
widest_face 

The widest face will be chosen.

biggest_confidence 

Face with the biggest confidence will be chosen.

closest_to_img_center 

Face closest to the image center will be chosen.

Function Documentation

◆ face_sdk__face_selector__get_addr()

bool face_sdk__face_selector__get_addr ( const face_sdk__face_selector_t face_selector,
uint64_t *  addr 
)

Retrieves face_sdk__face_selector_t object address * *.

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

◆ face_sdk__face_selector__select_face()

bool face_sdk__face_selector__select_face ( const face_sdk__face_selector_t face_selector,
const face_sdk__alignment_info_set_t alignment_info_set,
face_sdk__alignment_info_t **  alignment_info 
)

Select face on specified aligned images.

Parameters
[in]face_selectorface_sdk__face_selector object made with face_sdk__make_face_selector() function
[in]alignment_info_setSet of aligned images. See Alignment.
[out]alignment_infoAlignment info of selected face
Returns
true on success, false on failure. See last_error

◆ face_sdk__face_selector__select_face_1()

bool face_sdk__face_selector__select_face_1 ( const face_sdk__face_selector_t face_selector,
const face_sdk__face_set_t face_set,
face_sdk__face_t **  face 
)

Select face on specified set of faces.

Parameters
[in]face_selectorface_sdk__face_selector object made with face_sdk__make_face_selector() function
[in]face_setSet of detected faces. See Base.
[out]faceSelected face
Returns
true on success, false on failure. See last_error

◆ face_sdk__face_selector_free()

void face_sdk__face_selector_free ( face_sdk__face_selector_t face_selector)

Destroys face_sdk__face_selector object.

Parameters
[in]face_selectorface_sdk__face_selector object made with face_sdk__make_face_selector() function

◆ face_sdk__make_face_selector()

bool face_sdk__make_face_selector ( enum face_sdk__face_selection_algs  algorithm,
uint32_t  face_detector_version,
face_sdk__face_selector_t **  face_selector 
)

Makes the face_sdk::face_selector object with specified algorithm and face detector version.

Parameters
[in]algorithmSelection algorithm
[in]face_detector_versionFace Detector version. See Face Detector versions
[out]face_selectorFace Selector object
Returns
true on success, false on failure. See last_error