Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
Classes | Typedefs | Functions
c interface
Alignment

Classes

struct  face_sdk__alignment
 Alignment operation prepares images for further FIR building and age and gender classification. More...
 

Typedefs

typedef struct face_sdk__alignment face_sdk__alignment_t
 Alignment operation prepares images for further FIR building and age and gender classification. More...
 

Functions

bool face_sdk__alignment__get_addr (const face_sdk__alignment_t *alignment, uint64_t *addr)
 Retrieves face_sdk__alignment_t object address * *. More...
 
bool face_sdk__alignment__calc_alignment (const face_sdk__alignment_t *alignment, const face_sdk__face_set_t *face_set, face_sdk__alignment_info_set_t **alignment_info_set)
 Performs alignment operation on specified face set. More...
 
bool face_sdk__alignment__get_version (const face_sdk__alignment_t *alignment, uint32_t *value)
 Algorithm's version. See Alignment versions. More...
 
bool face_sdk__alignment__is_compatible (const face_sdk__alignment_t *alignment, uint32_t detector_version, bool *value)
 Function helps you to Face Detector and Alignment algorithms versions compatibility. See versions_compatibility. More...
 
bool face_sdk__make_alignment (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__alignment_t **alignment)
 Makes face_sdk__alignment object with needed version, license, data container, batch size and compute device. More...
 
bool face_sdk__make_alignment_1 (uint32_t version, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, face_sdk__alignment_t **alignment)
 Makes face_sdk__alignment object with needed version, data container, batch size and compute device. The license is loaded from known paths (see Known paths). More...
 
bool face_sdk__make_alignment_2 (uint32_t version, const face_sdk__license_t *license, uint32_t batch_size, int32_t compute_device, face_sdk__alignment_t **alignment)
 Makes face_sdk__alignment object with needed version, license, batch_size and compute_device. The data container is loaded from known paths (see Known paths). More...
 
bool face_sdk__make_alignment_3 (uint32_t version, uint32_t batch_size, int32_t compute_device, face_sdk__alignment_t **alignment)
 Makes face_sdk__alignment object with needed version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths). More...
 
bool face_sdk__make_alignment_4 (uint32_t version, const face_sdk__license_t *license, face_sdk__alignment_t **alignment)
 Makes face_sdk__alignment object with needed version and license. Other required parameters are loaded from known paths (see Known paths). More...
 
bool face_sdk__make_alignment_5 (uint32_t version, face_sdk__alignment_t **alignment)
 Makes face_sdk__alignment object with needed version. Other required parameters are loaded from known paths (see Known paths). More...
 
void face_sdk__alignment_free (face_sdk__alignment_t *alignment)
 Destroys face_sdk__alignment object. More...
 

Detailed Description

Module aligns an input image after detection stage for the following template extraction on Builder module.
Be aware that Alignment module can work incorrectly if you send the image with several faces on it.
Alignment algorithm can contains quality assessment parameter, which give internal assessment if there is a face on the image or not, but it`s up to the SDK user how to work with this parameter (to use it or not).

Typedef Documentation

◆ face_sdk__alignment_t

typedef struct face_sdk__alignment face_sdk__alignment_t

Alignment operation prepares images for further FIR building and age and gender classification.

The result of alignment operation is aligned image prepared for further processing. Different Alignment algorithm versions can generate different types of aligned images with can cause incompatibility between alignment and builder, and age&gender algorithms. Use make_alignment() functions for instantiating of alignment object. See Available algorightm versions and versions compatibility.

Function Documentation

◆ face_sdk__alignment__calc_alignment()

bool face_sdk__alignment__calc_alignment ( const face_sdk__alignment_t *  alignment,
const face_sdk__face_set_t *  face_set,
face_sdk__alignment_info_set_t **  alignment_info_set 
)

Performs alignment operation on specified face set.

Parameters
[in]alignmentface_sdk__alignment object made with face_sdk__make_alignment() function
[in]face_setSet of faces to process
[out]alignment_info_setSet of alignment info objects
Returns
true on success, false on failure. See last_error

◆ face_sdk__alignment__get_addr()

bool face_sdk__alignment__get_addr ( const face_sdk__alignment_t *  alignment,
uint64_t *  addr 
)

Retrieves face_sdk__alignment_t object address * *.

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

◆ face_sdk__alignment__get_version()

bool face_sdk__alignment__get_version ( const face_sdk__alignment_t *  alignment,
uint32_t *  value 
)

Algorithm's version. See Alignment versions.

Parameters
[in]alignmentface_sdk__alignment object made with face_sdk__make_alignment() function
[out]valueAlgorithm version
Returns
true on success, false on failure. See last_error

◆ face_sdk__alignment__is_compatible()

bool face_sdk__alignment__is_compatible ( const face_sdk__alignment_t *  alignment,
uint32_t  detector_version,
bool *  value 
)

Function helps you to Face Detector and Alignment algorithms versions compatibility. See versions_compatibility.

Parameters
[in]alignmentface_sdk__alignment object made with face_sdk__make_alignment() function
[in]detector_versionFace Detector version to check
[out]valueTrue if compatible, false if not compatible
Returns
true on success, false on failure. See last_error

◆ face_sdk__alignment_free()

void face_sdk__alignment_free ( face_sdk__alignment_t *  alignment)

Destroys face_sdk__alignment object.

Parameters
[in]alignmentface_sdk__alignment object made with face_sdk__make_alignment() function

◆ face_sdk__make_alignment()

bool face_sdk__make_alignment ( 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__alignment_t **  alignment 
)

Makes face_sdk__alignment object with needed version, license, data container, batch size and compute device.

Parameters
[in]versionRequired version of the algorithm. See Alignment versions.
[in]licenseThe license object. See Licensing.
[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]alignmentAlignment object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_alignment_1()

bool face_sdk__make_alignment_1 ( uint32_t  version,
const face_sdk__data_container_t *  container,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__alignment_t **  alignment 
)

Makes face_sdk__alignment object with needed 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 Alignment 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]alignmentAlignment object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_alignment_2()

bool face_sdk__make_alignment_2 ( uint32_t  version,
const face_sdk__license_t *  license,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__alignment_t **  alignment 
)

Makes face_sdk__alignment object with needed 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 Alignment 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]alignmentAlignment object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_alignment_3()

bool face_sdk__make_alignment_3 ( uint32_t  version,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__alignment_t **  alignment 
)

Makes face_sdk__alignment object with needed 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 Alignment versions.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[out]alignmentAlignment object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_alignment_4()

bool face_sdk__make_alignment_4 ( uint32_t  version,
const face_sdk__license_t *  license,
face_sdk__alignment_t **  alignment 
)

Makes face_sdk__alignment object with needed version and license. Other required parameters are loaded from known paths (see Known paths).

Parameters
[in]versionRequired version of the algorithm. See Alignment versions
[in]licenseThe license object. See Licensing
[out]alignmentAlignment object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_alignment_5()

bool face_sdk__make_alignment_5 ( uint32_t  version,
face_sdk__alignment_t **  alignment 
)

Makes face_sdk__alignment object with needed version. Other required parameters are loaded from known paths (see Known paths).

Parameters
[in]versionRequired version of the algorithm. See Alignment versions
[out]alignmentAlignment object
Returns
true on success, false on failure. See last_error
Generated by   doxygen 1.8.14