Commit a35d4a91 authored by Olegs NIKISINS's avatar Olegs NIKISINS
Browse files

Added the DOC on Aggregated DB

parent f0263a06
......@@ -43,7 +43,10 @@ Notice that ``original_directory`` is set to ``[YOUR_AGGREGATED_DB_DIRECTORIES]`
You must make sure to create ``${HOME}/.bob_bio_databases.txt`` file setting this
value to the places where you actually installed the Replay-Attack, Replay-Mobile
and MSU MFSD Databases. In particular, the paths pointing to these 3 databases
must be saparated with a space. For example:
[YOUR_AGGREGATED_DB_DIRECTORIES] = <PATH_TO_REPLAY_ATTACK> <PATH_TO_REPLAY_MOBILE>
<PATH_TO_MSU_MFSD>
must be separated with a space. See the following note with an example of
``[YOUR_AGGREGATED_DB_DIRECTORIES]`` entry in the ``${HOME}/.bob_bio_databases.txt`` file.
.. note::
[YOUR_AGGREGATED_DB_DIRECTORIES] = <PATH_TO_REPLAY_ATTACK> <PATH_TO_REPLAY_MOBILE> <PATH_TO_MSU_MFSD>
"""
\ No newline at end of file
......@@ -162,7 +162,7 @@ class AggregatedDbPadDatabase(PadDatabase):
#==========================================================================
def objects(self, groups=None, protocol=None, purposes=None, model_ids=None, **kwargs):
"""
This function returns lists of ReplayPadFile objects, which fulfill the given restrictions.
This function returns a list of AggregatedDbPadFile objects, which fulfill the given restrictions.
Keyword parameters:
......
......@@ -31,6 +31,12 @@ MSU MFSD Database
.. autoclass:: bob.pad.face.database.msu_mfsd.MsuMfsdPadFile
.. autoclass:: bob.pad.face.database.msu_mfsd.MsuMfsdPadDatabase
Aggregated Database
========================
.. autoclass:: bob.pad.face.database.aggregated_db.AggregatedDbPadFile
.. autoclass:: bob.pad.face.database.aggregated_db.AggregatedDbPadDatabase
Pre-processors
------------------------------
......
......@@ -57,8 +57,10 @@ to run the baselines.
The current system readily supports the following freely available datasets:
* ``replay-attack``: `replayattack`_
* `REPLAYATTACK`_
* `REPLAY-MOBILE`_
* `MSU MFSD`_
* ``Aggregated DB``
After downloading the databases, annotate the base directories in which they
are installed. Then, follow the instructions in
......
......@@ -9,7 +9,6 @@
This section contains a listing of all ready-to-use resources you can find in
this package.
---------------------------------
......@@ -49,6 +48,14 @@ MSU MFSD Database
:members:
.. _bob.pad.face.resources.databases.aggregated_db:
Aggregated Database
================================================================================
.. automodule:: bob.pad.face.config.database.aggregated_db
:members:
---------------------------------
......
Supports Markdown
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