Classes
class	face_sdk::fir_list
	List of FIRs for matching. More...

class	face_sdk::fir_matcher
	The FIRs matcher. FIRs matcher compares FIRs to each other. It allows to perform 1:1 and 1:N matching. More...

class	face_sdk::fir_matcher_factory
	Abstract factory for creation of matcher components (fir_list, fir_matcher) More...

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

Enumerations
enum	match { FIR_INDEX = 0, MATCH_SCRORE = 1 }

enum	face_sdk::architecture_type { COMMON = 0, NUMA }
	Abstract factory for creation of matcher components (fir, fir_list, fir_matcher)

Functions
std::shared_ptr< face_sdk::fir_list > FACE_SDK_EXPORT	face_sdk::make_fir_list ()
	Makes the empty face_sdk::fir_list.

std::shared_ptr< face_sdk::fir_list > FACE_SDK_EXPORT	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_EXPORT	face_sdk::is_architecture_available (const architecture_type type)
	Checks for architecture availability. More...

std::shared_ptr< face_sdk::fir_matcher > FACE_SDK_EXPORT	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_EXPORT	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_EXPORT	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_EXPORT	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 specified builder version, FAR table, license object. The license will be loaded from known paths (see Known paths). More...

std::shared_ptr< face_sdk::fir_matcher > FACE_SDK_EXPORT	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...

float FACE_SDK_EXPORT	face_sdk::score_to_percentage (float score)
	Converts score to percentage. {#fir_matcher_score_to_percentage}. More...

float FACE_SDK_EXPORT	face_sdk::percentage_to_score (float percentage)
	Converts percentage to score. More...

virtual std::shared_ptr< face_sdk::fir_list >	face_sdk::fir_matcher_factory::make_fir_list () const =0
	Creates empty fir list fir_list. More...

virtual std::shared_ptr< face_sdk::fir_matcher >	face_sdk::fir_matcher_factory::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< license > &license, const std::shared_ptr< face_sdk::data_container > &container) const =0
	Makes FIRs matcher with needed builder version, FAR table code, license object and data container. More...

virtual std::shared_ptr< face_sdk::fir_matcher >	face_sdk::fir_matcher_factory::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< face_sdk::data_container > &container) const =0
	Makes FIRs matcher with needed builder version, FAR table code and data container. More...

virtual std::shared_ptr< face_sdk::fir_matcher >	face_sdk::fir_matcher_factory::make_fir_matcher (uint32_t builder_version, const std::string &table_code, const std::shared_ptr< license > &license) const =0
	Makes FIRs matcher with needed builder version, FAR table code and license object. More...

virtual std::shared_ptr< face_sdk::fir_matcher >	face_sdk::fir_matcher_factory::make_fir_matcher (uint32_t builder_version, const std::string &table_code) const =0
	Makes FIRs matcher with needed builder version and FAR table code. More...

std::shared_ptr< fir_matcher_factory > FACE_SDK_EXPORT	face_sdk::make_fir_factory (const architecture_type type)
	Makes fir_factory that dependance on type. More...

Detailed Description

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

Function Documentation

◆ is_architecture_available()

bool FACE_SDK_EXPORT face_sdk::is_architecture_available ( const architecture_type type )

Checks for architecture availability.

◆ make_fir_factory()

std::shared_ptr<fir_matcher_factory> FACE_SDK_EXPORT face_sdk::make_fir_factory ( const architecture_type type )

Makes fir_factory that dependance on 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_list()

virtual std::shared_ptr<face_sdk::fir_list> face_sdk::fir_matcher_factory::make_fir_list ( ) const

pure virtual

Creates empty fir list fir_list.

Returns: Pointer to empty FIR list.

◆ make_fir_matcher() [1/9]

std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT 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() [2/9]

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

pure virtual

Makes FIRs matcher with needed builder version and FAR table code.

Parameters

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

Returns: Pointer to fir matcher Matcher.

◆ make_fir_matcher() [3/9]

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

pure virtual

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

Parameters

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

Returns: Pointer to fir matcher Matcher.

◆ make_fir_matcher() [4/9]

std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT 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 specified builder version, FAR table, license object. The license 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() [5/9]

std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT 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]	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() [6/9]

std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT 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]	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() [7/9]

std::shared_ptr<face_sdk::fir_matcher> FACE_SDK_EXPORT 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]	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.

Examples: complex.cpp.

◆ make_fir_matcher() [8/9]

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

pure virtual

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

Parameters

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

Returns: Pointer to fir matcher Matcher.

◆ make_fir_matcher() [9/9]

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

pure virtual

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

Parameters

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

Returns: Pointer to fir matcher Matcher.

◆ percentage_to_score()

float FACE_SDK_EXPORT 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_EXPORT 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

Classes

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ is_architecture_available()

◆ make_fir_factory()

◆ make_fir_list()

◆ make_fir_matcher() [1/9]

◆ make_fir_matcher() [2/9]

◆ make_fir_matcher() [3/9]

◆ make_fir_matcher() [4/9]

◆ make_fir_matcher() [5/9]

◆ make_fir_matcher() [6/9]

◆ make_fir_matcher() [7/9]

◆ make_fir_matcher() [8/9]

◆ make_fir_matcher() [9/9]

◆ percentage_to_score()

◆ score_to_percentage()