From a35d4a91e400410f6d0eb5d8ff86b9fd86316adb Mon Sep 17 00:00:00 2001
From: Olegs NIKISINS <onikisins@italix03.idiap.ch>
Date: Mon, 17 Jul 2017 11:14:18 +0200
Subject: [PATCH] Added the DOC on Aggregated DB
---
bob/pad/face/config/database/aggregated_db.py | 9 ++++++---
bob/pad/face/database/aggregated_db.py | 2 +-
doc/api.rst | 6 ++++++
doc/installation.rst | 6 ++++--
doc/resources.rst | 9 ++++++++-
5 files changed, 25 insertions(+), 7 deletions(-)
diff --git a/bob/pad/face/config/database/aggregated_db.py b/bob/pad/face/config/database/aggregated_db.py
index 375a1751..7e15a7dd 100644
--- a/bob/pad/face/config/database/aggregated_db.py
+++ b/bob/pad/face/config/database/aggregated_db.py
@@ -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
diff --git a/bob/pad/face/database/aggregated_db.py b/bob/pad/face/database/aggregated_db.py
index 8decbe0e..ca160336 100644
--- a/bob/pad/face/database/aggregated_db.py
+++ b/bob/pad/face/database/aggregated_db.py
@@ -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:
diff --git a/doc/api.rst b/doc/api.rst
index 8f94169a..3b834a8c 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -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
------------------------------
diff --git a/doc/installation.rst b/doc/installation.rst
index 504281c7..52f75661 100644
--- a/doc/installation.rst
+++ b/doc/installation.rst
@@ -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
diff --git a/doc/resources.rst b/doc/resources.rst
index 9edada2e..7d03b968 100644
--- a/doc/resources.rst
+++ b/doc/resources.rst
@@ -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:
+
---------------------------------
--
GitLab