colour-checker-detection 0.2.3

Colour checker detection with Python

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

It is open source and freely available under the BSD-3-Clause terms.

Table of Contents

• 1 Features

  • 1.1 Examples

• 2 User Guide

  • 2.1 Installation

  • 2.2 Contributing

  • 2.3 Bibliography

• 3 API Reference

• 4 Code of Conduct

• 5 Contact & Social

• 6 About

1 Features

The following colour checker detection algorithms are implemented:

• Segmentation

• Templated

• Machine learning inference via Ultralytics YOLOv8

  • The model is published on HuggingFace, and was trained on a purposely constructed dataset.

  • The model has only been trained on ColorChecker Classic 24 images and will not work with ColorChecker Nano or ColorChecker SG images.

  • Inference is performed by a script licensed under the terms of the GNU Affero General Public License v3.0 as it uses the Ultralytics YOLOv8 API which is incompatible with the BSD-3-Clause.

1.1 Examples

Various usage examples are available from the examples directory.

2 User Guide

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

2.1.1 Primary Dependencies

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

• python >= 3.10, < 3.14

• colour-science >= 4.5

• imageio >= 2, < 3

• numpy >= 1.24, < 3

• opencv-python >= 4, < 5

• scipy >= 1.10, < 2

2.1.2 Secondary Dependencies

• click >= 8, < 9

• ultralytics >= 8, < 9

2.1.3 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 overall development dependencies are installed as follows:

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

2.2 Contributing

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

2.3 Bibliography

The bibliography is available in the repository in BibTeX format.

3 API Reference

The main technical reference Colour - Checker Detection is the API Reference.

4 Code of Conduct

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

5 Contact & Social

The Colour Developers can be reached via different means:

• Email

• Facebook

• Github Discussions

• Gitter

• X

• Bluesky

6 About

Colour - Checker Detection by Colour Developers

Copyright 2018 Colour Developers – [e-mail]

This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause

https://github.com/colour-science/colour-checker-detection