Welcome to PalmveinRecLib’s documentation!

The PalmveinRecLib is an open source tool (based on FaceRecLib) that is designed to run comparable and reproducible palmvein recognition experiments.

Most of this documentation is based on the documentation of FaceRecLib.

To design a palmvein recognition experiment, one has to choose:

• an image databases and its according protocol,
• palm contours detection and image preprocessing algorithms,
• the type of features to extract from the palmvein image,
• the palmvein recognition algorithm to employ, and
• the way to evaluate the results

For any of these parts, several different types are implemented in the PalmveinRecLib, and basically any combination of the five parts can be executed. For each type, several meta-parameters can be tested. This results in a nearly infinite amount of possible palmvein recognition experiments that can be run using the current setup. But it is also possible to use your own database, preprocessing, feature type, or palmvein recognition algorithm and test this against the baseline algorithms implemented in the PalmveinRecLib.

If you are interested, please continue reading:

Users Guide

• Installation Instructions
  • Download
  • Set-up your PalmveinRecLib
• Running Experiments
  • Required Command Line Arguments
  • Databases
  • Preprocessors
  • Feature Extractors
  • Recognition Algorithms
  • Parallel Execution of Experiments
  • Command Line Arguments to change Default Behavior
  • Other Arguments
• Evaluating Score Files
  • Interpreting Score Files
  • Evaluation
  • Deep Evaluation
• Implementing your own Database, Preprocessor, Feature Extractor, or Recognition Algorithm
  • Implementing your own Functions
  • Executing experiments with your classes
  • Adding Unit Tests
  • Adding Configuration Files
  • Registering your Code as a Resource
• Create your own Satellite Package
  • Contribute your Code
• References

This documentation is still under development.