Metadata-Version: 2.1
Name: colour-demosaicing
Version: 0.2.0
Summary: CFA (Colour Filter Array) Demosaicing Algorithms for Python
Home-page: https://www.colour-science.org/
License: BSD-3-Clause
Keywords: cfa,bayer,color,color-science,color-space,color-spaces,colorspace,colorspaces,colour,colour-science,colour-space,colour-spaces,colourspace,colourspaces,de-mosaicing,debayering,demosaicing,demosaicking,python,raw
Author: Colour Developers
Author-email: colour-developers@colour-science.org
Maintainer: Colour Developers
Maintainer-email: colour-developers@colour-science.org
Requires-Python: >=3.8,<3.11
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Provides-Extra: development
Provides-Extra: plotting
Provides-Extra: read-the-docs
Requires-Dist: biblib-simple; extra == "development"
Requires-Dist: black; extra == "development"
Requires-Dist: colour-science (>=0.4.0)
Requires-Dist: coverage (!=6.3); extra == "development"
Requires-Dist: coveralls; extra == "development"
Requires-Dist: flake8; extra == "development"
Requires-Dist: flynt; extra == "development"
Requires-Dist: invoke; extra == "development"
Requires-Dist: jupyter; extra == "development"
Requires-Dist: matplotlib (>=3.2,!=3.5.0,!=3.5.1); extra == "plotting" or extra == "read-the-docs"
Requires-Dist: mypy; extra == "development"
Requires-Dist: numpy (>=1.19,<2); extra == "read-the-docs"
Requires-Dist: pre-commit; extra == "development"
Requires-Dist: pydata-sphinx-theme; extra == "development" or extra == "read-the-docs"
Requires-Dist: pydocstyle; extra == "development"
Requires-Dist: pytest-cov; extra == "development"
Requires-Dist: pytest; extra == "development"
Requires-Dist: pyupgrade; extra == "development"
Requires-Dist: restructuredtext-lint; extra == "development"
Requires-Dist: sphinx (>=4,<5); extra == "development"
Requires-Dist: sphinxcontrib-bibtex; extra == "development" or extra == "read-the-docs"
Requires-Dist: toml; extra == "development"
Requires-Dist: twine; extra == "development"
Project-URL: Repository, https://github.com/colour-science/colour-demosaicing
Description-Content-Type: text/x-rst

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

.. start-badges

|actions| |coveralls| |codacy| |version|

.. |actions| image:: https://img.shields.io/github/workflow/status/colour-science/colour-demosaicing/Continuous%20Integration?label=actions&logo=github&style=flat-square
    :target: https://github.com/colour-science/colour-demosaicing/actions
    :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.org/project/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 <https://opensource.org/licenses/BSD-3-Clause>`__ terms.

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

.. contents:: **Table of Contents**
    :backlinks: none
    :depth: 2

.. sectnum::

Features
--------

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

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

Examples
^^^^^^^^

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

User Guide
----------

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 >= 3.8, < 4 <https://www.python.org/download/releases/>`__
- `colour-science <https://pypi.org/project/colour-science/>`__

Pypi
~~~~

Once the dependencies are 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 --user colour-demosaicing

The overall development dependencies are installed as follows::

    pip install --user 'colour-demosaicing[development]'

Contributing
^^^^^^^^^^^^

If you would like to contribute to `Colour - Demosaicing <https://github.com/colour-science/colour-demosaicing>`__,
please refer to the following `Contributing <https://www.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.

API Reference
-------------

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

Code of Conduct
---------------

The *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,
is available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct/>`__ page.

Contact & Social
----------------

The *Colour Developers* can be reached via different means:

- `Email <mailto:colour-developers@colour-science.org>`__
- `Facebook <https://www.facebook.com/python.colour.science>`__
- `Github Discussions <https://github.com/colour-science/colour-demosaicing/discussions>`__
- `Gitter <https://gitter.im/colour-science/colour>`__
- `Twitter <https://twitter.com/colour_science>`__

About
-----

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

