c interface

Modules
	Quality checker initializer
	Check result
	Check result set

Classes
struct	face_sdk__quality_checker
	Quality checker algorithm. Calculates quality of the given face_set. More...

Typedefs
typedef struct face_sdk__quality_checker	face_sdk__quality_checker_t
	Quality checker algorithm. Calculates quality of the given face_set. More...

Functions
bool	face_sdk__quality_checker__get_addr (const face_sdk__quality_checker_t *quality_checker, uint64_t *addr)
	Retrieves face_sdk__quality_checker_t object address * *. More...
bool	face_sdk__quality_checker__check_faces (const face_sdk__quality_checker_t *quality_checker, const face_sdk__face_set_t *face_set, face_sdk__quality_check_result_set_t **result_set)
	The function calculates images quality of the given face_set. More...
bool	face_sdk__quality_checker__is_compatible (const face_sdk__quality_checker_t *quality_checker, uint32_t detector_version, bool *value)
	Function helps you to determine Quality and Face Detector algorithms versions compatibility. See versions_compatibility. More...
bool	face_sdk__make_quality_checker (uint32_t version, const face_sdk__license_t *license, const face_sdk__quality_initializer_t *initializer, uint32_t batch_size, int32_t compute_device, face_sdk__quality_checker_t **quality_checker)
	Makes face_sdk__quality_checker object with needed version, license, batch size and compute device. More...
bool	face_sdk__make_quality_checker_1 (uint32_t version, const face_sdk__license_t *license, uint32_t batch_size, int32_t compute_device, face_sdk__quality_checker_t **quality_checker)
	Makes face_sdk__quality_checker object with needed version, license, batch size and compute device. More...
bool	face_sdk__make_quality_checker_2 (uint32_t version, uint32_t batch_size, int32_t compute_device, face_sdk__quality_checker_t **quality_checker)
	Makes face_sdk__quality_checker object with needed version, batch size and compute device. More...
bool	face_sdk__make_quality_checker_3 (uint32_t version, const face_sdk__quality_initializer_t *initializer, uint32_t batch_size, int32_t compute_device, face_sdk__quality_checker_t **quality_checker)
	Makes face_sdk__quality_checker object with needed version, license, batch size and compute device. More...
void	face_sdk__quality_checker_free (face_sdk__quality_checker_t *quality_checker)
	Destroys face_sdk__quality_checker object. More...

Detailed Description

Module classifies image quality.

Typedef Documentation

face_sdk__quality_checker_t

typedef struct face_sdk__quality_checker face_sdk__quality_checker_t

Quality checker algorithm. Calculates quality of the given face_set.

Use face_sdk__make_quality_checker() functions to instantiate quality_checker.

Function Documentation

face_sdk__make_quality_checker()

bool face_sdk__make_quality_checker	(	uint32_t	version,
		const face_sdk__license_t *	license,
		const face_sdk__quality_initializer_t *	initializer,
		uint32_t	batch_size,
		int32_t	compute_device,
		face_sdk__quality_checker_t **	quality_checker
	)

Makes face_sdk__quality_checker object with needed version, license, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Quality checker versions.
[in]	license	The license object. See Licensing.
[in]	initializer	Structure that describe algorithms you want to use.
[in]	batch_size	The batch size. See Batching.
[in]	compute_device	The compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[out]	quality_checker	Quality Checker object

Returns

true on success, false on failure. See last_error

face_sdk__make_quality_checker_1()

bool face_sdk__make_quality_checker_1	(	uint32_t	version,
		const face_sdk__license_t *	license,
		uint32_t	batch_size,
		int32_t	compute_device,
		face_sdk__quality_checker_t **	quality_checker
	)

Makes face_sdk__quality_checker object with needed version, license, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Quality checker versions.
[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.
[out]	quality_checker	Quality Checker object

Returns

true on success, false on failure. See last_error

face_sdk__make_quality_checker_2()

bool face_sdk__make_quality_checker_2	(	uint32_t	version,
		uint32_t	batch_size,
		int32_t	compute_device,
		face_sdk__quality_checker_t **	quality_checker
	)

Makes face_sdk__quality_checker object with needed version, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Quality checker versions.
[in]	batch_size	The batch size. See Batching.
[in]	compute_device	The compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[out]	quality_checker	Quality Checker object

Returns

true on success, false on failure. See last_error

face_sdk__make_quality_checker_3()

bool face_sdk__make_quality_checker_3	(	uint32_t	version,
		const face_sdk__quality_initializer_t *	initializer,
		uint32_t	batch_size,
		int32_t	compute_device,
		face_sdk__quality_checker_t **	quality_checker
	)

Makes face_sdk__quality_checker object with needed version, license, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Quality checker versions.
[in]	initializer	Structure that describe algorithms you want to use.
[in]	batch_size	The batch size. See Batching.
[in]	compute_device	The compute device. -1 = CPU. 0, 1, ..., N - GPU device.
[out]	quality_checker	Quality Checker object

Returns

true on success, false on failure. See last_error

face_sdk__quality_checker__check_faces()

bool face_sdk__quality_checker__check_faces	(	const face_sdk__quality_checker_t *	quality_checker,
		const face_sdk__face_set_t *	face_set,
		face_sdk__quality_check_result_set_t **	result_set
	)

The function calculates images quality of the given face_set.

Parameters

[in]	quality_checker	face_sdk__quality_checker object made with face_sdk__make_quality_checker() function
[in]	faces	Vector of the face objects.
[out]	result_set	Set of quality_check_result objects

face_sdk__quality_checker__get_addr()

bool face_sdk__quality_checker__get_addr	(	const face_sdk__quality_checker_t *	quality_checker,
		uint64_t *	addr
	)

Retrieves face_sdk__quality_checker_t object address * *.

Parameters

[in]	quality_checker	face_sdk__quality_checker_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__quality_checker__is_compatible()

bool face_sdk__quality_checker__is_compatible	(	const face_sdk__quality_checker_t *	quality_checker,
		uint32_t	detector_version,
		bool *	value
	)

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

Parameters

[in]	quality_checker	face_sdk__quality_checker object made with face_sdk__make_quality_checker() function
[in]	detector_version	Face Detector version to check
[out]	value	True if compatible, false if not compatible

Returns

true on success, false on failure. See last_error

face_sdk__quality_checker_free()

void face_sdk__quality_checker_free

(

face_sdk__quality_checker_t *

quality_checker

)

Destroys face_sdk__quality_checker object.

Parameters

[in]

quality_checker

face_sdk__quality_checker object made with face_sdk__make_quality_checker() function