SourceAFIS » CLI

SourceAFIS CLI is a command-line interface for SourceAFIS libraries (Java, .NET). At the moment, it can benchmark algorithm accuracy, template footprint, and implementation speed. It also includes tools that aid in development of SourceAFIS, specifically transparency data logging and output checksums.


In order to benchmark SourceAFIS on particular hardware, clone the repository on the target machine and execute it.

git clone
cd sourceafis-cli-java
mvn exec:java

Give it a few minutes to download data and populate caches. You should then see benchmark report.

Dataset       EER    FMR100  FMR1K  FMR10K
High quality  2.19%  3.49%   5.24%  7.40%
All           8.53%  13.0%   18.0%  21.2%

Dataset       Serialized  Memory   Minutiae
High quality  585 B       16.7 KB  35
All           584 B       16.7 KB  35

Operation        Iterations  Parallel    Thread      Mean     Min      Max      Sample  Median   SD       Geom.mean  GSD
extraction       3,740       95.6 fp/s   23.9 fp/s   41.9 ms  6.93 ms  181 ms   3,740   37.8 ms  18.8 ms  38.8 ms    44.9%
identification   1,627,716   42.6 Kfp/s  10.7 Kfp/s  93.9 us  60.0 ns  47.1 ms  6,587   78.3 us  280 us   74.6 us    90.4%
verification     597,066     15.2 Kfp/s  3.80 Kfp/s  263 us   60.0 ns  28.5 ms  7,651   167 us   633 us   171 us     2.95x
probe            28,049      974 fp/s    243 fp/s    4.11 ms  154 ns   111 ms   6,790   1.84 ms  6.36 ms  2.01 ms    3.57x
serialization    37,284,770  1.08 Mfp/s  270 Kfp/s   3.71 us  728 ns   28.8 ms  6,839   2.78 us  49.3 us  2.88 us    47.3%
deserialization  1,818,115   47.6 Kfp/s  11.9 Kfp/s  84.0 us  1.57 us  25.1 ms  6,809   55.9 us  332 us   59.0 us    2.16x


SourceAFIS CLI accepts a number of subcommands and options. You can enumerate them by executing the CLI with no arguments.

mvn exec:java -Dexec.args=""

SourceAFIS CLI will show information about every subcommand and option.

SourceAFIS CLI for Java

Available subcommands:
        Report version of SourceAFIS library being used.
        Measure algorithm accuracy, template footprint, and implementation speed.
    benchmark accuracy
        Measure algorithm accuracy.
    benchmark speed
        Measure algorithm speed.
    benchmark speed extraction
        Measure speed of feature extraction, i.e. FingerprintTemplate constructor.
    benchmark speed identification
        Measure speed of identification, i.e. calling match() with non-matching candidate.
    benchmark speed verification
        Measure speed of verification, i.e. calling match() with matching candidate.
    benchmark speed probe
        Measure speed of preparing probe template for matching, i.e. FingerprintMatcher constructor.
    benchmark speed serialization
        Measure speed of template serialization.
    benchmark speed deserialization
        Measure speed of template deserialization.
    benchmark footprint
        Measure template footprint.
        Compute consistency checksum of all algorithm outputs.
    checksum templates
        Compute consistency checksum of templates.
    checksum scores
        Compute consistency checksum of similarity scores.
    checksum transparency extractor
        Compute consistency checksum of extractor transparency data.
    checksum transparency matcher
        Compute consistency checksum of transparency data generated when preparing probe for matching.
    checksum transparency match
        Compute consistency checksum of transparency data generated during comparison of probe to candidate.
    log extractor <key>
        Log extractor transparency data for given key.
    log matcher <key>
        Log transparency data for given key while preparing probe for matching.
    log match <key>
        Log transparency data for given key during comparison of probe to candidate.
    export png
        Convert sample images to PNG.
    export grayscale
        Convert sample images to grayscale.
        Remove cached data except downloads.

Available options:
    --home <path>
        Location of cache directory.
        Default: /home/rv/.cache/sourceafis
        Log normalized transparency data instead of raw data obtained from the library.
    --baseline <path>
        Compare with output of another SourceAFIS CLI. Path may be relative to cache directory, e.g. 'java/1.2.3'.

Subcommand name is passed to SourceAFIS CLI as part of command-line arguments. The following example will run subcommand "benchmark accuracy".

mvn exec:java -Dexec.args="benchmark accuracy"

Library version

You can view version of the currently used SourceAFIS library by executing "version" subcommand.

mvn exec:java -Dexec.args="version"

SourceAFIS CLI will identify the underlying SourceAFIS library.

SourceAFIS for Java 3.13.0

You can override SourceAFIS library version when executing the CLI program. Note that this might fail with error if the specified library version is too old to work with latest SourceAFIS CLI.

mvn exec:java -Dsourceafis.version="1.2.3"