diff --git a/README.rst b/README.rst index 255e3d3d6fd99a880824f2119788837a806b5e64..454ca3c2a1b8a1dc0db6d95085d26a68a0f78b0d 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,27 @@ .. vim: set fileencoding=utf-8 : .. Pavel Korshunov <pavel.korshunov@idiap.ch> -.. Wed 30 Sep 23:36:23 2015 CET +.. Wed 19 Oct 22:36:22 2016 CET + +.. image:: http://img.shields.io/badge/docs-stable-yellow.png + :target: http://pythonhosted.org/bob.pad.base/index.html +.. image:: http://img.shields.io/badge/docs-latest-orange.png + :target: https://www.idiap.ch/software/bob/docs/latest/bob/bob.pad.base/master/index.html +.. image:: https://gitlab.idiap.ch/bob/bob.pad.base/badges/master/build.svg + :target: https://gitlab.idiap.ch/bob/bob.pad.base/commits/master +.. image:: https://img.shields.io/badge/gitlab-project-0000c0.svg + :target: https://gitlab.idiap.ch/bob/bob.pad.base +.. image:: http://img.shields.io/pypi/v/bob.pad.base.png + :target: https://pypi.python.org/pypi/bob.pad.base +.. image:: http://img.shields.io/pypi/dm/bob.pad.base.png + :target: https://pypi.python.org/pypi/bob.pad.base ======================================== Scripts to run anti-spoofing experiments ======================================== -This package is part of the ``bob.pad`` packages, which allow to run comparable and reproducible presentation attack detection (PAD) experiments on publicly available databases. +This package is part of the signal-processing and machine learning toolbox +Bob_. This package is the base of ``bob.pad`` family of packages, which allow to run comparable and reproducible +presentation attack detection (PAD) experiments on publicly available databases. This package contains basic functionality to run PAD experiments. It provides a generic ``./bin/spoof.py`` script that takes several parameters, including: @@ -18,15 +33,27 @@ It provides a generic ``./bin/spoof.py`` script that takes several parameters, i All these steps of the PAD system are given as configuration files. -In this base class implementation, only a core functionality is implemented. The specialized algorithms should be provided by other packages, which are usually in the ``bob.pad`` namespace, such as: - -* `bob.pad.voice for speech-related PAD algorithms - +In this base class implementation, only a core functionality is implemented. The specialized algorithms should +be provided by other packages, which are usually in the ``bob.pad`` namespace, like ``bob.pad.voice`` Installation ------------ -To install this package -- alone or together with other `Packages of Bob <https://github.com/idiap/bob/wiki/Packages>`_ -- please read the `Installation Instructions <https://github.com/idiap/bob/wiki/Installation>`_. -For Bob_ to be able to work properly, some dependent packages are required to be installed. -Please make sure that you have read the `Dependencies <https://github.com/idiap/bob/wiki/Dependencies>`_ for your operating system. +Follow our `installation`_ instructions. Then, using the Python interpreter +provided by the distribution, bootstrap and buildout this package:: + + $ python bootstrap-buildout.py + $ ./bin/buildout + + +Contact +------- + +For questions or reporting issues to this software package, contact our +development `mailing list`_. + + +.. Place your references here: .. _bob: https://www.idiap.ch/software/bob +.. _installation: https://gitlab.idiap.ch/bob/bob/wikis/Installation +.. _mailing list: https://groups.google.com/forum/?fromgroups#!forum/bob-devel \ No newline at end of file diff --git a/bob/pad/base/algorithm/Algorithm.py b/bob/pad/base/algorithm/Algorithm.py index e61570c7bad3e95ec272dbb5a042b0b0c3bfe439..6996f5ca7deb559359bf4375b1ae44b5a0c43403 100644 --- a/bob/pad/base/algorithm/Algorithm.py +++ b/bob/pad/base/algorithm/Algorithm.py @@ -3,19 +3,6 @@ # Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. import numpy import os diff --git a/bob/pad/base/script/spoof.py b/bob/pad/base/script/spoof.py index 008014618c3c6dc67ea819af202fc53671d7f748..8e04ce849af3e8d7844c9ab1b88aad5ed4db5ba5 100644 --- a/bob/pad/base/script/spoof.py +++ b/bob/pad/base/script/spoof.py @@ -3,19 +3,6 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. from __future__ import print_function diff --git a/bob/pad/base/test/dummy/algorithm.py b/bob/pad/base/test/dummy/algorithm.py index 80e4549029bd7bde464f27800779bd09cb645327..e1e8f80a72443f9bdcfd49173aeec221a8885790 100644 --- a/bob/pad/base/test/dummy/algorithm.py +++ b/bob/pad/base/test/dummy/algorithm.py @@ -3,19 +3,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import numpy import bob.io.base diff --git a/bob/pad/base/test/dummy/database.py b/bob/pad/base/test/dummy/database.py index a6e056ea8e5a2d8bdf511c508eb6b8978f925510..aa7cbcae931a4332ed0f9644479686fc4e6d299d 100644 --- a/bob/pad/base/test/dummy/database.py +++ b/bob/pad/base/test/dummy/database.py @@ -3,19 +3,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import os import sys diff --git a/bob/pad/base/test/dummy/extractor.py b/bob/pad/base/test/dummy/extractor.py index d7f6a07c58242d3e2ea9bee4e1e44350905f7284..8e65a74bfc27ad9bb5b87df83b7fc4dcc329540c 100644 --- a/bob/pad/base/test/dummy/extractor.py +++ b/bob/pad/base/test/dummy/extractor.py @@ -3,19 +3,6 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. from bob.bio.base.extractor import Extractor diff --git a/bob/pad/base/test/dummy/preprocessor.py b/bob/pad/base/test/dummy/preprocessor.py index e17e72b16c8a8172ae63c0afe9dc1511b75faec1..ea3fff27afd5147a3e86e95f34cc5eb10f420db0 100644 --- a/bob/pad/base/test/dummy/preprocessor.py +++ b/bob/pad/base/test/dummy/preprocessor.py @@ -3,19 +3,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + from bob.bio.base.preprocessor import Preprocessor import os.path diff --git a/bob/pad/base/test/test_databases.py b/bob/pad/base/test/test_databases.py index d3191c2ca9d7d54de075ac0219ff530891e8564f..3653eb5a9ccdfbf58670cc9641de32e250ae662d 100644 --- a/bob/pad/base/test/test_databases.py +++ b/bob/pad/base/test/test_databases.py @@ -3,20 +3,6 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. - import os import unittest diff --git a/bob/pad/base/test/test_spoof.py b/bob/pad/base/test/test_spoof.py index ad7fd1e3f040977e725493c7a6b1960012afa828..779946bf8cf052ac757a975a13a5790403f1ba11 100644 --- a/bob/pad/base/test/test_spoof.py +++ b/bob/pad/base/test/test_spoof.py @@ -4,19 +4,6 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Thu Apr 21 16:41:21 CEST 2016 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. from __future__ import print_function diff --git a/bob/pad/base/tools/FileSelector.py b/bob/pad/base/tools/FileSelector.py index e91e21852ada001427e6cbd35d6be11a29d37045..aa0e8342a7797b6b61708fe73afc62afa4138f51 100644 --- a/bob/pad/base/tools/FileSelector.py +++ b/bob/pad/base/tools/FileSelector.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import os diff --git a/bob/pad/base/tools/algorithm.py b/bob/pad/base/tools/algorithm.py index 0cf1c6eef20f91a852fd3545d4bb39b1a41b5377..34ed55cf23cb5a5a06b117f00393a3806f757198 100644 --- a/bob/pad/base/tools/algorithm.py +++ b/bob/pad/base/tools/algorithm.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import bob.io.base import os diff --git a/bob/pad/base/tools/command_line.py b/bob/pad/base/tools/command_line.py index 7028da9bdc0d9520d95931776c6e800776b378c6..041e31d0e3adc47be8644af62efff259646f2099 100644 --- a/bob/pad/base/tools/command_line.py +++ b/bob/pad/base/tools/command_line.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import argparse import os diff --git a/bob/pad/base/tools/extractor.py b/bob/pad/base/tools/extractor.py index c8acb67344dd527e58c772e96b6a56852e0c85b2..018076d3c8160a93d70b1cafe8827b7ef4ab7977 100644 --- a/bob/pad/base/tools/extractor.py +++ b/bob/pad/base/tools/extractor.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import bob.io.base import os diff --git a/bob/pad/base/tools/preprocessor.py b/bob/pad/base/tools/preprocessor.py index 0db64a3bef411f6a7b119065c2704394a6cb074f..163ceef1ac4b3f915adabb6e8f4ad229471ea728 100644 --- a/bob/pad/base/tools/preprocessor.py +++ b/bob/pad/base/tools/preprocessor.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import bob.io.base import os diff --git a/bob/pad/base/tools/scoring.py b/bob/pad/base/tools/scoring.py index f9c89335d5f542ba7d97197b116c6bd2389421f3..12c713cac00c8624e3aec8e55b5f69b1f7f43498 100644 --- a/bob/pad/base/tools/scoring.py +++ b/bob/pad/base/tools/scoring.py @@ -4,19 +4,7 @@ # @author: Pavel Korshunov <pavel.korshunov@idiap.ch> # @date: Wed 19 Aug 13:43:21 2015 # -# Copyright (C) 2011-2012 Idiap Research Institute, Martigny, Switzerland -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, version 3 of the License. -# -# This program is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -# GNU General Public License for more details. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. + import bob.io.base import bob.measure diff --git a/doc/implementation.rst b/doc/implementation.rst index 155ea1231d8a5b3e0c207a5c7416cf53a054e68b..599ec462531fb01f54d323c4bb470acfa5034073 100644 --- a/doc/implementation.rst +++ b/doc/implementation.rst @@ -93,7 +93,7 @@ Implemented Tools Example implementations of the base classes can be found in all of the ``bob.pad`` packages. Here is the current list of implementations: -* `bob.pad.voice` +* ``bob.pad.voice`` .. todo:: complete this list, once the other packages are documented as well. diff --git a/doc/index.rst b/doc/index.rst index cb38cc703da8666c17046ab40167c5ce47b6b89e..4a0971805dc67330ca924185cfb3a4a315004fae 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -34,7 +34,7 @@ The implementation of (most of) the tools is separated into other packages in th All these packages can be easily combined. Here is a growing list of derived packages: -* `bob.pad.voice <http://pypi.python.org/pypi/bob.pad.voice>`__` Tools to run presentation attack detection experiments for speech, including several Cepstral-based features and LBP-based feature extraction, GMM-based and logistic regression based algorithms, as well as plot and score fusion scripts. +* `bob.pad.voice <http://pypi.python.org/pypi/bob.pad.voice>`__ Tools to run presentation attack detection experiments for speech, including several Cepstral-based features and LBP-based feature extraction, GMM-based and logistic regression based algorithms, as well as plot and score fusion scripts. If you are interested, please continue reading: diff --git a/doc/installation.rst b/doc/installation.rst index 91816a03417b9d38bd584f47b9fa62abbf6ea2fe..28d4c15912fa2ba25f89293d7f15a7be51df5adc 100644 --- a/doc/installation.rst +++ b/doc/installation.rst @@ -63,7 +63,7 @@ Please use ``./bin/databases.py`` for a list of known databases, where you can s .. note:: - If you have installed only ``bob.pad.base``, there is no database listed -- as all databases are included in other extension packages, such as `bob.pad.voice`. + If you have installed only ``bob.pad.base``, there is no database listed -- as all databases are included in other extension packages, such as ``bob.pad.voice``. Test your Installation diff --git a/setup.py b/setup.py index 9747ba932a26fdcee271ba94d14f36e1f0a95725..8c6626c00e5d85c9a2124cf4a843954fd59ce565 100644 --- a/setup.py +++ b/setup.py @@ -51,7 +51,7 @@ setup( version=open("version.txt").read().rstrip(), description='A framework for executing the chain of presentation attack detection (PAD) experiments', - url='https://www.github.com/bioidiap/bob.pad.base', + url='https://gitlab.idiap.ch/bob/bob.pad.base', license='GPLv3', author='Pavel Korshunov', author_email='pavel.korshunov@idiap.ch',