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 BSD-3-Clause terms.

https://raw.githubusercontent.com/colour-science/colour-checker-detection/master/docs/_static/ColourCheckerDetection_001.png

1.1 Features#

The following colour checker detection algorithms are implemented:

Segmentation
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.1 Examples#

Various usage examples are available from the examples directory.

1.2 User Guide#

User Guide#

The user guide provides an overview of Colour - Checker Detection and explains important concepts and features, details can be found in the API Reference.

Installation Guide#

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 - Checker Detection requires various dependencies in order to run:

Secondary Dependencies#

ultralytics >= 8, < 9

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

Bibliography#

[Abe11]

Felix Abecassis. Opencv - rotation (deskewing). 2011. URL: http://felix.abecassis.me/2011/10/opencv-rotation-deskewing/ (visited on 2018-10-27).

1.3 API Reference#

API Reference#

Colour - Checker Detection#

Colour Checker Detection#

Inference#

colour_checker_detection

`SETTINGS_INFERENCE_COLORCHECKER_CLASSIC`	Settings for the inference of the X-Rite ColorChecker Classic.
`SETTINGS_INFERENCE_COLORCHECKER_CLASSIC_MINI`	Settings for the inference of the X-Rite ColorChecker Classic Mini.
`inferencer_default`(image[, cctf_encoding, ...])	Predict the colour checker rectangles in given image using Ultralytics YOLOv8.
`detect_colour_checkers_inference`(image[, ...])	Detect the colour checkers swatches in given image using inference.

Segmentation#