Matching score table

Classes
struct	face_sdk__fir_matching_score_table

Typedefs
typedef struct face_sdk__fir_matching_score_table	face_sdk__fir_matching_score_table_t

Functions
bool	face_sdk__fir_matching_score_table__get_addr (const face_sdk__fir_matching_score_table_t *fir_matching_score_table, uint64_t *addr)
	Retrieves face_sdk__fir_matching_score_table_t object address * *. More...
bool	face_sdk__fir_matching_score_table__distance_to_score (const face_sdk__fir_matching_score_table_t *handle, double distance, uint32_t firs_num, float *score)
bool	face_sdk__make_fir_matching_score_table (uint32_t builder_version, const uint8_t *table_code, uint64_t table_code_size, face_sdk__fir_matching_score_table_t **handle)
bool	face_sdk__make_fir_matching_score_table1 (face_sdk__data_container_t *data_container, uint32_t builder_version, const uint8_t *table_code, uint64_t table_code_size, face_sdk__fir_matching_score_table_t **handle)
	Makes face_sdk__fir_matching_score_table with specified data_container for specified builder and table code. See Matching table codes. More...
bool	face_sdk__make_fir_matching_score_table2 (face_sdk__license_t *license, face_sdk__data_container_t *data_container, uint32_t builder_version, const uint8_t *table_code, uint64_t table_code_size, face_sdk__fir_matching_score_table_t **handle)
	Makes face_sdk__fir_matching_score_table with specified with specified license, data_container for specified builder and table code. See Matching table codes. More...
bool	face_sdk__make_fir_matching_score_table3 (face_sdk__license_t *license, uint32_t builder_version, const uint8_t *table_code, uint64_t table_code_size, face_sdk__fir_matching_score_table_t **handle)
	Makes face_sdk__fir_matching_score_table with specified with specified license for specified builder and table code. See Matching table codes. More...
void	face_sdk__fir_matching_score_table_free (face_sdk__fir_matching_score_table_t *handle)
	Destroys face_sdk__fir_matching_score_table. More...

Detailed Description

Module compares FIRs and returns the result, which the coefficient equivalent -logFAR.

Typedef Documentation

face_sdk__fir_matching_score_table_t

typedef struct face_sdk__fir_matching_score_table face_sdk__fir_matching_score_table_t

The object translates L2 distance between FIRs to -logFAR score which is used in FaceSDK. Note, that for translation you should use different translation table for every version of Builder. See Matching table codes. Note, FaceSDK doesn't expose functions to calculate L2 distance, you can only calculate it yourself and validate against -logFAR score provided in the FaceSDK.

Function Documentation

face_sdk__fir_matching_score_table__distance_to_score()

bool face_sdk__fir_matching_score_table__distance_to_score	(	const face_sdk__fir_matching_score_table_t *	handle,
		double	distance,
		uint32_t	firs_num,
		float *	score
	)

Translates L2 distance between FIRs to -log(FAR) score.

Parameters

[in]	hadle	face_sdk__fir_matching_score_table made by face_sdk__make_fir_matching_score_table* functions
[in]	distance	distance between FIRs.
[in]	firs_num	Warning! Use 1 by default. Do not use any other values unless you work with M:1 matching, use Builder 104 and have a clear understanding of these features.
[out]	score	-log(FAR) score for specified distance

Returns

true on success, false on failure. See last_error

face_sdk__fir_matching_score_table__get_addr()

bool face_sdk__fir_matching_score_table__get_addr	(	const face_sdk__fir_matching_score_table_t *	fir_matching_score_table,
		uint64_t *	addr
	)

Retrieves face_sdk__fir_matching_score_table_t object address * *.

Parameters

[in]	fir_matching_score_table	face_sdk__fir_matching_score_table_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__fir_matching_score_table_free()

void face_sdk__fir_matching_score_table_free

(

face_sdk__fir_matching_score_table_t *

handle

)

Destroys face_sdk__fir_matching_score_table.

Parameters

[in]

handle

face_sdk__fir_matching_score_table object

face_sdk__make_fir_matching_score_table1()

bool face_sdk__make_fir_matching_score_table1	(	face_sdk__data_container_t *	data_container,
		uint32_t	builder_version,
		const uint8_t *	table_code,
		uint64_t	table_code_size,
		face_sdk__fir_matching_score_table_t **	handle
	)

Makes face_sdk__fir_matching_score_table with specified data_container for specified builder and table code. See Matching table codes.

Parameters

[in]	container	The container with algorithm data.
[in]	builder_version	Required version of the Builder algorithm. See Builder versions
[in]	table_code	String containing far table code. See text_encoding, Matching table codes
[in]	table_code_size	Size in bytes of table_code string
[out]	handle	face_sdk__fir_matching_score_table object

Returns

true on success, false on failure. See last_error

face_sdk__make_fir_matching_score_table2()

bool face_sdk__make_fir_matching_score_table2	(	face_sdk__license_t *	license,
		face_sdk__data_container_t *	data_container,
		uint32_t	builder_version,
		const uint8_t *	table_code,
		uint64_t	table_code_size,
		face_sdk__fir_matching_score_table_t **	handle
	)

Makes face_sdk__fir_matching_score_table with specified with specified license, data_container for specified builder and table code. See Matching table codes.

Parameters

[in]	license	License object
[in]	container	The container with algorithm data.
[in]	builder_version	Required version of the Builder algorithm. See Builder versions
[in]	table_code	String containing far table code. See text_encoding, Matching table codes
[in]	table_code_size	Size in bytes of table_code string
[out]	handle	face_sdk__fir_matching_score_table object

Returns

true on success, false on failure. See last_error

face_sdk__make_fir_matching_score_table3()

bool face_sdk__make_fir_matching_score_table3	(	face_sdk__license_t *	license,
		uint32_t	builder_version,
		const uint8_t *	table_code,
		uint64_t	table_code_size,
		face_sdk__fir_matching_score_table_t **	handle
	)

Makes face_sdk__fir_matching_score_table with specified with specified license for specified builder and table code. See Matching table codes.

Parameters

[in]	license	License object
[in]	builder_version	Required version of the Builder algorithm. See Builder versions
[in]	table_code	String containing far table code. See text_encoding, Matching table codes
[in]	table_code_size	Size in bytes of table_code string
[out]	handle	face_sdk__fir_matching_score_table object

Returns

true on success, false on failure. See last_error