Skip to content

Latest commit

 

History

History
297 lines (242 loc) · 13.4 KB

README.md

File metadata and controls

297 lines (242 loc) · 13.4 KB
Raw

Biometric Evaluation Framework NIST Information Technology Laboratory

Build Library and Tests

The NIST Image Group's Biometric Evaluation Framework is a set of C++ classes, error codes, and design patterns used to create a common environment to provide logging, data management, error handling, and other functionality that is needed for many applications used in the testing of biometric software.

The goals of Biometric Evaluation Framework include:

  • reduce the amount of I/O error handling implemented by applications;
  • provide standard interfaces for data management and logging;
  • remove the need for applications to handle low-level events from the operating system;
  • provide time tracking and constraints for blocks of code;
  • reduce potential for memory errors and corruption;
  • simplify the use of parallel processing.

How to Build

Once all requirements have been met, use CMake to build:

mkdir build
cd build
cmake ..
cmake --build .

Documentation

All header files are well documented. A web browsable version of the API documentation is available on our website.

Requirements

We currently test this software using g++ 9.3 under Ubuntu 20.04. Other operating systems and compilers are likely to work as expected, but have not been thoroughly tested. Additionally, not all parts of libbiomeval will be enabled to build on all platforms.

You will need to install several system packages to enable certain features of Biometric Evaluation Framework.

Installing

A pre-compiled version of Biometric Evaluation framework is available from the releases page on GitHub. These packages have been signed with our public key.

  • RHEL/CentOS:

    1. Import the public key

      rpm --import beframework_signing_key.asc

    2. Verify the signature

      rpm --checksig libbiomeval-10.0-1.x86_64.rpm

    3. Install

      dnf localinstall libbiomeval-10.0-1.x86_64.rpm

System Packages

Quick Install Commands

The following package manager commands may be useful to install all packages needed to support all features of Biometric Evaluation Framework (though you still may need to download and install sources for other non-system packages on some operating systems---read all of Module Requirements for complete details).

  • macOS:

    • MacPorts:

      port install openjpeg jpeg libpng tiff zlib openmpi db62 sqlite3 hwloc ffmpeg

    • Homebrew:

      brew install openjpeg jpeg-turbo libpng libtiff zlib open-mpi berkeley-db sqlite hwloc ffmpeg
  • RHEL/CentOS: 
    dnf install openssl-devel pcsc-lite-devel openjpeg2-devel libjpeg-turbo-devel libpng-devel libtiff-devel zlib-devel openmpi-devel  `libdb-cxx-devel` sqlite-devel zlib-devel
  • Ubuntu: 
    apt install libpcsclite-dev libssl-dev libopenjp2-7-dev libjpeg-dev libpng-dev libtiff-dev zlib1g-dev libopenmpi-dev libdb++-dev libsqlite3-dev libhwloc-dev libavcodec-dev libavformat-dev libswscale-dev
  • Windows: 
    vcpkg install openssl openjpeg libjpeg-turbo libpng tiff zlib msmpi berkeleydb sqlite3 zlib hwloc ffmpeg

Module Requirements

Some modules require system packages that may not be installed by default on all operating systems. Package names are listed below for RHEL/CentOS, macOS (via MacPorts and Homebrew, Ubuntu, and Windows (via vcpkg). Other operating systems may use similarly-named packages.

Note:

  • Under RHEL/CentOS 8, several packages listed below are now part of the "PowerTools" repository, which is disabled by default. This repository can be enabled by issuing the command:

    # Enable PowerTools repository
sudo yum config-manager --set-enabled PowerTools

  • When using vcpkg, you must provide CMake with the path to your vcpkg toolchain:

    cmake .. -DCMAKE_TOOLCHAIN_FILE=%vcpkg_root%\scripts\buildsystems\vcpkg.cmake

CORE

Name RHEL/CentOS MacPorts/Homebrew Ubuntu vcpkg
OpenSSL openssl-devel n/a (uses macOS CommonCrypto) libssl-dev openssl

DEVICE

Name RHEL/CentOS MacPorts/Homebrew Ubuntu
PCSC Lite pcsc-lite-devel n/a (requires Command Line Tools) libpcsclite-dev

IMAGE

Name RHEL/CentOS MacPorts Homebrew Ubuntu vcpkg
OpenJPEG 2.x openjpeg2-devel openjpeg openjpeg libopenjp2-7-dev openjpeg
libjpeg libjpeg-turbo-devel jpeg jpeg or jpeg-turbo libjpeg-dev libjpeg-turbo
libpng libpng-devel libpng libpng libpng-dev libpng
libtiff libtiff-devel tiff libtiff libtiff-dev tiff
Zlib zlib-devel zlib zlib zlib1g-dev zlib

Note:

  • Under CentOS, openjpeg2-devel is part of the EPEL repository. It can be enabled by installing the package epel-release.

IO

Name RHEL/CentOS MacPorts Homebrew Ubuntu vcpkg
Zlib zlib-devel zlib zlib zlib1g-dev zlib

MPIBASE, MPIDISTRIBUTOR, MPIRECEIVER

Name RHEL/CentOS MacPorts Homebrew Ubuntu vcpkg
Open MPI openmpi-devel openmpi open-mpi libopenmpi-dev msmpi

Note:

  • With MacPorts, you may need to select a different MPI group if you have more than one installed:

    sudo port select mpi openmpi-mp-fortran

  • With msmpi and vcpkg, you must first install the Microsoft MPI redistributable package.

RECORDSTORE

Name RHEL/CentOS MacPorts Homebrew Ubuntu vcpkg
Berkeley DB libdb-cxx-devel db62 berkeley-db libdb++-dev berkeleydb
SQLite 3 sqlite-devel sqlite3 sqlite libsqlite3-dev sqlite3
Zlib zlib-devel zlib zlib zlib1g-dev zlib

SYSTEM

Name RHEL/CentOS MacPorts Homebrew Ubuntu vcpkg
Portable Hardware Locality hwloc-devel hwloc hwloc libhwloc-dev hwloc

VIDEO

Name RHEL/CentOS MacPorts Homebrew Ubuntu vcpkg
ffmpeg Build from source, and install to /usr/local ffmpeg ffmpeg libavcodec-dev, libavformat-dev, libswscale-dev ffmpeg
NIST Biometric Image Software (NBIS)

NBIS is supported under current versions of RHEL/CentOS, Ubuntu, and macOS. The Framework repository contains a subset of NBIS that is built automatically.

Options

The CMake build supports the following options:

CMake Option Default Description Notes
BUILD_BIOMEVAL_32BIT OFF Compile 32-bit on 64-bit host OS
BUILD_BIOMEVAL_TESTS OFF Build test programs
BUILD_FOR_WASM OFF Disable components currently not supported under WebAssembly Defaults to ON when the Emscripten toolchain is detected
BUILD_SHARED_LIBS OFF Build shared library (i.e., .so, .dll, .dylib) When OFF, a static library (i.e., .a, .lib) is built instead
FORCE_STATIC_DEPENDENCIES OFF Force linking against .a/.lib third-party dependencies. Unavailable on Windows (use -DBUILD_SHARED_LIBS=OFF for similar behavior)
WASM_EXCEPTIONS ON When compiled to WebAssembly, use WebAssembly exceptions instead of JavaScript exceptions Only available when BUILD_FOR_WASM is YES and the Emscripten toolchain is detected
WITH_FFMPEG ON Build sources that require FFMPEG Unavailable when FORCE_STATIC_DEPENDENCIES is ON
WITH_HWLOC ON Build sources that require libhwloc
WITH_MPI ON Build sources that require OpenMPI
WITH_PCSC ON Build sources that require PCSC

A Note about WebAssembly

A minimal version of the library can be compiled to WebAssembly and is supported. Compilation has only been tested using the Emscripten toolchain. When this toolchain is detected (i.e., when emcmake is used to configure, rather than cmake), the above options for WebAssembly are automatically enabled.

As Seen In...

NIST is committed to using Biometric Evaluation Framework in their biometric evaluations, including:

Communication

If you found a bug and can provide steps to reliably reproduce it, or if you have a feature request, please open an issue. Other questions may be addressed to the project maintainers.

Pull Requests

Thanks for your interest in submitting code to Biometric Evaluation Framework. In order to maintain our project goals, pull requests must:

  • adhere to the existing coding style;
  • use Framework types consistently wherever possible;
  • compile without warning;
  • only make use of POSIX APIs;
  • be in the public domain.

Pull requests may be subject to additional rules as imposed by the National Institute of Standards and Technology. Please contact the maintainers before starting work on or submitting a pull request.

Credits

Biometric Evaluation Framework is primarily maintained by Wayne Salamon and Gregory Fiumara, featuring code from several NIST contributors. This work has been sponsored by the National Institute of Standards and Technology, the Department of Homeland Security, and the Federal Bureau of Investigation.

Citing

If you use Biometric Evaluation Framework in the course of your work, please consider linking back to our website or citing our manuscript:

Fiumara, G.; Salamon, W.; Watson, C, "Towards Repeatable, Reproducible, and Efficient Biometric Technology Evaluations," in Biometrics: Theory, Applications and Systems (BTAS), 2015 IEEE 7th International Conference on, Sept. 8 2015-Sept 11 2015.

BibTeX

@INPROCEEDINGS{7358800,
	author={Gregory Fiumara and Wayne Salamon and Craig Watson},
	title={{Towards Repeatable, Reproducible, and Efficient Biometric
	Technology Evaluations}},
	booktitle={Biometrics Theory, Applications and Systems (BTAS), 2015 IEEE
	7th International Conference on},
	year={2015},
	pages={1-8},
	doi={10.1109/BTAS.2015.7358800},
	month={Sept}
}

License

Biometric Evaluation Framework is released in the public domain. See the LICENSE for details.