Commit 7ff05f94 authored by André Anjos's avatar André Anjos 💬
Browse files

Improve package documentation

parent 6caf44ab
Pipeline #6364 passed with stages
in 2 minutes and 50 seconds
......@@ -5,10 +5,65 @@
User's Guide
==============
This package contains the access API and descriptions for the `3D Fingervein
Database`_. It only contains the Bob_ accessor methods to use the DB directly
from python, with our certified protocols. The actual raw data for the dataset
should be downloaded from the original URL.
Data for the 3DFV database was collected through various campaings in
Switzerland, at different locations. Each of the campaigns and outcomes are
summarized next:
* Foire du Valais (FDV): 89 subjects provided data from both index fingers in a
single data-acquisition session with a single attempt. For each subject
finger, 5 snapshots were taken. The unique subject identifiers vary between 1
and 94, but numeration is not contiguous.
* Idiap (IDI): 50 subjects provided data from both left and right index, middle
and ring fingers in 3 data acquisition sessions, each with 2 attempts. Two
more subjects provided data for the same fingers, but for only 1 acquisition
session (subjects 131 and 147). The unique subject identifiers range from 101
to 153. Numeration is contiguous.
Filename Structure
------------------
Filenames inside the 3D Fingervein are structured like this:
.. code-block:: text
<database-root>/<client:%03d>/<session:%d>/<attempt:%d>/<client:%03d>-<age:%02d>-<gender:%s><skin:%s><occ:%s><side:%s><finger:%s><session:%d><attempt:%d><snap:%d><cam:%d>.png
Each field can have these values:
* client: integer > 0
* age = integer > 0
* gender = str, 'm' or 'f'
* skin (color) = str, '1'..'6' or 'x'
* occ(upation) = str, '0'..'9' or 'x'
* side = str, 'l' or 'r'
* finger = str, 't', 'i', 'm', 'r', 'l'
* session = int > 0
* attempt = int > 0
* snap = int > 0
* cam = int, one of 1, 2 or 3 (1 is left, 2 is central, 3 is right)
Protocols
---------
Central
=======
The ``central`` protocol only makes use of images from the central camera of
the prototype (camera 2). Each finger is supposed to be considered a
*different* individual. Existing samples are divided like this:
* **Training set**: All subjects with only one session from FDV and Idiap
* **Development set**: Snapshots (2 per finger) and 2 attempts using the system
from all subjects with 3 sessions from Idiap. Modelling uses snapshots from
session 1, probing uses snapshots from sessions 2 and 3. While probing, one
should match every file listed as probe against all models in the set. In
this protocol, 1 snapshot image generates one model for the subject.
.. Place your references here
......
......@@ -33,69 +33,6 @@ on your references:
.. }
Data Acquisition Campaign
-------------------------
Data for the 3DFV database was collected through various campaings in
Switzerland, at different locations. Each of the campaigns and outcomes are
summarized next:
* Foire du Valais (FDV): 89 subjects provided data from both index fingers in a
single data-acquisition session with a single attempt. For each subject
finger, 5 snapshots were taken. The unique subject identifiers vary between 1
and 94, but numeration is not contiguous.
* Idiap (IDI): 50 subjects provided data from both left and right index, middle
and ring fingers in 3 data acquisition sessions, each with 2 attempts. Two
more subjects provided data for the same fingers, but for only 1 acquisition
session (subjects 131 and 147). The unique subject identifiers range from 101
to 153. Numeration is contiguous.
Filename Structure
------------------
Filenames inside the 3D Fingervein are structured like this:
.. code-block:: text
<database-root>/<client:%03d>/<session:%d>/<attempt:%d>/<client:%03d>-<age:%02d>-<gender:%s><skin:%s><occ:%s><side:%s><finger:%s><session:%d><attempt:%d><snap:%d><cam:%d>.png
Each field can have these values:
* client: integer > 0
* age = integer > 0
* gender = str, 'm' or 'f'
* skin (color) = str, '1'..'6' or 'x'
* occ(upation) = str, '0'..'9' or 'x'
* side = str, 'l' or 'r'
* finger = str, 't', 'i', 'm', 'r', 'l'
* session = int > 0
* attempt = int > 0
* snap = int > 0
* cam = int, one of 1, 2 or 3 (1 is left, 2 is central, 3 is right)
Protocols
---------
Central
=======
The ``central`` protocol only makes use of images from the central camera of
the prototype (camera 2). Each finger is supposed to be considered a
*different* individual. Existing samples are divided like this:
* **Training set**: All subjects with only one session from FDV and Idiap
* **Development set**: Snapshots (2 per finger) and 2 attempts using the system
from all subjects with 3 sessions from Idiap. Modelling uses snapshots from
session 1, probing uses snapshots from sessions 2 and 3. While probing, one
should match every file listed as probe against all models in the set. In
this protocol, 1 snapshot image generates one model for the subject.
Documentation
-------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment