cpp interface

Classes
class	face_sdk::liveness_result
	The liveness_result object. The result object can be casted to specific liveness depending on liveness algorithm version. For example, the result can be casted to face_sdk::livenes_102_result if it obtained from liveness version 102. More...
class	face_sdk::liveness_config
	Liveness config. Each liveness version its own config. Use specific factory functions to make configuration for each liveness version. For example, to make config for liveness 102 use face_sdk::make_liveness_102_config() More...
class	face_sdk::liveness
	The liveness detection algorithm. Detects spoof attacks. More...
class	face_sdk::liveness_102_result
	The result of liveness 102 algorithm. More...
class	face_sdk::liveness_102_config
	The config for liveness 102 algorithm. More...

Typedefs
typedef std::vector< std::shared_ptr< liveness_result > >	face_sdk::liveness_result_set
typedef std::vector< std::shared_ptr< liveness_102_result > >	face_sdk::liveness_102_result_set

Functions
std::shared_ptr< liveness >	face_sdk::make_liveness (uint32_t version, const std::shared_ptr< liveness_config > &config, uint32_t batch_size, int32_t compute_device)
	Makes liveness with specified version, config, batch size and compute device. More...
std::shared_ptr< liveness >	face_sdk::make_liveness (uint32_t version, const std::shared_ptr< liveness_config > &config, const std::shared_ptr< face_sdk::license > &license, uint32_t batch_size, int32_t compute_device)
	Makes liveness with specified version, config, license, batch size and compute device. More...
std::shared_ptr< liveness >	face_sdk::make_liveness (uint32_t version, const std::shared_ptr< liveness_config > &config, const std::shared_ptr< face_sdk::data_container > &container, uint32_t batch_size, int32_t compute_device)
	Makes liveness with specified version, config, data container, batch size and compute device. More...
std::shared_ptr< liveness >	face_sdk::make_liveness (uint32_t version, const std::shared_ptr< liveness_config > &config, const std::shared_ptr< face_sdk::license > &license, const std::shared_ptr< face_sdk::data_container > &container, uint32_t batch_size, int32_t compute_device)
	Makes liveness with specified version, config, license, data container, batch size and compute device. More...
std::shared_ptr< liveness_102_config >	face_sdk::make_liveness_102_config (float threshold1, float threshold2, float threshold3)
	Makes config for liveness 102 with specified thresholds.
std::shared_ptr< liveness_102_config >	face_sdk::make_liveness_102_default_config ()
	Makes config for liveness 102 with default thresholds.
std::vector< std::shared_ptr< liveness_102_result > >	face_sdk::liveness_results_102_cast (const std::vector< std::shared_ptr< liveness_result >> &liveness_results)
	Casts face_sdk::liveness_result to face_sdk::liveness_102_result. More...

Detailed Description

Module detects spoof attacks

Function Documentation

liveness_results_102_cast()

std::vector<std::shared_ptr<liveness_102_result> > face_sdk::liveness_results_102_cast

(

const std::vector< std::shared_ptr< liveness_result >> &

liveness_results

)

Casts face_sdk::liveness_result to face_sdk::liveness_102_result.

Exceptions

std::bad_cast

in case of faulted casting

make_liveness() [1/4]

std::shared_ptr<liveness> face_sdk::make_liveness	(	uint32_t	version,
		const std::shared_ptr< liveness_config > &	config,
		uint32_t	batch_size,
		int32_t	compute_device
	)

Makes liveness with specified version, config, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Liveness versions
[in]	config	Liveness config. Depends on liveness version. Use corresponded factory functions to make config.
[in]	batch_size	The batch size. See Batching.
[in]	compute_device	The compute device. -1 = CPU. 0, 1, ..., N - GPU device.

Exceptions

face_sdk::exception

See Exceptions handling.

make_liveness() [2/4]

std::shared_ptr<liveness> face_sdk::make_liveness	(	uint32_t	version,
		const std::shared_ptr< liveness_config > &	config,
		const std::shared_ptr< face_sdk::license > &	license,
		uint32_t	batch_size,
		int32_t	compute_device
	)

Makes liveness with specified version, config, license, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Liveness versions
[in]	config	Liveness config. Depends on liveness version. Use corresponded factory functions to make config.
[in]	license	The license object. See Licensing.
[in]	batch_size	The batch size. See Batching.
[in]	compute_device	The compute device. -1 = CPU. 0, 1, ..., N - GPU device.

Exceptions

face_sdk::exception

See Exceptions handling.

make_liveness() [3/4]

std::shared_ptr<liveness> face_sdk::make_liveness	(	uint32_t	version,
		const std::shared_ptr< liveness_config > &	config,
		const std::shared_ptr< face_sdk::data_container > &	container,
		uint32_t	batch_size,
		int32_t	compute_device
	)

Makes liveness with specified version, config, data container, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Liveness versions
[in]	config	Liveness config. Depends on liveness version. Use corresponded factory functions to make config.
[in]	container	The container with algorithm data.
[in]	batch_size	The batch size. See Batching.
[in]	compute_device	The compute device. -1 = CPU. 0, 1, ..., N - GPU device.

Exceptions

face_sdk::exception

See Exceptions handling.

make_liveness() [4/4]

std::shared_ptr<liveness> face_sdk::make_liveness	(	uint32_t	version,
		const std::shared_ptr< liveness_config > &	config,
		const std::shared_ptr< face_sdk::license > &	license,
		const std::shared_ptr< face_sdk::data_container > &	container,
		uint32_t	batch_size,
		int32_t	compute_device
	)

Makes liveness with specified version, config, license, data container, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Liveness versions
[in]	config	Liveness config. Depends on liveness version. Use corresponded factory functions to make config.
[in]	license	The license object. See Licensing.
[in]	container	The container with algorithm data.
[in]	batch_size	The batch size. See Batching.
[in]	compute_device	The compute device. -1 = CPU. 0, 1, ..., N - GPU device.

Exceptions

face_sdk::exception

See Exceptions handling.