Commit 6a64fea3 authored by Manuel Günther's avatar Manuel Günther
Browse files

Updated documentation.

parent e7c48cc1
......@@ -26,9 +26,21 @@ class Database(bob.db.verification.utils.Database):
This class defines a simple protocol for training, enrollment and probe by splitting the few images of the database in a reasonable manner.
Due to the small size of the database, there is only a 'dev' group, and I did not define an 'eval' group."""
def __init__(self):
def __init__(self, original_directory = None, original_extension = '.pgm'):
"""**Constructor Documentation**
Generates a database.
Keyword parameters
original_directory : str, optional
The directory, where you extracted the original images to.
original_extension : str
The filename extension of the original images. Rarely changed.
"""
# call base class constructor
bob.db.verification.utils.Database.__init__(self)
bob.db.verification.utils.Database.__init__(self, original_directory=original_directory, original_extension=original_extension)
# initialize members
self.m_groups = ('world', 'dev')
self.m_purposes = ('enrol', 'probe')
......
......@@ -7,7 +7,6 @@
#
# 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
......@@ -40,7 +39,7 @@ extensions = [
'sphinx.ext.autosummary',
'sphinx.ext.doctest',
'sphinx.ext.intersphinx',
'bob.sphinxext.plot', # ours add source copying to install directory
# 'bob.sphinxext.plot', # ours add source copying to install directory
]
# The viewcode extension appeared only on Sphinx >= 1.0.0
......@@ -151,7 +150,7 @@ html_favicon = ''
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
#html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
......
.. vim: set fileencoding=utf-8 :
.. @author: Manuel Guenther <Manuel.Guenther@idiap.ch>
.. @date: Thu Dec 6 12:28:25 CET 2012
==============
User's Guide
==============
.. todo::
Write users guide.
.. vim: set fileencoding=utf-8 :
.. @author: Manuel Guenther <Manuel.Guenther@idiap.ch>
.. @date: Tue Aug 26 09:42:18 CEST 2014
==============================================
AT&T Database of Faces Verification Protocol
==============================================
.. todolist::
This module contains the interface to query the face verification protocol for the AT&T database of faces (formerly known as the ORL face database).
.. note::
This protocol interface does not include the original image data.
Please download the data yourself from http://www.cl.cam.ac.uk/research/dtg/attarchive/facedatabase.html
.. warning::
The AT&T Database of Faces is a small, old and outdated facial image database.
According to [LiJain2005]_, the *algorithm performance over this database has been saturated*.
This database should only be used for development or testing purposes, and **not** to publish scientific papers based on its results!
.. [LiJain2005] **Stan Z. Li and Anil K. Jain**, *Handbook of Face Recognition*, Springer, 2005.
Documentation
-------------
.. toctree::
:maxdepth: 2
guide
py_api
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
......@@ -2,8 +2,8 @@
.. Andre Anjos <andre.anjos@idiap.ch>
.. Mon 13 Aug 2012 12:36:40 CEST
===================
AT&T/ORL Database
===================
============
Python API
============
.. automodule:: bob.db.atnt
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment