Applies trained random forest parameters to native quality measures, computing a unified quality score. More...

#include <nfiq2_algorithm.hpp>

Public Member Functions
	Algorithm ()
	Default constructor of Algorithm.

	Algorithm (const std::string &fileName, const std::string &fileHash)
	Constructor that loads random forest parameters from disk.

	Algorithm (const NFIQ2::ModelInfo &modelInfoObj)
	Constructor using NFIQ2::ModelInfo to initialize the random forest.

	Algorithm (const Algorithm &)
	Copy constructor.

Algorithm &	operator= (const Algorithm &)
	Assignment operator.

	Algorithm (Algorithm &&) noexcept
	Move constructor.

Algorithm &	operator= (Algorithm &&) noexcept
	Move assignment operator.

	~Algorithm ()
	Destructor.

unsigned int	computeUnifiedQualityScore (const NFIQ2::FingerprintImageData &rawImage) const
	Compute a unified quality score.

unsigned int	computeUnifiedQualityScore (const std::vector< std::shared_ptr< NFIQ2::QualityMeasures::Algorithm > > &algorithms) const
	Compute a unified quality score.

unsigned int	computeUnifiedQualityScore (const std::unordered_map< std::string, double > &features) const
	Compute a unified quality score.

std::string	getParameterHash () const
	Obtain MD5 checksum of random forest parameter file loaded.

bool	isInitialized () const
	Determine if random forest parameters have been loaded.

bool	isEmbedded () const
	Obtain if the random forest parameters are embedded in the library or located externally.

unsigned int	getEmbeddedFCT () const
	Obtain the friction ridge capture technology (FCT) specified for the embedded random forest parameters.

Static Public Member Functions
static std::unordered_map< std::string, unsigned int >	getQualityBlockValues (const std::unordered_map< std::string, double > &nativeQualityMeasureValues)
	Obtain the quality block values (i.e., [0, 100]) for the native quality measure values.

static unsigned int	getQualityBlockValue (const std::string &nativeQualityMeasureIdentifier, const double nativeQualityMeasureValue)
	Obtain the quality block value (i.e., [0, 100]) for the native quality measure value.

Detailed Description

Applies trained random forest parameters to native quality measures, computing a unified quality score.

Definition at line 29 of file nfiq2_algorithm.hpp.

Constructor & Destructor Documentation

◆ Algorithm() [1/5]

NFIQ2::Algorithm::Algorithm ( )

Default constructor of Algorithm.

Note: May load from parameters compiled into source code, in which case this can be slow.

◆ Algorithm() [2/5]

NFIQ2::Algorithm::Algorithm	(	const std::string &	fileName,
		const std::string &	fileHash )

Constructor that loads random forest parameters from disk.

Parameters

fileName	The file path containing the random forest model.
fileHash	The md5 checksum of the provided file.

◆ Algorithm() [3/5]

NFIQ2::Algorithm::Algorithm ( const NFIQ2::ModelInfo & modelInfoObj )

Constructor using NFIQ2::ModelInfo to initialize the random forest.

Parameters

modelInfoObj Contains the random forest model and information about it.

◆ Algorithm() [4/5]

NFIQ2::Algorithm::Algorithm ( const Algorithm & )

Copy constructor.

◆ Algorithm() [5/5]

NFIQ2::Algorithm::Algorithm ( Algorithm && )

noexcept

Move constructor.

◆ ~Algorithm()

NFIQ2::Algorithm::~Algorithm ( )

Destructor.

Member Function Documentation

◆ operator=() [1/2]

Algorithm & NFIQ2::Algorithm::operator= ( const Algorithm & )

Assignment operator.

◆ operator=() [2/2]

Algorithm & NFIQ2::Algorithm::operator= ( Algorithm && )

noexcept

Move assignment operator.

◆ getParameterHash()

std::string NFIQ2::Algorithm::getParameterHash ( ) const

Obtain MD5 checksum of random forest parameter file loaded.

Returns: MD5 checksum of the random forest parameter file loaded.

Exceptions

Exception Called before random forest parameters were loaded.

◆ isInitialized()

bool NFIQ2::Algorithm::isInitialized ( ) const

Determine if random forest parameters have been loaded.

Returns: true if some set of random forest parameters have been loaded, false otherwise.

◆ isEmbedded()

bool NFIQ2::Algorithm::isEmbedded ( ) const

Obtain if the random forest parameters are embedded in the library or located externally.

Returns: true if random forest parameters are embedded, false otherwise.

◆ getEmbeddedFCT()

unsigned int NFIQ2::Algorithm::getEmbeddedFCT ( ) const

Obtain the friction ridge capture technology (FCT) specified for the embedded random forest parameters.

Returns: Embedded FCT specified.