Commit 5bafa15f authored by André Anjos's avatar André Anjos 💬
Browse files

Add documentation

parent 558c3c11
#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
# Andre Anjos <>
# Tue 15 Oct 16:37:18 2013 CEST
# Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland
import os
import sys
import glob
import pkg_resources
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
# The viewcode extension appeared only on Sphinx >= 1.0.0
import sphinx
if sphinx.__version__ >= "1.0":
# Always includes todos
todo_include_todos = True
# If we are on OSX, the 'dvipng' path maybe different
dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng'
if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u''
import time
copyright = u'%s, Idiap Research Institute' % time.strftime('%Y')
# Grab the setup entry
distribution = pkg_resources.require('')[0]
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
# The short X.Y version.
version = distribution.version
# The full version, including alpha/beta/rc tags.
release = distribution.version
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['links.rst']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
if sphinx.__version__ >= "1.0":
html_theme = 'nature'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = ''
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = 'img/logo.png'
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = 'img/favicon.ico'
# 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']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = ''
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
latex_paper_size = 'a4'
# The font size ('10pt', '11pt' or '12pt').
latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', '', u'Video I/O Support for Bob',
u'Biometrics Group, Idiap Research Institute', 'manual'),
# The name of an image file (relative to this directory) to place at the top of
# the title page.
latex_logo = ''
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# Included after all input documents
rst_epilog = """
.. |project| replace:: Bob
.. |url| replace::
.. |version| replace:: %s
.. |current-year| date:: %%Y
""" % (version,)
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', '', u'Video I/O Support for Bob',
[u'Idiap Research Institute'], 1)
# Default processing flags for sphinx
autoclass_content = 'both'
autodoc_member_order = 'bysource'
autodoc_default_flags = ['members', 'undoc-members', 'inherited-members', 'show-inheritance']
def smaller_than(v1, v2):
"""Compares scipy/numpy version numbers"""
c1 = v1.split('.')
c2 = v2.split('.')[:len(c1)] #clip to the compared version
for i, k in enumerate(c2):
n1 = c1[i]
n2 = c2[i]
n1 = int(n1)
n2 = int(n2)
except ValueError:
n1 = str(n1)
n2 = str(n2)
if n1 > n2: return False
return True
# Some name mangling to find the correct sphinx manuals for some packages
numpy_version = __import__('numpy').version.version
if smaller_than(numpy_version, '1.5.z'):
numpy_version = '.'.join(numpy_version.split('.')[:-1]) + '.x'
numpy_version = '.'.join(numpy_version.split('.')[:-1]) + '.0'
numpy_manual = '' % numpy_version
# For inter-documentation mapping:
intersphinx_mapping = {
'' % sys.version_info[:2]: None,
numpy_manual: None,
def setup(app):
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <>
.. Tue 15 Oct 17:41:52 2013
.. testsetup:: *
import numpy
User Guide
This package provides support for dealing with videos in an equivalent way to
dealing with other data files in |project|:
.. doctest::
>>> my_video = numpy.random.random_integers(0,255,(30,3,256,256))
>>>'uint8'), 'testvideo.avi') # saving the video avi format with a default codec
>>> my_video_copy ='testvideo.avi')
Video reading and writing is performed using an `FFmpeg`_ (or `libav`_ if
`FFmpeg`_ is not available) bridge. |project|'s :py:meth:``
method will allow you to choose the output format with the same extension
mechanism as mentioned earlier. `FFmpeg`_ will then choose a default codec for
the format and perform encoding. The output file can be as easily loaded using
For finer control over the loading, saving, format and codecs used for a
specific encoding or decoding operation, you must directly use either
:py:class:`` or :py:class:``
classes. For example, it is possible to use
:py:class:`` to read videos frame by frame and avoid
overloading your machine's memory. In the following example you can see how to
create a video, save it using the class :py:class:``
and load it again using the class :py:class:``. The
created video will have 30 frames generated randomly.
.. note::
Due to `FFmpeg`_ constrains, the width and height of the video need to be
multiples of two.
.. doctest::
>>> width = 50; height = 50;
>>> framerate = 24
>>> outv ='testvideo.avi', height, width, framerate, codec='mpeg1video') # output video
>>> for i in range(0, 30):
... newframe = (numpy.random.random_integers(0,255,(3,height,width)))
... outv.append(newframe.astype('uint8'))
>>> outv.close()
>>> input ='testvideo.avi')
>>> input.number_of_frames
>>> inv = input.load()
>>> inv.shape
(30, 3, 50, 50)
>>> type(inv)
<... 'numpy.ndarray'>
Videos in |project| are represented as sequences of colored images, i.e. 4D
arrays of type ``uint8``. All the extensions and formats for videos supported
in version of |project| installed on your machine can be listed using the
|project|'s utility ````.
.. testcleanup:: *
import shutil
.. warning::
Please read :doc:`video` for details on choosing codecs and formats that are
adequate to your application, as well as drawbacks and pitfalls with video
encoding and decoding.
.. Place here your external references
.. include:: links.rst
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <>
.. Wed 14 May 15:22:33 2014 CEST
.. Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland
Bob's Video I/O Routines
.. todolist::
This module provides two Video I/O components:
1. A plugin for :py:mod:`` that allows |project| to read and write
videos using its native API (:py:func:`` and
2. A special interface for reading and writing video files with an enhanced set
of options. This includes the possibility to define the recording rate,
codec and/or format to be used for example.
.. toctree::
:maxdepth: 2
Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. include:: links.rst
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <>
.. Tue 20 Mar 2012 08:57:32 CET
.. Copyright (C) 2011-2014 Idiap Research Institute, Martigny, Switzerland
.. This file contains all links we use for documentation in a centralized place
.. Place here references to all citations in lower case
.. _argparse:
.. _blitz++:
.. _bob's idiap guide:
.. _bob's website:
.. _boost:
.. _buildbot:
.. _buildout:
.. _c++:
.. _cmake:
.. _doxygen:
.. _dvipng:
.. _ffmpeg:
.. _libav:
.. _fftw:
.. _fink:
.. _git:
.. _github:
.. _google perftools:
.. _hdf5:
.. _idiap:
.. _ipython:
.. _lapack:
.. _latex:
.. _libjpeg:
.. _libnetpbm:
.. _libpng:
.. _libsvm:
.. _libtiff:
.. _giflib:
.. _macports installation instructions:
.. _macports:
.. _matio:
.. _matlab:
.. _matplotlib:
.. _numpy:
.. _nose:
.. _opencv:
.. _pil:
.. _pillow:
.. _python:
.. _pypi:
.. _qt4:
.. _satellite packages:
.. _scipy:
.. _setuptools:
.. _sphinx:
.. _sqlalchemy:
.. _sqlite:
.. _submit a new bug report:
.. _torch 3 vision:
.. _torch 3:
.. _torch 5:
.. _torch:
.. _vlfeat launchpad webpage:
.. _vlfeat:
.. Place here references to licenses
.. _apache-2.0:
.. _artistic-2.0:
.. _bsd-2-clause:
.. _bsd-3-clause:
.. _bsl-1.0:
.. _gpl-2.0:
.. _gpl-3.0:
.. _hdf5 license:
.. _lgpl-2.1:
.. _libpng license:
.. _mit:
.. _python-2.0:
.. vim: set fileencoding=utf-8 :
.. Andre Anjos <>
.. Fri 16 May 09:53:05 2014 CEST
Python API
This section includes information for using the pure Python API of
.. automodule::
This diff is collapsed.
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