From 428905722a6af8be807fcd7cdb8625fac270f294 Mon Sep 17 00:00:00 2001
From: Olegs NIKISINS <onikisins@italix03.idiap.ch>
Date: Tue, 20 Jun 2017 14:54:19 +0200
Subject: [PATCH] Added doc for Replay-attack DB to resources section
---
bob/pad/face/config/database/replay.py | 28 ++++++++++++++++++++++++++
doc/resources.rst | 12 +++++++++--
2 files changed, 38 insertions(+), 2 deletions(-)
diff --git a/bob/pad/face/config/database/replay.py b/bob/pad/face/config/database/replay.py
index f1cbd70c..197355ce 100644
--- a/bob/pad/face/config/database/replay.py
+++ b/bob/pad/face/config/database/replay.py
@@ -1,11 +1,25 @@
#!/usr/bin/env python
+"""`Replayattack`_ is a database for face PAD experiments.
+
+The Replay-Attack Database for face spoofing consists of 1300 video clips of photo and video attack attempts to 50 clients,
+under different lighting conditions. This Database was produced at the Idiap Research Institute, in Switzerland.
+The reference citation is [CAM12]_.
+
+You can download the raw data of the `Replayattack`_ database by following
+the link.
+
+.. include:: links.rst
+"""
+
from bob.pad.face.database import ReplayPadDatabase
# 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_REPLAY_ATTACK_DIRECTORY]"
+"""Value of ``~/.bob_bio_databases.txt`` for this database"""
+
original_extension = ".mov" # extension of the data files
@@ -15,3 +29,17 @@ database = ReplayPadDatabase(
original_extension=original_extension,
training_depends_on_protocol=True,
)
+"""The :py:class:`bob.pad.base.database.PadDatabase` derivative with Replayattack
+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_REPLAY_ATTACK_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`.
+"""
\ No newline at end of file
diff --git a/doc/resources.rst b/doc/resources.rst
index 77edc5e6..f943abba 100644
--- a/doc/resources.rst
+++ b/doc/resources.rst
@@ -10,19 +10,27 @@ This section contains a listing of all ready-to-use resources you can find in
this package.
+---------------------------------
+
.. _bob.pad.face.resources.databases:
Databases
------------
+These configuration files/resources contain entry points for the ``--database`` command line argument of the
+``spoof.py`` script.
+.. _bob.pad.face.resources.databases.replay:
+Replay-attack Database
+================================================================================
+.. automodule:: bob.pad.face.config.database.replay
+ :members:
-
-
+---------------------------------
.. _bob.pad.face.resources.face_pad:
--
GitLab