Skip to content

Commit

Permalink
Merge branch 'feature/v0.2.1' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
KelSolaar committed Jan 12, 2024
2 parents 6b4ec09 + 395335f commit f00218c
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 6 deletions.
26 changes: 24 additions & 2 deletions BIBLIOGRAPHY.bib
Original file line number Diff line number Diff line change
@@ -1,7 +1,29 @@
@misc{Abecassis2011,
title = {OpenCV - Rotation (Deskewing)},
title = {{{OpenCV}} - {{Rotation}} ({{Deskewing}})},
author = {Abecassis, Felix},
year = 2011,
url = {http://felix.abecassis.me/2011/10/opencv-rotation-deskewing/},
urldate = {2018-10-27},
howpublished = {http://felix.abecassis.me/2011/10/opencv-rotation-deskewing/},
}
@misc{Dallas2024,
title = {[{{BUG}}]: {{Flipped}} Colour Chart},
author = {Dallas, Jacob},
year = 2024,
month = jan,
}
@misc{Olferuk2019,
title = {How to Force {{approxPolyDP}}() to Return Only the
Best 4 Corners? - {{Opencv}} 2.4.2},
author = {Olferuk, Alexander},
year = 2019,
month = mar,
howpublished = {https://stackoverflow.com/a/55339684/931625},
}
@misc{Walter2022,
title = {[{{ENHANCEMENT}}] {{Proposal}} to Allow Detection
from Different Perspectives},
author = {Walter, Tim},
year = 2022,
urldate = {2024-01-08},
howpublished = {https://github.com/colour-science/colour-checker-detection/issues/60},
}
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ The following colour checker detection algorithms are implemented:

- The model is published on `HuggingFace <https://huggingface.co/colour-science/colour-checker-detection-models>`__,
and was trained on a purposely constructed `dataset <https://huggingface.co/datasets/colour-science/colour-checker-detection-dataset>`__.
- The model has only been trained on *ColorChecker Classic 24* images and will not work with *ColorChecker Nano* or *ColorChecker SG* images.
- 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
Expand Down
35 changes: 33 additions & 2 deletions docs/colour_checker_detection.detection.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Colour Checker Detection
========================
Detection
=========

Inference
---------
Expand Down Expand Up @@ -31,3 +31,34 @@ Segmentation
SETTINGS_SEGMENTATION_COLORCHECKER_NANO
segmenter_default
detect_colour_checkers_segmentation

Common Utilities
----------------

``colour_checker_detection.detection``

.. currentmodule:: colour_checker_detection.detection

.. autosummary::
:toctree: generated/

DTYPE_INT_DEFAULT
DTYPE_FLOAT_DEFAULT
SETTINGS_DETECTION_COLORCHECKER_CLASSIC
SETTINGS_DETECTION_COLORCHECKER_SG
SETTINGS_CONTOUR_DETECTION_DEFAULT
as_int32_array
as_float32_array
swatch_masks
swatch_colours
reformat_image
transform_image
detect_contours
is_square
contour_centroid
scale_contour
approximate_contour
quadrilateralise_contours
remove_stacked_contours
DataDetectionColourChecker
sample_colour_checker
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ The following colour checker detection algorithms are implemented:

- The model is published on `HuggingFace <https://huggingface.co/colour-science/colour-checker-detection-models>`__,
and was trained on a purposely constructed `dataset <https://huggingface.co/datasets/colour-science/colour-checker-detection-dataset>`__.
- The model has only been trained on *ColorChecker Classic 24* images and will not work with *ColorChecker Nano* or *ColorChecker SG* images.
- 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
Expand Down

0 comments on commit f00218c

Please sign in to comment.