{"id":13847897,"url":"https://github.com/usnistgov/NFIQ2","last_synced_at":"2025-07-12T11:32:58.189Z","repository":{"id":40244770,"uuid":"71371649","full_name":"usnistgov/NFIQ2","owner":"usnistgov","description":"Optical live-scan and ink fingerprint image quality assessment tool","archived":false,"fork":false,"pushed_at":"2024-09-13T17:49:19.000Z","size":86312,"stargazers_count":130,"open_issues_count":37,"forks_count":57,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-09-14T07:59:31.428Z","etag":null,"topics":["biometrics","fingerprint","iso","nfiq","quality"],"latest_commit_sha":null,"homepage":"https://www.nist.gov/services-resources/software/development-nfiq-20","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/usnistgov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-19T15:28:52.000Z","updated_at":"2024-09-13T17:43:01.000Z","dependencies_parsed_at":"2023-01-17T18:45:26.610Z","dependency_job_id":"68995efa-6456-4eb5-bc4d-9a8690b98cda","html_url":"https://github.com/usnistgov/NFIQ2","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usnistgov%2FNFIQ2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usnistgov%2FNFIQ2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usnistgov%2FNFIQ2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/usnistgov%2FNFIQ2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/usnistgov","download_url":"https://codeload.github.com/usnistgov/NFIQ2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225820303,"owners_count":17529138,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["biometrics","fingerprint","iso","nfiq","quality"],"created_at":"2024-08-04T19:00:35.270Z","updated_at":"2024-11-21T23:30:50.669Z","avatar_url":"https://github.com/usnistgov.png","language":"C++","funding_links":[],"categories":["Open source software","Tools"],"sub_categories":["Fingerprint quality evaluation","Satellite"],"readme":"# NFIQ 2 \u003cimg src=\"cmake/nist_itl_two_color.svg\" align=\"right\" alt=\"NIST Information Technology Laboratory\" style=\"width:250px;\" /\u003e\n\n[![Download Latest Version](https://img.shields.io/badge/download-v2.3-informational)](https://github.com/usnistgov/NFIQ2/releases)\n[![Build Libraries and CLI + Run CTS](https://github.com/usnistgov/NFIQ2/actions/workflows/build-member.yml/badge.svg)](https://github.com/usnistgov/NFIQ2/actions/workflows/build-member.yml)\n[![Frequently Asked Questions](https://img.shields.io/badge/wiki-frequently%20asked%20questions-informational)](https://github.com/usnistgov/NFIQ2/wiki/Frequently-Asked-Questions)\n\nAbout\n-----\n[National Institute of Standards and Technology (NIST)](https://www.nist.gov)\nFingerprint Image Quality (NFIQ) is software that links image\nquality of optical and ink plain impression 500 pixel per inch fingerprints to operational\nrecognition performance. This allows quality values to be tightly defined and\nthen numerically calibrated, which in turn allows for the standardization needed\nto support a worldwide deployment of fingerprint sensors with\nuniversally-interpretable image qualities. NFIQ 2 quality features are formally\nstandardized as part of\n[ISO/IEC 29794-4](http://www.iso.org/iso/catalogue_detail.htm?csnumber=62791).\nThis repository serves as a formally-recognized reference implementation of the\n2024 international standard.\n\nDownload\n--------\nPre-built versions of the NFIQ 2 library and standalone executable for many\nplatforms are available to download on the\n[GitHub Releases](https://github.com/usnistgov/NFIQ2/releases) page.\n\nHistory\n-------\nIn 2004, [NIST](https://www.nist.gov) developed the first open source and publicly available fingerprint quality assessment tool, [NFIQ](https://www.nist.gov/services-resources/software/nist-biometric-image-software-nbis#NFIQ).\nNFIQ 2 is a revision of that tool.\nAdvances in fingerprint technology since 2004 necessitated an update to NFIQ.\nAs such, development of NFIQ 2 was initiated in 2011 as collaboration between\nNIST and Germany's [Federal Office for Information Security (BSI)](https://www.bsi.bund.de/)\nand [Federal Criminal Police Office (BKA)](https://www.bka.de), as well as research and development entities [MITRE](https://www.mitre.org),\n[Fraunhofer IGD](https://www.igd.fraunhofer.de/), [Hochschule Darmstadt (h_da)](https://h-da.de), and [Secunet](https://www.secunet.com).\nSubsequent development efforts and improvements have been supported by experts\nfrom [ISO/IEC JTC 1/Subcommittee 37](https://www.iso.org/committee/313770.html)\nand the [community](https://github.com/usnistgov/NFIQ2/graphs/contributors).\n\nNFIQ 2 provides a higher resolution quality score in the range of [0-100], adhering\nto the international biometric sample quality standard [ISO/IEC 29794-1:2024](https://www.iso.org/standard/79519.html) (as opposed to the original NFIQ's 5-1),\nlower computation complexity, and support for quality assessment on mobile platforms.\n\nNFIQ 2 is formally recognized as a reference implementation of the normative\nmetrics presented in\n[ISO/IEC 29794-4:2017](https://www.iso.org/standard/62791.html) and was updated\nin sync as version 2.3 with the second edition revision effort,\n[ISO/IEC 29794-4:2024](https://www.iso.org/standard/83827.html).\n\nOperationally, NFIQ has increased the reliability, accuracy, and interoperability of fingerprint recognition\nsystems by identifying the samples that are likely to cause recognition failure.\n\nIf you would like more information, please read the [NFIQ 2 Report](https://doi.org/10.6028/NIST.IR.8382)\nand [ISO/IEC 29794-4:2024](https://www.iso.org/standard/83827.html).\n\n--------------------------------------------------------------------------------\n\nDependencies\n------------\n\nBuilding the NFIQ 2 library requires the following dependencies, included in\nthis repository as git submodules:\n\n * [digestpp](https://github.com/kerukuro/digestpp) ([public domain license](https://github.com/kerukuro/digestpp/blob/master/LICENSE))\n * [FingerJetFX OSE](https://github.com/FingerJetFXOSE/FingerJetFXOSE) ([LGPLv3 license](https://github.com/FingerJetFXOSE/FingerJetFXOSE/blob/master/COPYRIGHT.txt))\n * [OpenCV](https://github.com/opencv/opencv) ([Apache 2 License](https://github.com/opencv/opencv/blob/master/LICENSE))\n\nIf building the standalone command-line executable, additional dependencies are\nrequired, included in this repository as git submodules:\n\n * [Biometric Evaluation Framework](https://github.com/usnistgov/libbiomeval) ([public domain license](https://github.com/usnistgov/libbiomeval/blob/master/LICENSE.md))\n   * Requires other non-bundled dependencies, please see the [README](https://github.com/usnistgov/libbiomeval/blob/master/README.md).\n * [NIST Fingerprint Image Resampler](https://github.com/usnistgov/nfir) (public domain license)\n   * Requires [OpenCV](https://github.com/opencv/opencv), which is required by NFIQ 2 library.\n\nQuick Build: Library\n--------------------\n\n\u003e [!IMPORTANT]\n\u003e Unless you are *actively developing* code for NFIQ 2, we **highly** suggest\n\u003e you download from [Releases](https://github.com/usnistgov/NFIQ2/releases)\n\u003e instead of attempting to compile.\n\n\u003e [!NOTE]\n\u003e You must *recursively* clone the repository to retrieve git submodules\n\u003e (i.e., do **not** use the GitHub ZIP file download).\n\n```bash\ngit clone --recursive https://github.com/usnistgov/NFIQ2.git\ncd NFIQ2\nmkdir build\ncd build\ncmake .. -DBUILD_NFIQ2_CLI=OFF\ncmake --build .\n```\n\nQuick Build: Library + Command-line Interface\n---------------------------------------------\n\n\u003e [!IMPORTANT]\n\u003e Unless you are *actively developing* code for NFIQ 2, we **highly** suggest\n\u003e you download from [Releases](https://github.com/usnistgov/NFIQ2/releases)\n\u003e instead of attempting to compile.\n\n\u003e [!NOTE]\n\u003e You must *recursively* clone the repository to retrieve git submodules\n\u003e (i.e., do **not** use the GitHub ZIP file download).\n\n```bash\ngit clone --recursive https://github.com/usnistgov/NFIQ2.git\ncd NFIQ2\nmkdir build\ncd build\ncmake ..\ncmake --build .\n```\n\n### Build Notes:\n * Standard CMake arguments are interpreted.\n   * On Windows, change architectures with `-A x64` or `-A Win32`\n   * On macOS, use the environment variable `CMAKE_OSX_ARCHITECTURES` to build\n     a universal binary. Ensure that all dependencies are built universally as\n     well.\n   * Change generators with `-G`\n   * Change build types with `-DCMAKE_CONFIGURATION_TYPES` or\n     `-DCMAKE_BUILD_TYPE`\n\n * Dependencies for [`libbiomeval`](https://github.com/usnistgov/libbiomeval)\n   must be satisfied.\n    * On Windows with Visual Studio, this is done with\n      [vcpkg](https://github.com/microsoft/vcpkg), which will require passing\n      the vcpkg `CMAKE_TOOLCHAIN_FILE` and `VCPKG_TARGET_TRIPLET` options\n      to CMake.\n      * For example, a 64-bit Release-only build with the default Visual\n        Studio generator might look like:\n        ```\n        cmake .. -DCMAKE_TOOLCHAIN_FILE=C:\\vcpkg\\scripts\\buildsystems\\vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows-static -DCMAKE_CONFIGURATION_TYPES=Release -A x64\n        cmake --build . --config Release\n        ```\n    * If building a macOS universal binary, be sure all dependencies are\n      universal as well. If installed via MacPorts, ensure the `+universal`\n      variants are used.\n\n\nBuilds for other OS can typically find dependencies on the system without\nintervention.\n\nOpenCV Version\n--------------\nOriginally, all major versions of OpenCV were supported by NFIQ 2. Due to the\nlimited testing resources as well as slight differences in results between\nversions, NIST has chosen to rely on the latest release of OpenCV 4 as of this\nwriting. **Using a different version of OpenCV may result in unstable NFIQ 2\nscores and is not supported.** Future updates to OpenCV versions should run the\nconformance test and larger sequestered tests without differences.\n\nKnown Limitations\n-----------------\n\n * **macOS**:\n   * Xcode 10 and later does not support 32-bit applications. In order to build\n     NFIQ 2 for 32-bit macOS, use Xcode 9.4.x.\n\nBuild Options\n-------------\nThe CMake builds supports the following options:\n\n * `BUILD_NFIQ2_CLI` (default: `ON`)\n   * Whether or not to build the standalone command-line executable.\n * `EMBED_RANDOM_FOREST_PARAMETERS` (default: `OFF`)\n   * Whether or not to embed random forest parameters into the library.\n * `EMBEDDED_RANDOM_FOREST_PARAMETER_FCT` (default: `0`)\n   * Friction ridge capture technology code for embedded random forest\n     parameters. Only valid if `EMBED_RANDOM_FOREST_PARAMETERS` is `ON`.\n\nCommunication\n-------------\nIf you found a bug and can provide steps to reliably reproduce it, or if you\nhave a feature request, please\n[open an issue](https://github.com/usnistgov/NFIQ2/issues). Other\nquestions may be addressed to the\n[NIST project maintainers](mailto:nfiq2@nist.gov).\n\nLicense\n-------\nNFIQ is released in the public domain. See the\n[LICENSE](https://github.com/usnistgov/NFIQ2/blob/master/LICENSE.md)\nfor details.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusnistgov%2FNFIQ2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fusnistgov%2FNFIQ2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fusnistgov%2FNFIQ2/lists"}