Metadata-Version: 2.0
Name: colour-demosaicing
Version: 0.1.3
Summary: Colour - Demosaicing
Home-page: http://github.com/colour-science/colour-demosaicing
Author: Colour Developers
Author-email: colour-science@googlegroups.com
License: New BSD License - http://opensource.org/licenses/BSD-3-Clause
Description-Content-Type: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Requires-Dist: colour-science (>=0.3.11)
Provides-Extra: development
Requires-Dist: coverage (>=3.7.1); extra == 'development'
Requires-Dist: flake8 (>=2.1.0); extra == 'development'
Requires-Dist: invoke; extra == 'development'
Requires-Dist: nose (>=1.3.4); extra == 'development'
Requires-Dist: restructuredtext-lint; extra == 'development'
Requires-Dist: twine; extra == 'development'
Requires-Dist: yapf; extra == 'development'
Provides-Extra: docs
Requires-Dist: sphinx (>=1.6.6); extra == 'docs'
Requires-Dist: sphinx-rtd-theme; extra == 'docs'
Requires-Dist: sphinxcontrib-bibtex; extra == 'docs'
Provides-Extra: tests
Requires-Dist: coverage (>=3.7.1); extra == 'tests'
Requires-Dist: flake8 (>=2.1.0); extra == 'tests'
Requires-Dist: nose (>=1.3.4); extra == 'tests'

Colour - Demosaicing
====================

..  image:: https://raw.githubusercontent.com/colour-science/colour-demosaicing/master/docs/_static/Demosaicing_001.png

.. start-badges

|travis| |coveralls| |codacy| |version|

.. |travis| image:: https://img.shields.io/travis/colour-science/colour-demosaicing/develop.svg?style=flat-square
    :target: https://travis-ci.org/colour-science/colour-demosaicing
    :alt: Develop Build Status
.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-demosaicing/develop.svg?style=flat-square
    :target: https://coveralls.io/r/colour-science/colour-demosaicing
    :alt: Coverage Status
.. |codacy| image:: https://img.shields.io/codacy/grade/984900e3a85e40239a0f8f633dd1ebcb/develop.svg?style=flat-square
    :target: https://www.codacy.com/app/colour-science/colour-demosaicing
    :alt: Code Grade
.. |version| image:: https://img.shields.io/pypi/v/colour-demosaicing.svg?style=flat-square
    :target: https://pypi.python.org/pypi/colour-demosaicing
    :alt: Package Version

.. end-badges

A `Python <https://www.python.org/>`_ package implementing various
CFA (Colour Filter Array) demosaicing algorithms and related utilities.

It is open source and freely available under the
`New BSD License <http://opensource.org/licenses/BSD-3-Clause>`_ terms.

Features
--------

The following CFA (Colour Filter Array) demosaicing algorithms are implemented:

-   Bilinear
-   Malvar (2004)
-   DDFAPD - Menon (2007)

Installation
------------

Because of their size, the resources dependencies needed to run the various
examples and unit tests are not provided within the Pypi package. They are
separately available as
`Git Submodules <https://git-scm.com/book/en/v2/Git-Tools-Submodules>`_
when cloning the
`repository <https://github.com/colour-science/colour-demosaicing>`_.

Primary Dependencies
^^^^^^^^^^^^^^^^^^^^

**Colour - Demosaicing** requires various dependencies in order to run:

-  `Python 2.7 <https://www.python.org/download/releases/>`_ or
   `Python 3.5 <https://www.python.org/download/releases/>`_
-  `NumPy <http://www.numpy.org/>`_
-  `OpenImageIO <https://github.com/OpenImageIO/oiio>`_

Pypi
^^^^

Once the dependencies satisfied, **Colour - Demosaicing** can be installed from
the `Python Package Index <http://pypi.python.org/pypi/colour-demosaicing>`_ by
issuing this command in a shell::

	pip install colour-demosaicing

The tests suite dependencies are installed as follows::

    pip install 'colour-demosaicing[tests]'

The documentation building dependencies are installed as follows::

    pip install 'colour-demosaicing[docs]'

Usage
-----

API
^^^

The main reference for `Colour - Demosaicing <https://github.com/colour-science/colour-demosaicing>`_
is the Sphinx `API Reference <https://colour-demosaicing.readthedocs.io/en/latest/api.html>`_.

Examples
^^^^^^^^

Various usage examples are available from the
`examples directory <https://github.com/colour-science/colour-demosaicing/tree/master/colour_demosaicing/examples>`_.

Contributing
------------

If you would like to contribute to `Colour - Demosaicing <https://github.com/colour-science/colour-demosaicing>`_,
please refer to the following `Contributing <http://colour-science.org/contributing/>`_
guide for `Colour <https://github.com/colour-science/colour>`_.

Bibliography
------------

The bibliography is available in the repository in
`BibTeX <https://github.com/colour-science/colour-demosaicing/blob/develop/BIBLIOGRAPHY.bib>`_
format.

About
-----

| **Colour - Demosaicing** by Colour Developers
| Copyright © 2015-2018 – Colour Developers – `colour-science@googlegroups.com <colour-science@googlegroups.com>`_
| This software is released under terms of New BSD License: http://opensource.org/licenses/BSD-3-Clause
| `http://github.com/colour-science/colour-demosaicing <http://github.com/colour-science/colour-demosaicing>`_


