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

Updated documentation

parent cb705dd3
......@@ -63,7 +63,7 @@ class Base (Preprocessor):
"""data_type(image) -> image
Converts the given image into the data type specified in the constructor of this class.
If no data type was specified, no conversion is performed.
If no data type was specified, or the ``image`` is ``None``, no conversion is performed.
**Parameters:**
......@@ -75,7 +75,7 @@ class Base (Preprocessor):
image : 2D or 3D :py:class:`numpy.ndarray`
The image converted to the desired data type, if any.
"""
if self.dtype is not None:
if self.dtype is not None and image is not None:
image = image.astype(self.dtype)
return image
......
......@@ -246,7 +246,7 @@ autodoc_default_flags = ['members', 'inherited-members', 'show-inheritance']
# For inter-documentation mapping:
from bob.extension.utils import link_documentation
intersphinx_mapping = link_documentation(['python', 'numpy', 'bob.bio.gmm', 'bob.bio.csu', 'bob.db.lfw'])
intersphinx_mapping = link_documentation(['python', 'numpy', 'bob.bio.gmm', 'bob.bio.video', 'bob.bio.csu', 'bob.db.lfw'])
def skip(app, what, name, obj, skip, options):
......
......@@ -20,6 +20,7 @@ This includes:
Additionally, a set of baseline algorithms are defined, which integrate well with the two other ``bob.bio`` packages:
* :ref:`bob.bio.gmm <bob.bio.gmm>` defines algorithms based on Gaussian mixture models
* :ref:`bob.bio.video <bob.bio.video>` uses face recognition algorithms in video frames
* :ref:`bob.bio.csu <bob.bio.csu>` provides wrapper classes of the `CSU Face Recognition Resources <http://www.cs.colostate.edu/facerec>`_ (only Python 2.7 compatible)
For more detailed information about the structure of the ``bob.bio`` packages, please refer to the documentation of :ref:`bob.bio.base <bob.bio.base>`.
......
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