NFIQ2::Algorithm Class Reference

Applies trained random forest parameters to quality features, computing an overall quality score (i.e., NFIQ2). More...

#include <nfiq2_algorithm.hpp>

Public Member Functions
	Algorithm ()
	Default constructor of Algorithm. More...
	Algorithm (const std::string &fileName, const std::string &fileHash)
	Constructor that loads random forest parameters from disk. More...
	Algorithm (const NFIQ2::ModelInfo &modelInfoObj)
	Constructor using NFIQ2::ModelInfo to initialize the random forest. More...
	Algorithm (const Algorithm &)
	Copy constructor. More...
Algorithm &	operator= (const Algorithm &)
	Assignment operator. More...
	Algorithm (Algorithm &&) noexcept
	Move constructor. More...
Algorithm &	operator= (Algorithm &&) noexcept
	Move assignment operator. More...
	~Algorithm ()
	Destructor. More...
unsigned int	computeQualityScore (const NFIQ2::FingerprintImageData &rawImage) const
	Computes the quality score from the provided fingerprint image data. More...
unsigned int	computeQualityScore (const std::vector< std::shared_ptr< NFIQ2::QualityFeatures::BaseFeature >> &features) const
	Computes the quality score from a vector of extracted BaseFeatures from a cropped fingerprint image. More...
unsigned int	computeQualityScore (const std::unordered_map< std::string, NFIQ2::QualityFeatureData > &features) const
	Computes the quality score from a map of extracted image quality feature data. More...
std::string	getParameterHash () const
	Obtain MD5 checksum of random forest parameter file loaded. More...
bool	isInitialized () const
	Determine if random forest parameters have been loaded. More...
bool	isEmbedded () const
	Obtain if the random forest parameters are embedded in the library or located externally. More...
unsigned int	getEmbeddedFCT () const
	Obtain the friction ridge capture technology (FCT) specified for the embedded random forest parameters. More...

Detailed Description

Applies trained random forest parameters to quality features, computing an overall quality score (i.e., NFIQ2).

Definition at line 19 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.

computeQualityScore() [1/3]

unsigned int NFIQ2::Algorithm::computeQualityScore

(

const NFIQ2::FingerprintImageData &

rawImage

)

const

Computes the quality score from the provided fingerprint image data.

Parameters

rawImage

Fingerprint image.

Returns

Computed quality score.

Exceptions

Exception

Called before random forest parameters were loaded.

computeQualityScore() [2/3]

unsigned int NFIQ2::Algorithm::computeQualityScore

(

const std::vector< std::shared_ptr< NFIQ2::QualityFeatures::BaseFeature >> &

features

)

const

Computes the quality score from a vector of extracted BaseFeatures from a cropped fingerprint image.

Parameters

features

Vector of computed feature metrics that contain quality information for a fingerprint image.

Returns

Computed quality score.

Exceptions

Exception

Called before random forest parameters were loaded.

computeQualityScore() [3/3]

unsigned int NFIQ2::Algorithm::computeQualityScore

(

const std::unordered_map< std::string, NFIQ2::QualityFeatureData > &

features

)

const

Computes the quality score from a map of extracted image quality feature data.

Parameters

features

Map of string, quality feature data pairs.

Returns

Computed quality score.

Exceptions

Exception

Called before random forest parameters were loaded.

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.

Exceptions

NFIQ2::Exception

Parameters were not embedded or FCT was not specified.

---

The documentation for this class was generated from the following file:

• nfiq2_algorithm.hpp