idliveface::Blueprint Class Reference

Factory for the IDLive Face's objects. More...

#include <idliveface/idliveface.h>

Public Member Functions
	Blueprint (const std::string &init_data_path)
	Creates a new blueprint using the provided init data.
	Blueprint (const std::string &init_data_path, const RuntimeConfiguration &runtime_config)
	Creates a new blueprint using the provided init data and a custom runtime configuration.
ImageDecoder	CreateImageDecoder () const
	Creates new ImageDecoder.
FaceAnalyzer	CreateFaceAnalyzer () const
	Creates new FaceAnalyzer.
FaceAnalyzer	CreateFaceAnalyzer (const std::string &pipeline) const
	Creates new FaceAnalyzer that uses the specified pipeline.
FaceDetector	CreateFaceDetector () const
	Creates new FaceDetector.
std::vector< std::string >	GetAvailablePipelines () const
	Returns all available pipelines.
void	SetDomain (Domain domain)
	Sets the analysis domain.
void	SetTolerance (Tolerance tolerance)
	Sets the analysis tolerance.
void	SuppressValidation (Validation validation, bool suppress=true)
	Suppresses (or unsuppresses) the validation.
void	OverrideValidationParameters (const CustomValidationParameters &custom_parameters)
	Overrides validation parameters for all analysis domains.
void	OverrideValidationParametersForDomain (Domain domain, const CustomValidationParameters &custom_parameters)
	Overrides validation parameters for a specific analysis domain.

Detailed Description

Factory for the IDLive Face's objects.

Constructor & Destructor Documentation

Blueprint() [1/2]

idliveface::Blueprint::Blueprint ( const std::string &  init_data_path )

explicit

Creates a new blueprint using the provided init data.

The init data is located in the data directory of the IDLive Face bundle.

Parameters

init_data_path

Path to the init data.

Exceptions

Exception

if the provided path is invalid.

Blueprint() [2/2]

idliveface::Blueprint::Blueprint	(	const std::string &	init_data_path,
		const RuntimeConfiguration &	runtime_config
	)

Creates a new blueprint using the provided init data and a custom runtime configuration.

The init data is located in the data directory of the IDLive Face bundle.

Parameters

init_data_path	Path to the init data.
runtime_config	Custom runtime configuration.

Exceptions

Exception

if the provided path is invalid or the runtime configuration contains invalid values.

Member Function Documentation

CreateFaceAnalyzer()

FaceAnalyzer idliveface::Blueprint::CreateFaceAnalyzer

(

const std::string &

pipeline

)

const

Creates new FaceAnalyzer that uses the specified pipeline.

Parameters

pipeline

The name of the pipeline

GetAvailablePipelines()

std::vector< std::string > idliveface::Blueprint::GetAvailablePipelines

(

)

const

Returns all available pipelines.

The first one in the list is the default pipeline, which will be used by CreateFaceAnalyzer() if no other pipeline is specified.

SuppressValidation()

void idliveface::Blueprint::SuppressValidation	(	Validation	validation,
		bool	suppress = true
	)

Suppresses (or unsuppresses) the validation.

For all suppressed validations the FaceAnalyzer won't mark the face as invalid if the specific validation has failed to pass. FaceDetector won't return this validation either.

You can suppress these validations:

• kFaceOccluded
• kEyesClosed
• kDarkImage

Parameters

validation	The validation to suppress.
suppress	true will suppress the validation, false will clear the suppression status.

Exceptions

Exception

if the validation can't be suppressed.