Documentation Index
Fetch the complete documentation index at: https://mintlify.com/usnistgov/NFIQ2/llms.txt
Use this file to discover all available pages before exploring further.
Building NFIQ 2 with the command-line interface provides a standalone executable for quality assessment, along with the library for integration.
The CLI build requires additional system dependencies from libbiomeval. Ensure you have installed all required system packages before proceeding. Quick Build
Clone the repository
Clone recursively to include all git submodules:git clone --recursive https://github.com/usnistgov/NFIQ2.git
cd NFIQ2
Install system dependencies
Install required packages for libbiomeval: Ubuntu/Debian
macOS
Windows
sudo apt-get install build-essential cmake libdb++-dev \
libhwloc-dev libjbig-dev libjpeg-dev libopenjp2-7-dev \
liblzma-dev libpng-dev libsqlite3-dev libssl-dev \
libtiff-dev libzstd-dev zlib1g-dev
sudo port install berkeley-db cmake hwloc jpeg openjpeg \
libpng openssl sqlite3 tiff xz zlib zstd
vcpkg install berkeleydb:x64-windows-static \
hwloc:x64-windows-static libjpeg-turbo:x64-windows-static \
openjpeg:x64-windows-static libpng:x64-windows-static \
openssl:x64-windows-static sqlite3:x64-windows-static \
tiff:x64-windows-static zlib:x64-windows-static \
zstd:x64-windows-static
Configure with CMake
The CLI is built by default when BUILD_NFIQ2_CLI is not specified: Build the library and CLI
Build Configuration
Explicitly Enable CLI
While the CLI is built by default, you can explicitly enable it:
cmake .. -DBUILD_NFIQ2_CLI=ON
Build Type
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build .
Windows with Visual Studio
Windows builds require vcpkg to manage libbiomeval dependencies:
# 64-bit Release build
cmake .. ^
-DCMAKE_TOOLCHAIN_FILE=C:\vcpkg\scripts\buildsystems\vcpkg.cmake ^
-DVCPKG_TARGET_TRIPLET=x64-windows-static ^
-DCMAKE_CONFIGURATION_TYPES=Release ^
-A x64
cmake --build . --config Release
# 32-bit Release build
cmake .. ^
-DCMAKE_TOOLCHAIN_FILE=C:\vcpkg\scripts\buildsystems\vcpkg.cmake ^
-DVCPKG_TARGET_TRIPLET=x86-windows-static ^
-DCMAKE_CONFIGURATION_TYPES=Release ^
-A Win32
cmake --build . --config Release
Adjust the vcpkg path (C:\vcpkg\) to match your installation location.
macOS Universal Binary
To build a universal binary that runs on both Intel and Apple Silicon:
Install universal dependencies
Ensure all MacPorts dependencies are universal:sudo port install berkeley-db +universal hwloc +universal \
jpeg +universal openjpeg +universal libpng +universal \
openssl +universal sqlite3 +universal tiff +universal \
xz +universal zlib +universal zstd +universal
Configure for both architectures
cmake .. -DCMAKE_OSX_ARCHITECTURES="x86_64;arm64"
All dependencies must be built universally. Mixing architectures will cause linker errors.
Linux
Standard build on Linux:
For distribution packages:
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build .
cpack
Build Output
After a successful build, you’ll find:
Executables
- CLI:
build/NFIQ2/NFIQ2Algorithm/nfiq2 (Linux/macOS) or build\NFIQ2\NFIQ2Algorithm\Release\nfiq2.exe (Windows)
Libraries
- NFIQ 2 API:
libNfiq2Api.a / Nfiq2Api.lib
- NFIQ 2 Algorithm:
libNfiq2Algorithm.a / Nfiq2Algorithm.lib
- OpenCV: OpenCV libraries in
build/OpenCV-prefix/
- FingerJetFX:
libFRFXLL.a / FRFXLL.lib
- libbiomeval:
libbiomeval.a / biomeval.lib
- NFIR:
libnfir.a / nfir.lib
Data Files
Random forest model parameters (if not embedded):
build/NFIQ2/NFIQ2Algorithm/share/nfiq2/nist_plain_tir-ink.txt
Testing the Build
Verify the CLI executable works:
./NFIQ2/NFIQ2Algorithm/nfiq2 --version
./NFIQ2/NFIQ2Algorithm/nfiq2 -i path/to/fingerprint.png
Installation
Install the built binaries and libraries:
- Linux/macOS:
/usr/local/nfiq2/
- Windows:
C:\Program Files\NFIQ2\
Custom Installation Prefix
cmake .. -DCMAKE_INSTALL_PREFIX=/opt/nfiq2
cmake --build .
sudo cmake --install .
Creating Distribution Packages
CMake can generate platform-specific installers:
macOS (.pkg)
Windows (.msi)
Debian (.deb)
Red Hat (.rpm)
cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build .
cpack -G productbuild
nfiq2-{version}-macos-{os_version}-{arch}.pkgInstall WiX Toolset, then:cmake .. -DCMAKE_CONFIGURATION_TYPES=Release -A x64
cmake --build . --config Release
cpack -G WIX -C Release
nfiq2-{version}-win64.msi cmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build .
cpack -G DEB
nfiq2_{version}-1_{arch}.debcmake .. -DCMAKE_BUILD_TYPE=Release
cmake --build .
cpack -G RPM
nfiq2-{version}-1.el{version}.{arch}.rpmTroubleshooting
libbiomeval Dependencies Not Found
Ensure all system packages are installed. On Ubuntu:
sudo apt-get install libdb++-dev libssl-dev libsqlite3-dev
OpenSSL Not Found (macOS)
Specify the OpenSSL root directory:
cmake .. -DOPENSSL_ROOT_DIR=/opt/local
vcpkg Triplet Mismatch (Windows)
Ensure the triplet matches your target architecture:
# For 64-bit static linking
-DVCPKG_TARGET_TRIPLET=x64-windows-static
# For 32-bit static linking
-DVCPKG_TARGET_TRIPLET=x86-windows-static
Next Steps
CLI Usage
Learn how to use the NFIQ 2 command-line interface
Platform Notes
Platform-specific build details and limitations
