SourceAFIS CLI

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.

Running

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

Port
git clone https://github.com/robertvazan/sourceafis-cli-java.git
cd sourceafis-cli-java
mvn exec:java

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

Port
Dataset       EER    FMR100  FMR1K  FMR10K
High quality  2.27%  3.59%   5.81%  7.48%
All           8.60%  13.1%   18.3%  21.8%

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,001       76.6 fp/s   19.2 fp/s   52.2 ms  7.55 ms  374 ms   3,001   45.4 ms  28.3 ms  47.3 ms    52.1%
identification   1,490,105   39.4 Kfp/s  9.84 Kfp/s  102 us   58.0 ns  29.0 ms  7,086   81.2 us  277 us   79.2 us    2.03x
verification     576,868     14.7 Kfp/s  3.67 Kfp/s  272 us   57.0 ns  27.0 ms  7,114   177 us   522 us   180 us     3.04x
probe            27,122      926 fp/s    232 fp/s    4.32 ms  157 ns   129 ms   6,835   2.04 ms  7.19 ms  2.18 ms    3.49x
serialization    34,464,732  1.02 Mfp/s  254 Kfp/s   3.94 us  792 ns   42.5 ms  6,640   2.96 us  56.2 us  3.07 us    46.1%
deserialization  1,692,867   44.5 Kfp/s  11.1 Kfp/s  89.8 us  1.17 us  25.6 ms  6,787   54.9 us  403 us   59.7 us    2.26x

Parameters

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

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

SourceAFIS CLI will show information about every subcommand and option.

Port
SourceAFIS CLI for Java

Available subcommands:
    version
        Report version of SourceAFIS library being used.
    benchmark
        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.
    checksum
        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 probe
        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 probe <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 grayscale
        Convert sample images to grayscale.
    purge
        Remove cached data except downloads.

Available options:
    --home <path>
        Location of cache directory.
        Default: /home/rv/.cache/sourceafis
    --normalize
        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".

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

Library version

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

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

SourceAFIS CLI will identify the underlying SourceAFIS library.

Port
3.13.0

Some SourceAFIS CLI ports allow you to override SourceAFIS library version. Note that this might fail with error if the specified library version is too old to work with latest SourceAFIS CLI.

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

If given SourceAFIS CLI port does not allow changing version on command line, you will have to edit SourceAFIS dependency version manually in project configuration.