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-checker-detection

Colour checker detection with Python
https://github.com/colour-science/colour-checker-detection

color color-checker color-science color-space color-spaces colorspace colorspaces colour colour-checker colour-science colour-space colour-spaces colourspace colourspaces python segmentation

Last synced: 4 days ago
JSON representation

Colour checker detection with Python

Awesome Lists containing this project

README 

        
Colour - Checker Detection

==========================



.. start-badges



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



.. |actions| image:: https://img.shields.io/github/actions/workflow/status/colour-science/colour-checker-detection/.github/workflows/continuous-integration-quality-unit-tests.yml?branch=develop&style=flat-square

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

    :alt: Develop Build Status

.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-checker-detection/develop.svg?style=flat-square

    :target: https://coveralls.io/r/colour-science/colour-checker-detection

    :alt: Coverage Status

.. |codacy| image:: https://img.shields.io/codacy/grade/c543bc30229347cdaea00aadd3f79499/develop.svg?style=flat-square

    :target: https://app.codacy.com/gh/colour-science/colour-checker-detection

    :alt: Code Grade

.. |version| image:: https://img.shields.io/pypi/v/colour-checker-detection.svg?style=flat-square

    :target: https://pypi.org/project/colour-checker-detection

    :alt: Package Version



.. end-badges



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.



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



.. contents:: **Table of Contents**

    :backlinks: none

    :depth: 2



.. sectnum::



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



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 - 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 `__



Secondary Dependencies

~~~~~~~~~~~~~~~~~~~~~~



- `click >= 8, < 9 `__

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



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



Contributing

^^^^^^^^^^^^



If you would like to contribute to `Colour - Checker Detection `__,

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 `Colour - Checker Detection `__

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 - Checker Detection** by Colour Developers

| Copyright 2018 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-checker-detection `__