colour-demosaicing

CFA (Colour Filter Array) Demosaicing Algorithms for Python

Showing:

Popularity

Downloads/wk

0

GitHub Stars

146

Maintenance

Last Commit

4mos ago

Contributors

2

Package

Dependencies

22

License

BSD-3-Clause

Categories

Readme

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: 3

.. sectnum::

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/>
  • 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]'

Usage

API ^^^

The main reference for Colour - Demosaicing <https://github.com/colour-science/colour-demosaicing> is the Colour - Demosaicing Manual <https://colour-demosaicing.readthedocs.io/en/latest/manual.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 <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.

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>__
  • Discourse <https://colour-science.discourse.group/>__
  • 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-2021 – 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>

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100