From 827e56b63e2db22778d574028ad83ef63d1a57fd Mon Sep 17 00:00:00 2001
From: David Geissbuhler <david.geissbuhler@idiap.ch>
Date: Tue, 26 Sep 2017 14:42:22 +0200
Subject: [PATCH] Fixed documentation
---
bob/pad/face/config/database/mifs.py | 33 ++++++++++++++++++++++++++++
bob/pad/face/config/replay_attack.py | 2 +-
bob/pad/face/database/mifs.py | 4 ++--
3 files changed, 36 insertions(+), 3 deletions(-)
create mode 100644 bob/pad/face/config/database/mifs.py
diff --git a/bob/pad/face/config/database/mifs.py b/bob/pad/face/config/database/mifs.py
new file mode 100644
index 00000000..b70b3105
--- /dev/null
+++ b/bob/pad/face/config/database/mifs.py
@@ -0,0 +1,33 @@
+
+
+from bob.pad.face.database.mifs import MIFSPadDatabase
+
+
+# Directory where the data files are stored.
+# This directory is given in the .bob_bio_databases.txt file located in your home directory
+original_directory = "[YOUR_MIFS_DATABASE_DIRECTORY]"
+"""Value of ``~/.bob_bio_databases.txt`` for this database"""
+
+original_extension = ".jpg" # extension of the data files
+
+
+database = MIFSPadDatabase(
+ protocol='grandtest',
+ original_directory=original_directory,
+ original_extension=original_extension,
+ training_depends_on_protocol=True,
+)
+"""The :py:class:`bob.pad.base.database.PadDatabase` derivative with MIFS
+database settings.
+
+.. warning::
+
+ This class only provides a programmatic interface to load data in an orderly
+ manner, respecting usage protocols. It does **not** contain the raw
+ data files. You should procure those yourself.
+
+Notice that ``original_directory`` is set to ``[YOUR_MIFS_DATABASE_DIRECTORY]``.
+You must make sure to create ``${HOME}/.bob_bio_databases.txt`` setting this
+value to the place where you actually installed the MIFS Database, as
+explained in the section :ref:`bob.pad.face.baselines`.
+"""
diff --git a/bob/pad/face/config/replay_attack.py b/bob/pad/face/config/replay_attack.py
index aa73eb99..d7e4b259 100644
--- a/bob/pad/face/config/replay_attack.py
+++ b/bob/pad/face/config/replay_attack.py
@@ -40,7 +40,7 @@ database settings
manner, respecting usage protocols. It does **not** contain the raw
data files. You should procure those yourself.
-Notice that ``original_directory`` is set to ``[YOUR_REPLAY_ATTACK_DIRECTORY]``.
+Notice that ``original_directory`` is set to ``[YOUR_MIFS_DATABASE_DIRECTORY]``.
You must make sure to create ``${HOME}/.bob_bio_databases.txt`` setting this
value to the place where you actually installed the Replayattack Database, as
explained in the section :ref:`bob.pad.face.baselines`.
diff --git a/bob/pad/face/database/mifs.py b/bob/pad/face/database/mifs.py
index 42673ee1..8f96ee40 100644
--- a/bob/pad/face/database/mifs.py
+++ b/bob/pad/face/database/mifs.py
@@ -78,8 +78,8 @@ class MIFSPadDatabase(FileListPadDatabase):
def annotations(self, f):
"""
Return annotations for a given file object ``f``, which is an instance
- of ``ReplayPadFile`` defined in the HLDI of the Replay-Attack DB.
- The ``load()`` method of ``ReplayPadFile`` class (see above)
+ of ``MIFSPadFile`` defined in the HLDI of the MIFS DB.
+ The ``load()`` method of ``MIFSPadFile`` class (see above)
returns a video, therefore this method returns bounding-box annotations
for each video frame. The annotations are returned as dictionary of dictionaries.
--
GitLab