Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/colour-science/colour-demosaicing

CFA (Colour Filter Array) demosaicing algorithms for Python
https://github.com/colour-science/colour-demosaicing

bayer cfa 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

Last synced: 5 days ago
JSON representation

CFA (Colour Filter Array) demosaicing algorithms for Python

Awesome Lists containing this project

README

        

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

.. start-badges

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

.. |actions| image:: https://img.shields.io/github/actions/workflow/status/colour-science/colour-demosaicing/.github/workflows/continuous-integration-quality-unit-tests.yml?branch=develop&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/2862b4f2217742ae83c972d7e3af44d7/develop.svg?style=flat-square
:target: https://app.codacy.com/gh/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 `__ package implementing various
CFA (Colour Filter Array) demosaicing algorithms and related utilities.

It is open source and freely available under the
`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 `__.

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 `__
when cloning the
`repository `__.

Primary Dependencies
~~~~~~~~~~~~~~~~~~~~

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

- `python >= 3.10, < 3.14 `__
- `colour-science >= 4.5 `__
- `imageio >= 2, < 3 `__
- `numpy >= 1.24, < 3 `__
- `scipy >= 1.10, < 2 `__

Pypi
~~~~

Once the dependencies are satisfied, **Colour - Demosaicing** can be installed from
the `Python Package Index `__ 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 `__,
please refer to the following `Contributing `__
guide for `Colour `__.

Bibliography
^^^^^^^^^^^^

The bibliography is available in the repository in
`BibTeX `__
format.

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

The main technical reference for `Colour - Demosaicing `__
is the `API Reference `__.

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

The *Code of Conduct*, adapted from the `Contributor Covenant 1.4 `__,
is available on the `Code of Conduct `__ page.

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

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

- `Email `__
- `Facebook `__
- `Github Discussions `__
- `Gitter `__
- `Twitter `__

About
-----

| **Colour - Demosaicing** by Colour Developers
| Copyright 2015 Colour Developers – `[email protected] `__
| This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause
| `https://github.com/colour-science/colour-demosaicing `__