cpp interface

Classes
class	face_sdk::fir_list
	List of FIRs for matching. More...
class	face_sdk::fir_matcher
	Fir matcher compares FIRs against each other. Matcher can perform 1:1 and 1:N matching. More...
class	face_sdk::fir_matcher_factory
	Matcher components factory. Factory creates fir_list and fir_matcher objects. More...
class	face_sdk::fir_matching_score_table
	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. More...

Typedefs
typedef std::tuple< uint32_t, float >	face_sdk::match
typedef std::vector< match >	face_sdk::matches

Enumerations
enum	match_fields { FIR_INDEX = 0, MATCH_SCORE = 1 }
enum	face_sdk::architecture_type { COMMON = 0, NUMA }
	Matcher architecture type.

Functions
std::shared_ptr< face_sdk::fir_list >	face_sdk::make_fir_list ()
	Makes the empty face_sdk::fir_list.
std::shared_ptr< face_sdk::fir_list >	face_sdk::make_fir_list (const face_sdk::architecture_type type)
	Makes the empty face_sdk::fir_list for specified architecture. Use face_sdk::is_architecture_available to check for architecture availability.
bool	face_sdk::is_architecture_available (const architecture_type type)
	Checks for architecture availability. More...
std::shared_ptr< face_sdk::fir_matcher >	face_sdk::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< face_sdk::license > &license, const std::shared_ptr< face_sdk::data_container > &container, const architecture_type type)
	Makes FIRs matcher with needed builder version, FAR table code, license object and data container. More...
std::shared_ptr< face_sdk::fir_matcher >	face_sdk::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< face_sdk::license > &license, const std::shared_ptr< face_sdk::data_container > &container)
	Makes FIRs matcher with needed builder version, FAR table code, license object and data container. More...
std::shared_ptr< face_sdk::fir_matcher >	face_sdk::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< face_sdk::license > &license)
	Makes FIRs matcher with specified builder version, FAR table, license object. The data container will be loaded from known paths (see Known paths). More...
std::shared_ptr< face_sdk::fir_matcher >	face_sdk::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< face_sdk::license > &license, const architecture_type type)
	Makes FIRs matcher with specified builder version, FAR table, license object. The data container will be loaded from known paths (see Known paths). More...
std::shared_ptr< face_sdk::fir_matcher >	face_sdk::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< face_sdk::data_container > &data_container)
	Makes FIRs matcher with needed builder version, FAR table code and data container. License will be loaded from known paths (see Known paths). More...
std::shared_ptr< face_sdk::fir_matcher >	face_sdk::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< face_sdk::data_container > &data_container, const architecture_type type)
	Makes FIRs matcher with needed builder version, FAR table code and data container. License will be loaded from known paths (see Known paths). More...
std::shared_ptr< face_sdk::fir_matcher >	face_sdk::make_fir_matcher (uint32_t builder_version, const std::string &table_code)
	Makes FIRs matcher with specified builder version, FAR table. The license and data container will be loaded from known paths (see Known paths). More...
std::shared_ptr< face_sdk::fir_matcher >	face_sdk::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const architecture_type type)
	Makes FIRs matcher with specified builder version, FAR table. The license and data container will be loaded from known paths (see Known paths). More...
float	face_sdk::score_to_percentage (float score)
	Converts score to percentage. {#fir_matcher_score_to_percentage}. More...
float	face_sdk::percentage_to_score (float percentage)
	Converts percentage to score. More...
std::shared_ptr< fir_matcher_factory >	face_sdk::make_fir_factory (const architecture_type type)
	Makes fir_factory of specified architecture type. More...
std::shared_ptr< fir_matching_score_table >	face_sdk::make_fir_matching_score_table (uint32_t builder_version, const std::string &table_code)
	Makes make_fir_matching_score_table for specified builder and table code. See Matching table codes. More...
std::shared_ptr< fir_matching_score_table >	face_sdk::make_fir_matching_score_table (const std::shared_ptr< face_sdk::data_container > &data_container, uint32_t builder_version, const std::string &table_code)
	Makes make_fir_matching_score_table with specified data_container for specified builder and table code. See Matching table codes. More...
std::shared_ptr< fir_matching_score_table >	face_sdk::make_fir_matching_score_table (const std::shared_ptr< face_sdk::license > &license, const std::shared_ptr< face_sdk::data_container > &data_container, uint32_t builder_version, const std::string &table_code)
	Makes make_fir_matching_score_table with specified license, data_container for builder and table code. See Matching table codes. More...
std::shared_ptr< fir_matching_score_table >	face_sdk::make_fir_matching_score_table (const std::shared_ptr< face_sdk::license > &license, uint32_t builder_version, const std::string &table_code)
	Makes make_fir_matching_score_table with specified license for specified builder and table code. See Matching table codes. More...

Detailed Description

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

Function Documentation

is_architecture_available()

bool face_sdk::is_architecture_available

(

const architecture_type

type

)

Checks for architecture availability.

make_fir_factory()

std::shared_ptr<fir_matcher_factory> face_sdk::make_fir_factory

(

const architecture_type

type

)

Makes fir_factory of specified architecture type.

Parameters

[in]

type

- type of system architecture (NUMA or common) see /ref architecture_type.

Exceptions

face_sdk::invalid_parameter_exception

- invalid argument.

make_fir_matcher() [1/8]

std::shared_ptr<face_sdk::fir_matcher> face_sdk::make_fir_matcher	(	uint32_t	builder_version,
		const std::string &	table_code,
		const std::shared_ptr< face_sdk::license > &	license,
		const std::shared_ptr< face_sdk::data_container > &	container,
		const architecture_type	type
	)

Makes FIRs matcher with needed builder version, FAR table code, license object and data container.

Parameters

[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.
[in]	license	License object
[in]	container	The container with algorithm data.
[in]	type	architecture type. Use face_sdk::is_architecture_available to check for architecture availability.

Exceptions

face_sdk::exception

See Exceptions handling.

Examples:

complex.cpp.

make_fir_matcher() [2/8]

std::shared_ptr<face_sdk::fir_matcher> face_sdk::make_fir_matcher	(	uint32_t	builder_version,
		const std::string &	table_code,
		const std::shared_ptr< face_sdk::license > &	license,
		const std::shared_ptr< face_sdk::data_container > &	container
	)

Makes FIRs matcher with needed builder version, FAR table code, license object and data container.

Parameters

[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.
[in]	license	License object
[in]	container	The container with algorithm data.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matcher() [3/8]

std::shared_ptr<face_sdk::fir_matcher> face_sdk::make_fir_matcher	(	uint32_t	builder_version,
		const std::string &	table_code,
		const std::shared_ptr< face_sdk::license > &	license
	)

Makes FIRs matcher with specified builder version, FAR table, license object. The data container will be loaded from known paths (see Known paths).

Parameters

[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.
[in]	license	License object

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matcher() [4/8]

std::shared_ptr<face_sdk::fir_matcher> face_sdk::make_fir_matcher	(	uint32_t	builder_version,
		const std::string &	table_code,
		const std::shared_ptr< face_sdk::license > &	license,
		const architecture_type	type
	)

Makes FIRs matcher with specified builder version, FAR table, license object. The data container will be loaded from known paths (see Known paths).

Parameters

[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.
[in]	license	License object
[in]	type	architecture type. Use face_sdk::is_architecture_available to check for architecture availability.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matcher() [5/8]

std::shared_ptr<face_sdk::fir_matcher> face_sdk::make_fir_matcher	(	uint32_t	builder_version,
		const std::string &	table_code,
		const std::shared_ptr< face_sdk::data_container > &	data_container
	)

Makes FIRs matcher with needed builder version, FAR table code and data container. License will be loaded from known paths (see Known paths).

Parameters

[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.
[in]	data_container	The container with algorithm data.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matcher() [6/8]

std::shared_ptr<face_sdk::fir_matcher> face_sdk::make_fir_matcher	(	uint32_t	builder_version,
		const std::string &	table_code,
		const std::shared_ptr< face_sdk::data_container > &	data_container,
		const architecture_type	type
	)

Makes FIRs matcher with needed builder version, FAR table code and data container. License will be loaded from known paths (see Known paths).

Parameters

[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.
[in]	data_container	The container with algorithm data.
[in]	type	architecture type. Use face_sdk::is_architecture_available to check for architecture availability.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matcher() [7/8]

std::shared_ptr<face_sdk::fir_matcher> face_sdk::make_fir_matcher	(	uint32_t	builder_version,
		const std::string &	table_code
	)

Makes FIRs matcher with specified builder version, FAR table. The license and data container will be loaded from known paths (see Known paths).

Parameters

[in]	version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matcher() [8/8]

std::shared_ptr<face_sdk::fir_matcher> face_sdk::make_fir_matcher	(	uint32_t	builder_version,
		const std::string &	table_code,
		const architecture_type	type
	)

Makes FIRs matcher with specified builder version, FAR table. The license and data container will be loaded from known paths (see Known paths).

Parameters

[in]	version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.
[in]	type	architecture type. Use face_sdk::is_architecture_available to check for architecture availability.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matching_score_table() [1/4]

std::shared_ptr<fir_matching_score_table> face_sdk::make_fir_matching_score_table	(	uint32_t	builder_version,
		const std::string &	table_code
	)

Makes make_fir_matching_score_table for specified builder and table code. See Matching table codes.

Parameters

[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matching_score_table() [2/4]

std::shared_ptr<fir_matching_score_table> face_sdk::make_fir_matching_score_table	(	const std::shared_ptr< face_sdk::data_container > &	data_container,
		uint32_t	builder_version,
		const std::string &	table_code
	)

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

Parameters

[in]	container	The container with table data.
[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matching_score_table() [3/4]

std::shared_ptr<fir_matching_score_table> face_sdk::make_fir_matching_score_table	(	const std::shared_ptr< face_sdk::license > &	license,
		const std::shared_ptr< face_sdk::data_container > &	data_container,
		uint32_t	builder_version,
		const std::string &	table_code
	)

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

Parameters

[in]	license	The license object. See Licensing.
[in]	container	The container with table data.
[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.

Exceptions

face_sdk::exception

See Exceptions handling.

make_fir_matching_score_table() [4/4]

std::shared_ptr<fir_matching_score_table> face_sdk::make_fir_matching_score_table	(	const std::shared_ptr< face_sdk::license > &	license,
		uint32_t	builder_version,
		const std::string &	table_code
	)

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

Parameters

[in]	license	The license object. See Licensing.
[in]	builder_version	Required version of the Builder algorithm. See Builder versions.
[in]	table_code	See Matching table codes.

Exceptions

face_sdk::exception

See Exceptions handling.

percentage_to_score()

float face_sdk::percentage_to_score

(

float

percentage

)

Converts percentage to score.

Parameters

[in]

percentage

Percentage you want to convert.

Returns

Converted percentage

score_to_percentage()

float face_sdk::score_to_percentage

(

float

score

)

Converts score to percentage. {#fir_matcher_score_to_percentage}.

Parameters

[in]

score

Score you want to convert.

Returns

Converted score