1 Colour - Checker Detection

A Python package implementing various colour checker detection algorithms and related utilities.

It is open source and freely available under the New BSD License terms.


1.1 Features

The following colour checker detection algorithms are implemented:

  • Segmentation

1.2 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.

1.2.1 Primary Dependencies

Colour - Checker Detection requires various dependencies in order to run:

1.2.2 Pypi

Once the dependencies are satisfied, Colour - Checker Detection can be installed from the Python Package Index by issuing this command in a shell:

pip install --user colour-checker-detection

The tests suite dependencies are installed as follows:

pip install --user 'colour-checker-detection[tests]'

The documentation building dependencies are installed as follows:

pip install --user 'colour-checker-detection[docs]'

The overall development dependencies are installed as follows:

pip install --user 'colour-checker-detection[development]'

1.3 Usage

1.3.1 API

The main reference for Colour - Checker Detection is the manual:

1.3.2 Examples

Various usage examples are available from the examples directory.

1.4 Contributing

If you would like to contribute to Colour - Checker Detection, please refer to the following Contributing guide for Colour.

1.5 Bibliography

The bibliography is available in the repository in BibTeX format.

1.6 Code of Conduct

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

1.7 Contact & Social

The Colour Developers can be reached via different means:

1.8 About

Colour - Checker Detection by Colour Developers
Copyright © 2018-2021 – Colour Developers – colour-developers@colour-science.org
This software is released under terms of New BSD License: https://opensource.org/licenses/BSD-3-Clause