c interface

Classes
struct	face_sdk__face_detector
	Face detection algorithm. The Face detection find faces on images. More...

Typedefs
typedef struct face_sdk__face_detector	face_sdk__face_detector_t
	Face detection algorithm. The Face detection find faces on images. More...

Functions
bool	face_sdk__face_detector__get_addr (const face_sdk__face_detector_t *face_detector, uint64_t *addr)
	Retrieves face_sdk__face_detector_t object address * *. More...
bool	face_sdk__face_detector__detect_faces (const face_sdk__face_detector_t *face_detector, const face_sdk__image_set_t *image_set, float confidence, face_sdk__set_of_face_sets_t **set_of_face_sets)
	Detect faces on specified images. More...
bool	face_sdk__face_detector__get_version (const face_sdk__face_detector_t *face_detector, uint32_t *value)
	Face detector version. See Face Detector versions. More...
bool	face_sdk__make_face_detector (uint32_t version, const face_sdk__license_t *license, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, face_sdk__face_detector_t **face_detector)
	Makes face_sdk__face_detector object with specified version, license, data container, batch size and compute_device. More...
bool	face_sdk__make_face_detector_1 (uint32_t version, const face_sdk__license_t *license, uint32_t batch_size, int32_t compute_device, face_sdk__face_detector_t **face_detector)
	Makes face_sdk__face_detector object with specified version, license, batch size and compute device. The data container is loaded from known paths (see Known paths). More...
bool	face_sdk__make_face_detector_2 (uint32_t version, const face_sdk__data_container_t *container, uint32_t batch_size, int32_t compute_device, face_sdk__face_detector_t **face_detector)
	Makes face_sdk__face_detector object with specified version, data container, batch size and compute device. The license is loaded from known paths (see Known paths). More...
bool	face_sdk__make_face_detector_3 (uint32_t version, uint32_t batch_size, int32_t compute_device, face_sdk__face_detector_t **face_detector)
	Makes face_sdk__face_detector object with specified version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths). More...
void	face_sdk__face_detector_free (face_sdk__face_detector_t *face_detector)
	Destroys face_sdk__face_detector object. More...

Detailed Description

Module detects faces on the image and returns array of objects, where every object is coordinates of the boundary and confidence parameter.
Confidence parameter is the internal assessment of the detection error possibility (where 0 - definitely detection error, 1 - definitely a face).
In case of finding several faces on the image, Face detector returns several objects.
Following use case scenario is up to SDK user: user can send all detected objects to the following recognition, choose one of them based on boundary, confidence parameter or both.
Recommended value of float confidence parameter (confidence threshold) = 0.6 for Face detector 101, 0.4 for Face detector 100

Typedef Documentation

face_sdk__face_detector_t

typedef struct face_sdk__face_detector face_sdk__face_detector_t

Face detection algorithm. The Face detection find faces on images.

Use face_sdk__make_face_detector() function to instantiate face_sdk__face_detector

Function Documentation

face_sdk__face_detector__detect_faces()

bool face_sdk__face_detector__detect_faces	(	const face_sdk__face_detector_t *	face_detector,
		const face_sdk__image_set_t *	image_set,
		float	confidence,
		face_sdk__set_of_face_sets_t **	set_of_face_sets
	)

Detect faces on specified images.

Parameters

[in]	face_detector	face_sdk__face_detector object made with face_sdk__make_face_detector() function
[in]	image_set	Set of images for face detection
[in]	confidence	Confidence threshold
[out]	set_of_face_sets	Set of sets of faces detected on each image from image_set. One set of faces per image grouped into set of sets

Returns

true on success, false on failure. See last_error

face_sdk__face_detector__get_addr()

bool face_sdk__face_detector__get_addr	(	const face_sdk__face_detector_t *	face_detector,
		uint64_t *	addr
	)

Retrieves face_sdk__face_detector_t object address * *.

Parameters

[in]	face_detector	face_sdk__face_detector_t object *
[out]	addr	Object address * *

Returns

true on success, false on failure. See last_error

face_sdk__face_detector__get_version()

bool face_sdk__face_detector__get_version	(	const face_sdk__face_detector_t *	face_detector,
		uint32_t *	value
	)

Face detector version. See Face Detector versions.

Parameters

[in]	face_detector	face_sdk__face_detector object made with face_sdk__make_face_detector() function
[out]	value	Face Detector version

Returns

true on success, false on failure. See last_error

face_sdk__face_detector_free()

void face_sdk__face_detector_free

(

face_sdk__face_detector_t *

face_detector

)

Destroys face_sdk__face_detector object.

Parameters

[in]

face_detector

face_sdk__face_detector object made with face_sdk__make_face_detector() function

face_sdk__make_face_detector()

bool face_sdk__make_face_detector	(	uint32_t	version,
		const face_sdk__license_t *	license,
		const face_sdk__data_container_t *	container,
		uint32_t	batch_size,
		int32_t	compute_device,
		face_sdk__face_detector_t **	face_detector
	)

Makes face_sdk__face_detector object with specified version, license, data container, batch size and compute_device.

Parameters

[in]	version	Required version of the algorithm. See Face Detector versions.
[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.
[out]	face_detector	Face Detector object

Returns

true on success, false on failure. See last_error

face_sdk__make_face_detector_1()

bool face_sdk__make_face_detector_1	(	uint32_t	version,
		const face_sdk__license_t *	license,
		uint32_t	batch_size,
		int32_t	compute_device,
		face_sdk__face_detector_t **	face_detector
	)

Makes face_sdk__face_detector object with specified version, license, batch size and compute device. The data container is loaded from known paths (see Known paths).

Parameters

[in]	version	Required version of the algorithm. See Face Detector 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]	face_detector	Face Detector object

Returns

true on success, false on failure. See last_error

face_sdk__make_face_detector_2()

bool face_sdk__make_face_detector_2	(	uint32_t	version,
		const face_sdk__data_container_t *	container,
		uint32_t	batch_size,
		int32_t	compute_device,
		face_sdk__face_detector_t **	face_detector
	)

Makes face_sdk__face_detector object with specified version, data container, batch size and compute device. The license is loaded from known paths (see Known paths).

Parameters

[in]	version	Required version of the algorithm. See Face Detector versions.
[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.
[out]	face_detector	Face Detector object

Returns

true on success, false on failure. See last_error

face_sdk__make_face_detector_3()

bool face_sdk__make_face_detector_3	(	uint32_t	version,
		uint32_t	batch_size,
		int32_t	compute_device,
		face_sdk__face_detector_t **	face_detector
	)

Makes face_sdk__face_detector object with specified version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths).

Parameters

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

Returns

true on success, false on failure. See last_error