NIST Fingerprint Image Quality 2
Fingerprint image quality assessment tool
nfiq2_modelinfo.hpp
Go to the documentation of this file.
1 /*
2  * This file is part of NIST Fingerprint Image Quality (NFIQ) 2. For more
3  * information on this project, refer to:
4  * - https://nist.gov/services-resources/software/nfiq2
5  * - https://github.com/usnistgov/NFIQ2
6  *
7  * This work is in the public domain. For complete licensing details, refer to:
8  * - https://github.com/usnistgov/NFIQ2/blob/master/LICENSE.md
9  */
10 
11 #ifndef NFIQ2_MODELINFO_HPP_
12 #define NFIQ2_MODELINFO_HPP_
13 
14 #include <string>
15 
16 namespace NFIQ2 {
18 class ModelInfo {
19  public:
22 
29  ModelInfo(const std::string &modelInfoFilePath);
30 
38  std::string getModelName() const;
39 
47  std::string getModelTrainer() const;
48 
56  std::string getModelDescription() const;
57 
65  std::string getModelVersion() const;
66 
74  std::string getModelPath() const;
75 
83  std::string getModelHash() const;
84 
86  static const char ModelInfoKeyName[];
88  static const char ModelInfoKeyTrainer[];
90  static const char ModelInfoKeyDescription[];
92  static const char ModelInfoKeyVersion[];
94  static const char ModelInfoKeyPath[];
96  static const char ModelInfoKeyHash[];
97 
98  private:
100  std::string modelName;
102  std::string modelTrainer;
104  std::string modelDescription;
106  std::string modelVersion;
108  std::string modelPath;
110  std::string modelHash;
111 };
112 
113 } // namespace NFIQ
114 
115 #endif /* NFIQ2_MODELINFO_HPP_ */
Information about a random forest parameter model.
std::string getModelHash() const
Obtain the md5 checksum of the model.
std::string getModelDescription() const
Obtain additional description information for model.
static const char ModelInfoKeyDescription[]
Description Key.
static const char ModelInfoKeyVersion[]
Version Key.
std::string getModelPath() const
Obtain the file path of the model.
ModelInfo(const std::string &modelInfoFilePath)
Constructor.
static const char ModelInfoKeyHash[]
Hash Key.
static const char ModelInfoKeyTrainer[]
Trainer Key.
std::string getModelVersion() const
Obtain the version number of the model.
std::string getModelName() const
Obtain the model name.
static const char ModelInfoKeyPath[]
Path Key.
std::string getModelTrainer() const
Obtain the entity that trained the random forest model.
static const char ModelInfoKeyName[]
Name Key.
ModelInfo()
Default constructor.
Classes and functions that contribute to the calculation of NFIQ 2 quality scores.
Definition: nfiq2.hpp:97