From 8452ce19e37d9089b023ce17a4b9bb805d606baa Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Fri, 12 Jan 2024 09:54:03 +1300 Subject: [PATCH 1/2] Update `README.rst` file. --- README.rst | 3 ++- docs/index.rst | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index fe4208a..6f8a069 100644 --- a/README.rst +++ b/README.rst @@ -44,7 +44,8 @@ The following colour checker detection algorithms are implemented: - 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. + - 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 diff --git a/docs/index.rst b/docs/index.rst index f5d4d31..b929fd7 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,7 +21,8 @@ The following colour checker detection algorithms are implemented: - 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. + - 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 From 395335fd6970eee803876a6d52fc6078b5a9933c Mon Sep 17 00:00:00 2001 From: Thomas Mansencal Date: Fri, 12 Jan 2024 14:40:51 +1300 Subject: [PATCH 2/2] Update documentation. --- BIBLIOGRAPHY.bib | 26 +++++++++++++-- docs/colour_checker_detection.detection.rst | 35 +++++++++++++++++++-- 2 files changed, 57 insertions(+), 4 deletions(-) diff --git a/BIBLIOGRAPHY.bib b/BIBLIOGRAPHY.bib index edc5cfe..cb02e00 100644 --- a/BIBLIOGRAPHY.bib +++ b/BIBLIOGRAPHY.bib @@ -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}, } diff --git a/docs/colour_checker_detection.detection.rst b/docs/colour_checker_detection.detection.rst index 40c48ab..22aad69 100644 --- a/docs/colour_checker_detection.detection.rst +++ b/docs/colour_checker_detection.detection.rst @@ -1,5 +1,5 @@ -Colour Checker Detection -======================== +Detection +========= Inference --------- @@ -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