Vsdk::Biometrics::Model

Used by Authenticator and Identificator instances, containing a bunch of audio records associated with user names. More...

Inheritance diagram for Vsdk::Biometrics::Model:

Public Member Functions
	Model (std::string name, ModelType type) noexcept
virtual	~Model ()=default
auto	type () const -> ModelType
auto	name () const -> std::string const &
virtual auto	analyseRecord (boost::filesystem::path const &path) -> std::pair< bool, nlohmann::json >=0
	Analyses a user record from a file. More...
virtual auto	analyseRecord (Vsdk::Audio::Buffer const &buffer) -> std::pair< bool, nlohmann::json >=0
	Analyses a user record from an audio buffer. More...
virtual void	addRecord (std::string const &user, boost::filesystem::path const &path)=0
	Adds a user record from a file. More...
virtual void	addRecord (std::string const &user, Audio::Buffer buffer)=0
	Adds a user record from an audio buffer. More...
virtual void	eraseUser (std::string const &name)=0
	Erases an user and all its audio records. More...
virtual auto	users () const -> std::list< std::string >=0
	Gets the list of users registered in this model. More...
virtual void	compile ()=0
	Finalizes the model before being used. More...

Detailed Description

Used by Authenticator and Identificator instances, containing a bunch of audio records associated with user names.

Constructor & Destructor Documentation

Model()

Model::Model ( std::string  name, ModelType  type  )

noexcept

~Model()

virtual Vsdk::Biometrics::Model::~Model ( )

virtualdefault

Member Function Documentation

type()

auto Model::type

(

)

const -> ModelType

name()

auto Model::name

(

)

const -> std::string const &

analyseRecord() [1/2]

virtual auto Vsdk::Biometrics::Model::analyseRecord ( boost::filesystem::path const &  path ) -> std::pair< bool, nlohmann::json >

pure virtual

Analyses a user record from a file.

Returns

a pair comprising a boolean value 'accepted' indicating whether the record has the default requirements or not, and a JSON object containing detailed information about the record

analyseRecord() [2/2]

virtual auto Vsdk::Biometrics::Model::analyseRecord ( Vsdk::Audio::Buffer const &  buffer ) -> std::pair< bool, nlohmann::json >

pure virtual

Analyses a user record from an audio buffer.

Returns

a pair comprising a boolean value 'accepted' indicating whether the record has the default requirements or not, and a JSON object containing detailed information about the record

addRecord() [1/2]

virtual void Vsdk::Biometrics::Model::addRecord ( std::string const &  user, boost::filesystem::path const &  path  )

pure virtual

Adds a user record from a file.

addRecord() [2/2]

virtual void Vsdk::Biometrics::Model::addRecord ( std::string const &  user, Audio::Buffer  buffer  )

pure virtual

Adds a user record from an audio buffer.

eraseUser()

virtual void Vsdk::Biometrics::Model::eraseUser ( std::string const &  name )

pure virtual

Erases an user and all its audio records.

users()

virtual auto Vsdk::Biometrics::Model::users ( ) const -> std::list< std::string >

pure virtual

Gets the list of users registered in this model.

compile()

virtual void Vsdk::Biometrics::Model::compile ( )

pure virtual

Finalizes the model before being used.