Alignment

Classes
class	face_sdk::alignment
	Alignment operation prepares images for further FIR building and age and gender classification. More...

Functions
std::shared_ptr< alignment > FACE_SDK_EXPORT	face_sdk::make_alignment (uint32_t version, const std::shared_ptr< face_sdk::license > &license, const std::shared_ptr< face_sdk::data_container > &contaner, uint32_t batch_size, int32_t compute_device)
	Makes the face_sdk::alignment object with needed version, license, data container, batch size and compute device. More...
std::shared_ptr< alignment > FACE_SDK_EXPORT	face_sdk::make_alignment (uint32_t version, const std::shared_ptr< face_sdk::data_container > &contaner, uint32_t batch_size, int32_t compute_device)
	Makes the face_sdk::alignment object with needed version, data container, batch size and compute device. The license is loaded from known paths (see Known paths). More...
std::shared_ptr< alignment > FACE_SDK_EXPORT	face_sdk::make_alignment (uint32_t version, const std::shared_ptr< face_sdk::license > &license, uint32_t batch_size, int32_t compute_device)
	Makes the face_sdk::alignment object with needed version, license, batch_size and compute_device. The data container is loaded from known paths (see Known paths). More...
std::shared_ptr< alignment > FACE_SDK_EXPORT	face_sdk::make_alignment (uint32_t version, uint32_t batch_size, int32_t compute_device)
	Makes the face_sdk::alignment object with needed version, batch size and compute device. The data container and the license are loaded from known paths (see Known paths). More...
std::shared_ptr< alignment > FACE_SDK_EXPORT	face_sdk::make_alignment (uint32_t version, const std::shared_ptr< face_sdk::license > &license)
	Makes the face_sdk::alignment object with needed version and license. Other required parameters are loaded from known paths (see Known paths). More...
std::shared_ptr< alignment > FACE_SDK_EXPORT	face_sdk::make_alignment (uint32_t version)
	Makes the face_sdk::alignment object with needed version. Other required parameters are loaded from known paths (see Known paths). More...

Detailed Description

Module aligns an input image after detection stage for the following template extraction on Builder module.
Be aware that Alignment module can work incorrectly if you send the image with several faces on it.
Alignment algorithm can contains quality assessment parameter, which give internal assessment if there is a face on the image or not, but it`s up to the SDK user how to work with this parameter (to use it or not).

Function Documentation

make_alignment() [1/6]

std::shared_ptr<alignment> FACE_SDK_EXPORT face_sdk::make_alignment

(

uint32_t

version

)

Makes the face_sdk::alignment object with needed version. Other required parameters are loaded from known paths (see Known paths).

Parameters

[in]

version

Required version of the algorithm. See Alignment versions.

Exceptions

face_sdk::exception

See Exceptions handling.

make_alignment() [2/6]

std::shared_ptr<alignment> FACE_SDK_EXPORT face_sdk::make_alignment	(	uint32_t	version,
		const std::shared_ptr< face_sdk::data_container > &	contaner,
		uint32_t	batch_size,
		int32_t	compute_device
	)

Makes the face_sdk::alignment object with needed 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 Alignment versions.
[in]	contaner	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_alignment() [3/6]

std::shared_ptr<alignment> FACE_SDK_EXPORT face_sdk::make_alignment	(	uint32_t	version,
		const std::shared_ptr< face_sdk::license > &	license
	)

Makes the face_sdk::alignment object with needed version and license. Other required parameters are loaded from known paths (see Known paths).

Parameters

[in]	version	Required version of the algorithm. See Alignment versions.
[in]	license	The license object. See Licensing.

Exceptions

face_sdk::exception

See Exceptions handling.

make_alignment() [4/6]

std::shared_ptr<alignment> FACE_SDK_EXPORT face_sdk::make_alignment	(	uint32_t	version,
		const std::shared_ptr< face_sdk::license > &	license,
		const std::shared_ptr< face_sdk::data_container > &	contaner,
		uint32_t	batch_size,
		int32_t	compute_device
	)

Makes the face_sdk::alignment object with needed version, license, data container, batch size and compute device.

Parameters

[in]	version	Required version of the algorithm. See Alignment versions.
[in]	license	The license object. See Licensing.
[in]	contaner	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.

Examples

complex.cpp, and serialize.cpp.

make_alignment() [5/6]

std::shared_ptr<alignment> FACE_SDK_EXPORT face_sdk::make_alignment	(	uint32_t	version,
		const std::shared_ptr< face_sdk::license > &	license,
		uint32_t	batch_size,
		int32_t	compute_device
	)

Makes the face_sdk::alignment object with needed 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 Alignment 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.

Exceptions

face_sdk::exception

See Exceptions handling.

make_alignment() [6/6]

std::shared_ptr<alignment> FACE_SDK_EXPORT face_sdk::make_alignment	(	uint32_t	version,
		uint32_t	batch_size,
		int32_t	compute_device
	)

Makes the face_sdk::alignment object with needed 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 Alignment versions.
[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.