diff --git a/develop.cfg b/develop.cfg new file mode 100644 index 0000000000000000000000000000000000000000..f8617f19c93663008158d1b270e9c09b0cdd219a --- /dev/null +++ b/develop.cfg @@ -0,0 +1,110 @@ +; vim: set fileencoding=utf-8 : +; Thu Oct 9 16:51:06 CEST 2014 + +[buildout] +parts = scripts +eggs = bob.pad.face + bob.extension + bob.blitz + bob.core + bob.sp + bob.math + bob.io.base + bob.ip.gabor + bob.measure + bob.ip.base + bob.learn.boosting + bob.io.image + bob.ip.draw + bob.ip.color + bob.io.video + bob.io.matlab + bob.learn.activation + bob.ip.flandmark + bob.ip.facedetect + bob.ip.qualitymeasure + bob.learn.linear + bob.db.base + bob.learn.em + bob.db.atnt + bob.bio.base + bob.bio.face + bob.learn.libsvm + bob.bio.video + bob.pad.base + +extensions = bob.buildout + mr.developer + +auto-checkout = * + +develop = src/bob.extension + src/bob.blitz + src/bob.core + src/bob.sp + src/bob.math + src/bob.io.base + src/bob.ip.gabor + src/bob.measure + src/bob.ip.base + src/bob.learn.boosting + src/bob.io.image + src/bob.ip.draw + src/bob.ip.color + src/bob.io.video + src/bob.io.matlab + src/bob.learn.activation + src/bob.ip.flandmark + src/bob.ip.facedetect + src/bob.ip.qualitymeasure + src/bob.learn.linear + src/bob.db.base + src/bob.learn.em + src/bob.db.atnt + src/bob.bio.base + src/bob.bio.face + src/bob.learn.libsvm + src/bob.bio.video + src/bob.pad.base + . + +; options for bob.buildout +debug = true +verbose = true +newest = false + +[sources] +bob.extension = git git@gitlab.idiap.ch:bob/bob.extension +bob.blitz = git git@gitlab.idiap.ch:bob/bob.blitz +bob.core = git git@gitlab.idiap.ch:bob/bob.core +bob.sp = git git@gitlab.idiap.ch:bob/bob.sp +bob.math = git git@gitlab.idiap.ch:bob/bob.math +bob.io.base = git git@gitlab.idiap.ch:bob/bob.io.base +bob.ip.gabor = git git@gitlab.idiap.ch:bob/bob.ip.gabor +bob.measure = git git@gitlab.idiap.ch:bob/bob.measure +bob.ip.base = git git@gitlab.idiap.ch:bob/bob.ip.base +bob.learn.boosting = git git@gitlab.idiap.ch:bob/bob.learn.boosting +bob.io.image = git git@gitlab.idiap.ch:bob/bob.io.image +bob.ip.draw = git git@gitlab.idiap.ch:bob/bob.ip.draw +bob.ip.color = git git@gitlab.idiap.ch:bob/bob.ip.color +bob.io.video = git git@gitlab.idiap.ch:bob/bob.io.video +bob.io.matlab = git git@gitlab.idiap.ch:bob/bob.io.matlab +bob.learn.activation = git git@gitlab.idiap.ch:bob/bob.learn.activation +bob.ip.flandmark = git git@gitlab.idiap.ch:bob/bob.ip.flandmark +bob.ip.facedetect = git git@gitlab.idiap.ch:bob/bob.ip.facedetect +bob.ip.qualitymeasure = git git@gitlab.idiap.ch:bob/bob.ip.qualitymeasure +bob.learn.linear = git git@gitlab.idiap.ch:bob/bob.learn.linear +bob.db.base = git git@gitlab.idiap.ch:bob/bob.db.base +bob.learn.em = git git@gitlab.idiap.ch:bob/bob.learn.em +bob.db.atnt = git git@gitlab.idiap.ch:bob/bob.db.atnt +bob.bio.base = git git@gitlab.idiap.ch:bob/bob.bio.base +bob.bio.face = git git@gitlab.idiap.ch:bob/bob.bio.face +bob.learn.libsvm = git git@gitlab.idiap.ch:bob/bob.learn.libsvm +bob.bio.video = git git@gitlab.idiap.ch:bob/bob.bio.video +bob.pad.base = git git@gitlab.idiap.ch:bob/bob.pad.base + + +[scripts] +recipe = bob.buildout:scripts +dependent-scripts = true + diff --git a/doc/baselines.rst b/doc/baselines.rst new file mode 100644 index 0000000000000000000000000000000000000000..862286641f88da5666ff2b205a72f56aaa704201 --- /dev/null +++ b/doc/baselines.rst @@ -0,0 +1,13 @@ + + +.. _bob.pad.face.baselines: + +=============================== + Executing Baseline Algorithms +=============================== + + + + + +.. include:: links.rst diff --git a/doc/guide.rst b/doc/guide.rst deleted file mode 100644 index e115bff942d3a1d0986d247572d8d933edb4a95b..0000000000000000000000000000000000000000 --- a/doc/guide.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. py:currentmodule:: bob.pad.face - -.. testsetup:: * - - from __future__ import print_function - import pkg_resources - -============================================================ - Presentation Attack Detection in Face Biometrics in Python -============================================================ - -MFCC Extraction ---------------- - -Two funct - diff --git a/doc/index.rst b/doc/index.rst index 8e68816b872bc0d554ec5313d5aede1f0bc92a75..a260d13f553315f56fd1407ed957d81afaa60135 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -2,20 +2,32 @@ .. _bob.pad.face: -================================================== - Presentation Attack Detection in Face Biometrics -================================================== +======================================================== +Library for Facial Presentation Attack Detection (PAD) +======================================================== -.. todolist:: +The Facial Presentation Attack Detection Library is an open source tool consisting of a +series of plugins for bob.pad.base_, our open-source biometric recognition +platform. As a result, it is fully extensible using bob.pad.base_ documented +types and techniques. Please refer to the manual of that package for a thorough +introduction. In this guide, we focus on details concerning +face PAD experiments using our plugins. -Package Documentation ---------------------- +============= +Users Guide +============= .. toctree:: :maxdepth: 2 - guide - refrences + installation + baselines + references + resources py_api +.. todolist:: + +.. include:: links.rst + diff --git a/doc/installation.rst b/doc/installation.rst new file mode 100644 index 0000000000000000000000000000000000000000..f3a8cbf7680bd46c1cc1b7bcb57e118ed245ef0a --- /dev/null +++ b/doc/installation.rst @@ -0,0 +1,92 @@ + + +============== + Installation +============== + +The installation of this package is divided in 2-parts. Installation of the +package and its software dependencies and the installation of databases. + + +Package Installation +-------------------- + +To install this package, first follow our `installation`_ instructions. Then, +using the Python interpreter provided by the distribution, bootstrap and +buildout this package: + + +.. code-block:: sh + + $ buildout + + +Sphinx Documentation Building +----------------------------- + +Once the package is installed, you may re-build this documentation locally by +running: + +.. code-block:: sh + + $ sphinx-build doc html + +The resulting HTML documentation will be output inside the directory `html`. + + +Setting up Databases +-------------------- + +In order to run face PAD algorithms using this package, you'll need to +make sure to download the raw files corresponding to the databases you'd like +to process. The raw files are not distributed with Bob_ software as biometric +data is, to most countries, considered sensible data that cannot be obtained +without explicit licensing from a data controller. You must visit the websites +below, sign the license agreements and then download the data before trying out +to run the baselines. + +.. note:: + + If you're at the Idiap Research Institute in Switzlerand, the datasets in + the baselines mentioned in this guide are already downloaded and + pre-installed on our shared file system. You don't need to re-download + databases or create a ``~/.bob_bio_databases.txt`` file. + + +The current system readily supports the following freely available datasets: + +* ``replay-attack``: `replayattack`_ + + +After downloading the databases, annotate the base directories in which they +are installed. Then, follow the instructions in +:ref:`bob.pad.base.installation` to let this framework know where databases are +located on your system. + + +Development +----------- + +If you're developing this package, you may automatically clone all necessary +Bob_ repositories on your local package installation. This allows you to build +against an environment which contains all of our dependencies_, but no +previously installed Bob_ packages. To do so, use the buildout recipe in +``develop.cfg`` just after bootstraping: + +.. code-block:: sh + + $ buildout -c develop.cfg + +Database SQL support files +========================== + +If you installed all packages from scratch like above, you'll need to download +the SQL support files of some of the database front-ends available in this +package. This operation can be easily done like this: + +.. code-block:: sh + + $ bob_dbmanage.py all download + + +.. include:: links.rst diff --git a/doc/links.rst b/doc/links.rst new file mode 100644 index 0000000000000000000000000000000000000000..56b4ead8c53eb5600ebee52aae0fed9e71f0354a --- /dev/null +++ b/doc/links.rst @@ -0,0 +1,14 @@ + + +.. This file contains all links we use for documentation in a centralized place + + +.. _idiap: http://www.idiap. +.. _bob: http://www.idiap.ch/software/bob +.. _buildout: http://www.buildout.org +.. _pypi: http://pypi.python.org +.. _installation: https://www.idiap.ch/software/bob/install +.. _bob.pad.base: https://pypi.python.org/pypi/bob.pad.base +.. _replayattack: https://www.idiap.ch/dataset/replayattack +.. _dependencies: https://gitlab.idiap.ch/bob/bob/wikis/Dependencies + diff --git a/doc/refrences.rst b/doc/references.rst similarity index 100% rename from doc/refrences.rst rename to doc/references.rst diff --git a/doc/resources.rst b/doc/resources.rst new file mode 100644 index 0000000000000000000000000000000000000000..7435c8480bd015c65699c10de0e631abbb76d483 --- /dev/null +++ b/doc/resources.rst @@ -0,0 +1,7 @@ + + +.. _bob.pad.face.resources: + +=========== + Resources +=========== \ No newline at end of file