Skip to main content

Develop Build Status Coverage Status Code Grade Package Version

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

2.1.2 Secondary Dependencies

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:

6 About

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

Release files for colour-checker-detection 0.2.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for colour-checker-detection 0.2.3
File Size Uploaded
colour_checker_detection-0.2.3.tar.gz 58.3 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for colour-checker-detection 0.2.3
File Interpreter ABI Platform
colour_checker_detection-0.2.3-py3-none-any.whl Python 3 none any Details

Total release size: 108.6 MB

Release files / colour_checker_detection-0.2.3.tar.gz

Download URL colour_checker_detection-0.2.3.tar.gz
Size 58.3 MB
Tags Source
SHA-256 checksum
How to use checksums
3bca3ee6c27d0f4ff3817705716fdb7023e08a2da84233de4378253cff7f053e
BLAKE2b-256 checksum
How to use checksums
5b7d1224ab36c7f767a991b0aee4df1e90205e19f14faf2b764c72fc4260eb0b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.0

Release files / colour_checker_detection-0.2.3-py3-none-any.whl

Download URL colour_checker_detection-0.2.3-py3-none-any.whl
Size 50.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
a5427490c33bbf40798b8dd164cc0a2a7080256b6fb1a696fd0f131a83740f05
BLAKE2b-256 checksum
How to use checksums
08439e91eaedaa32bc145999dabfdd3b9a19e2f41f7c54eb3756e859b2c036e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.0

Release history Release notifications | RSS feed

This release

0.2.3 This release

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page