Face SDK  1.8.0 Mozart beta
Face Recognition Software Development Kit
Classes | Typedefs | Functions
c interface
Builder

Classes

struct  face_sdk__builder
 Builder algorithm. The Builder algorithm builds FIR for specified aligned faces. More...
 

Typedefs

typedef struct face_sdk__builder face_sdk__builder_t
 Builder algorithm. The Builder algorithm builds FIR for specified aligned faces. More...
 

Functions

bool face_sdk__builder__get_addr (const face_sdk__builder_t *builder, uint64_t *addr)
 Retrieves face_sdk__builder_t object address. More...
 
bool face_sdk__builder__build (const face_sdk__builder_t *builder, const face_sdk__alignment_info_set_t *alignment_info_set, face_sdk__fir_set_t **fir_set)
 Build FIRs for specified aligned faces. More...
 
bool face_sdk__builder__build_1 (const face_sdk__builder_t *builder, const face_sdk__face_set_t *face_set, face_sdk__fir_set_t **fir_set)
 Build FIRs for specified faces. More...
 
bool face_sdk__builder__get_version (const face_sdk__builder_t *builder, uint32_t *value)
 Algorithm version. See Builder versions. More...
 
bool face_sdk__builder__is_compatible (const face_sdk__builder_t *builder, uint32_t alignment_version, bool *value)
 Deprecated, use face_sdk__builder__is_compatible_with_alignment()
 
bool face_sdk__builder__is_compatible_with_detector (const face_sdk__builder_t *builder, uint32_t detector_version, bool *value)
 Function helps you to determine Face Detector and Builder algorithms versions compatibility. See versions_compatibility. More...
 
bool face_sdk__builder__is_compatible_with_alignment (const face_sdk__builder_t *builder, uint32_t alignment_version, bool *value)
 Function helps you to determine Alignment and Builder algorithms versions compatibility. See versions_compatibility. More...
 
bool face_sdk__builder__produces_short_firs (const face_sdk__builder_t *builder, bool *value)
 Retrieves face_sdk__builder fir type. More...
 
bool face_sdk__make_builder (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__builder_t **builder)
 Makes the face_sdk::builder object with specified version, license, data container, batch size and compute_device. More...
 
bool face_sdk__make_builder_1 (uint32_t version, const face_sdk__license_t *license, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, bool produce_short_firs, face_sdk__builder_t **builder)
 Makes the face_sdk::builder object with specified version, license, data container, batch size, compute device and fir type. More...
 
bool face_sdk__make_builder_2 (uint32_t version, const face_sdk__license_t *license, uint32_t batch_size, int32_t compute_device, face_sdk__builder_t **builder)
 Makes the face_sdk::builder 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_builder_3 (uint32_t version, const face_sdk__license_t *license, uint32_t batch_size, int32_t compute_device, bool produce_short_firs, face_sdk__builder_t **builder)
 Makes the face_sdk::builder object with specified version, license, batch size, compute device and fir type. The data container is loaded from known paths (see Known paths). More...
 
bool face_sdk__make_builder_4 (uint32_t version, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, face_sdk__builder_t **builder)
 Makes the face_sdk::builder 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_builder_5 (uint32_t version, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, bool produce_short_firs, face_sdk__builder_t **builder)
 Makes the face_sdk::builder 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_builder_6 (uint32_t version, uint32_t batch_size, int32_t compute_device, face_sdk__builder_t **builder)
 Makes the face_sdk__builder object with specified 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_builder_7 (uint32_t version, uint32_t batch_size, int32_t compute_device, bool produce_short_firs, face_sdk__builder_t **builder)
 Makes the face_sdk__builder object with specified version, batch size, compute device and fir type. The data container and the license are loaded from known paths (see Known paths). More...
 
void face_sdk__builder_free (face_sdk__builder_t *builder)
 Destroys face_sdk__builder object. More...
 

Detailed Description

Module extracts biometric templates (FIRs) from images, received after alignment.
Builder module has no assessment and extract template from any input, even if there is not face on the image.
Builder module is compatible with the same version of Fir Matcher!
Builder 100 requires Fir Matcher 100, Builder 101 requires Fir Matcher 101, etc

Typedef Documentation

◆ face_sdk__builder_t

typedef struct face_sdk__builder face_sdk__builder_t

Builder algorithm. The Builder algorithm builds FIR for specified aligned faces.

Use face_sdk__make_builder() function to instantiate face_sdk__builder.

Function Documentation

◆ face_sdk__builder__build()

bool face_sdk__builder__build ( const face_sdk__builder_t *  builder,
const face_sdk__alignment_info_set_t *  alignment_info_set,
face_sdk__fir_set_t **  fir_set 
)

Build FIRs for specified aligned faces.

Parameters
[in]builderface_sdk__builder object made with face_sdk__make_builder() function
[in]alignment_info_setSet of alignment_info object to process
[out]fir_setSet of fir objects
Returns
true on success, false on failure. See last_error

◆ face_sdk__builder__build_1()

bool face_sdk__builder__build_1 ( const face_sdk__builder_t *  builder,
const face_sdk__face_set_t *  face_set,
face_sdk__fir_set_t **  fir_set 
)

Build FIRs for specified faces.

Warning
implemented only in builder versions > 210
Parameters
[in]builderface_sdk__builder object made with face_sdk__make_builder() function
[in]face_setSet of faces to process
[out]fir_setSet of fir objects
Returns
true on success, false on failure. See last_error

◆ face_sdk__builder__get_addr()

bool face_sdk__builder__get_addr ( const face_sdk__builder_t *  builder,
uint64_t *  addr 
)

Retrieves face_sdk__builder_t object address.

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

◆ face_sdk__builder__get_version()

bool face_sdk__builder__get_version ( const face_sdk__builder_t *  builder,
uint32_t *  value 
)

Algorithm version. See Builder versions.

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

◆ face_sdk__builder__is_compatible_with_alignment()

bool face_sdk__builder__is_compatible_with_alignment ( const face_sdk__builder_t *  builder,
uint32_t  alignment_version,
bool *  value 
)

Function helps you to determine Alignment and Builder algorithms versions compatibility. See versions_compatibility.

Parameters
[in]builderface_sdk__builder object made with face_sdk__make_builder() function
[in]alignment_versionAlignment algorithm version to check
[out]valueTrue if builder is compatible with alignment_version, false if not
Returns
true on success, false on failure. See last_error

◆ face_sdk__builder__is_compatible_with_detector()

bool face_sdk__builder__is_compatible_with_detector ( const face_sdk__builder_t *  builder,
uint32_t  detector_version,
bool *  value 
)

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

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

◆ face_sdk__builder__produces_short_firs()

bool face_sdk__builder__produces_short_firs ( const face_sdk__builder_t *  builder,
bool *  value 
)

Retrieves face_sdk__builder fir type.

Parameters
[in]builderface_sdk__builder object made with face_sdk__make_builder() function
[out]valueTrue if builder produces short firs, false if float-based firs are produced
Returns
true on success, false on failure. See last_error

◆ face_sdk__builder_free()

void face_sdk__builder_free ( face_sdk__builder_t *  builder)

Destroys face_sdk__builder object.

Parameters
[in]builderface_sdk__builder object made with face_sdk__make_builder() function

◆ face_sdk__make_builder()

bool face_sdk__make_builder ( 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__builder_t **  builder 
)

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

Parameters
[in]versionRequired version of the algorithm. See Builder 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.
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_builder_1()

bool face_sdk__make_builder_1 ( uint32_t  version,
const face_sdk__license_t *  license,
const face_sdk__data_container_t *  container,
uint32_t  batch_size,
int32_t  compute_device,
bool  produce_short_firs,
face_sdk__builder_t **  builder 
)

Makes the face_sdk::builder object with specified version, license, data container, batch size, compute device and fir type.

Parameters
[in]versionRequired version of the algorithm. See Builder 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.
[in]produce_short_firsif true builder makes short fir version as output
[out]builderface_sdk__builder object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_builder_2()

bool face_sdk__make_builder_2 ( uint32_t  version,
const face_sdk__license_t *  license,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__builder_t **  builder 
)

Makes the face_sdk::builder 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 Builder 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.
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_builder_3()

bool face_sdk__make_builder_3 ( uint32_t  version,
const face_sdk__license_t *  license,
uint32_t  batch_size,
int32_t  compute_device,
bool  produce_short_firs,
face_sdk__builder_t **  builder 
)

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

Parameters
[in]versionRequired version of the algorithm. See Builder 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.
[in]produce_short_firsif true builder makes short fir version as output
[out]builderface_sdk__builder object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_builder_4()

bool face_sdk__make_builder_4 ( uint32_t  version,
const face_sdk__data_container_t *  container,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__builder_t **  builder 
)

Makes the face_sdk::builder 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 Builder 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.
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_builder_5()

bool face_sdk__make_builder_5 ( uint32_t  version,
const face_sdk__data_container_t *  container,
uint32_t  batch_size,
int32_t  compute_device,
bool  produce_short_firs,
face_sdk__builder_t **  builder 
)

Makes the face_sdk::builder 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 Builder 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.
[in]produce_short_firsif true builder makes short fir version as output
[out]builderface_sdk__builder object
Returns
true on success, false on failure. See last_error

◆ face_sdk__make_builder_6()

bool face_sdk__make_builder_6 ( uint32_t  version,
uint32_t  batch_size,
int32_t  compute_device,
face_sdk__builder_t **  builder 
)

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

◆ face_sdk__make_builder_7()

bool face_sdk__make_builder_7 ( uint32_t  version,
uint32_t  batch_size,
int32_t  compute_device,
bool  produce_short_firs,
face_sdk__builder_t **  builder 
)

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

Parameters
[in]versionRequired version of the algorithm. See Builder versions.
[in]batch_sizeThe batch size. See Batching.
[in]compute_deviceThe compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[in]produce_short_firsif true builder makes short fir version as output
[out]builderface_sdk__builder object
Returns
true on success, false on failure. See last_error
Generated by   doxygen 1.8.14