nfiq2_algorithm.hpp

Go to the documentation of this file.

/*
 * This file is part of NIST Fingerprint Image Quality (NFIQ) 2. For more
 * information on this project, refer to:
 *   - https://nist.gov/services-resources/software/nfiq2
 *   - https://github.com/usnistgov/NFIQ2
 *
 * This work is in the public domain. For complete licensing details, refer to:
 *   - https://github.com/usnistgov/NFIQ2/blob/master/LICENSE.md
 */
 
#ifndef NFIQ2_ALGORITHM_HPP_
#define NFIQ2_ALGORITHM_HPP_
 
#include <nfiq2_constants.hpp>
#include <nfiq2_fingerprintimagedata.hpp>
#include <nfiq2_modelinfo.hpp>
#include <nfiq2_qualitymeasures.hpp>
 
#include <memory>
#include <string>
#include <unordered_map>
 
namespace NFIQ2 {
 
class Algorithm {
    public:
        Algorithm();
 
        Algorithm(const std::string &fileName, const std::string &fileHash);
 
        Algorithm(const NFIQ2::ModelInfo &modelInfoObj);
 
        Algorithm(const Algorithm &);
 
        Algorithm &operator=(const Algorithm &);
 
        Algorithm(Algorithm &&) noexcept;
 
        Algorithm &operator=(Algorithm &&) noexcept;
 
        ~Algorithm();
 
        unsigned int computeUnifiedQualityScore(
            const NFIQ2::FingerprintImageData &rawImage) const;
 
        unsigned int computeUnifiedQualityScore(const std::vector<
            std::shared_ptr<NFIQ2::QualityMeasures::Algorithm>> &algorithms)
            const;
 
        unsigned int computeUnifiedQualityScore(
            const std::unordered_map<std::string, double> &features) const;
 
        static std::unordered_map<std::string, unsigned int>
        getQualityBlockValues(const std::unordered_map<std::string, double>
                &nativeQualityMeasureValues);
 
        static unsigned int
        getQualityBlockValue(const std::string &nativeQualityMeasureIdentifier,
            const double nativeQualityMeasureValue);
 
        std::string getParameterHash() const;
 
        bool isInitialized() const;
 
        bool isEmbedded() const;
 
        unsigned int getEmbeddedFCT() const;
 
    private:
        class Impl;
 
        std::unique_ptr<Algorithm::Impl> pimpl;
};
} // namespace NFIQ
 
#endif /* NFIQ2_ALGORITHM_HPP_ */