Merge branch 'feature/v0.2.6' into develop

Author: KelSolaar

.github/workflows/continuous-integration-quality-unit-tests.yml

@@ -47,10 +47,10 @@ jobs:
       - name: Install Dependencies (Windows)
         if: matrix.os == 'windows-latest'
         run: |
-          curl -L https://exiftool.org/exiftool-12.98_64.zip -o exiftool-12.98_64.zip
-          unzip -d exiftool exiftool-12.98_64.zip
-          cp exiftool/exiftool-12.98_64/exiftool\(-k\).exe exiftool/exiftool-12.98_64/exiftool.exe
-          echo "$PWD/exiftool/exiftool-12.98_64" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
+          curl -L https://exiftool.org/exiftool-13.32_32.zip -o exiftool-13.32_32.zip
+          unzip -d exiftool exiftool-13.32_32.zip
+          cp exiftool/exiftool-13.32_32/exiftool\(-k\).exe exiftool/exiftool-13.32_32/exiftool.exe
+          echo "$PWD/exiftool/exiftool-13.32_32" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
           curl -L https://cdn.fastpictureviewer.com/bin/dcraw.zip?v=201605100 -o dcraw.zip
           unzip -d dcraw dcraw.zip
           echo "$PWD/dcraw" | sed -e 's/^\///' -e 's/\//\\/g' -e 's/^./\0:/' >> $GITHUB_PATH
@@ -75,13 +75,6 @@ jobs:
           uv sync --all-extras
           uv run python -c "import imageio;imageio.plugins.freeimage.download()"
         shell: bash
-      - name: Install OpenImageIO (macOs)
-        if: matrix.os == 'macOS-latest' && matrix.python-version == '3.13'
-        run: |
-          brew install openimageio
-          ln -s /opt/homebrew/Cellar/openimageio/*/lib/python*/site-packages/OpenImageIO/OpenImageIO*.so ./.venv/lib/python${{ matrix.python-version }}/site-packages/OpenImageIO.so
-          uv run python -c "import OpenImageIO;print(OpenImageIO.__version__)"
-        shell: bash
       - name: Pre-Commit (All Files)
         run: |
           uv run pre-commit run --all-files

.pre-commit-config.yaml

@@ -15,17 +15,17 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         args: ["--ignore-words-list=socio-economic"]
         exclude: "BIBLIOGRAPHY.bib|CONTRIBUTORS.rst|.*.ipynb"
   - repo: https://github.com/PyCQA/isort
-    rev: "5.13.2"
+    rev: "6.0.1"
     hooks:
       - id: isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.8.2"
+    rev: "v0.12.4"
     hooks:
       - id: ruff-format
       - id: ruff

colour_hdri/__init__.py

@@ -2,7 +2,13 @@
 Colour - HDRI
 =============
 
-HDRI processing algorithms for *Python*.
+High Dynamic Range Imaging (HDRI) processing algorithms for *Python*.
+
+This package provides computational tools for HDRI capture, processing, and
+display, including camera response function estimation, exposure merging,
+tone mapping operators, and colour space transformations. The algorithms
+support various workflows from raw image capture to final display-ready
+output with advanced highlight recovery and vignetting correction.
 
 Subpackages
 -----------
@@ -21,8 +27,6 @@
 -   utilities: Various utilities and data structures.
 """
 
-# isort: skip_file
-
 from __future__ import annotations
 
 import contextlib
@@ -31,16 +35,43 @@
 import sys
 import typing
 
-import colour
-import numpy as np
-
 if typing.TYPE_CHECKING:
     from colour.hints import Any
 
+import colour
+import numpy as np
 from colour.utilities import is_matplotlib_installed
 from colour.utilities.deprecation import ModuleAPI, build_API_changes
 from colour.utilities.documentation import is_documentation_building
 
+from .utilities import (
+    EXIF_EXECUTABLE,
+    EXIFTag,
+    Image,
+    ImageStack,
+    Metadata,
+    copy_exif_tags,
+    delete_exif_tags,
+    filter_files,
+    is_lensfunpy_installed,
+    is_opencv_installed,
+    is_rawpy_installed,
+    parse_exif_array,
+    parse_exif_data,
+    parse_exif_fraction,
+    parse_exif_number,
+    parse_exif_string,
+    path_exists,
+    read_exif_tag,
+    read_exif_tags,
+    update_exif_tags,
+    vivification,
+    vivified_to_dict,
+    write_exif_tag,
+)
+
+# isort: split
+
 from .calibration import (
     absolute_luminance_calibration_Lagarde2016,
     camera_response_functions_Debevec1997,
@@ -111,31 +142,9 @@
     tonemapping_operator_simple,
     tonemapping_operator_Tumblin1999,
 )
-from .utilities import (
-    EXIF_EXECUTABLE,
-    EXIFTag,
-    Image,
-    ImageStack,
-    Metadata,
-    copy_exif_tags,
-    delete_exif_tags,
-    filter_files,
-    is_lensfunpy_installed,
-    is_opencv_installed,
-    is_rawpy_installed,
-    parse_exif_array,
-    parse_exif_data,
-    parse_exif_fraction,
-    parse_exif_number,
-    parse_exif_string,
-    path_exists,
-    read_exif_tag,
-    read_exif_tags,
-    update_exif_tags,
-    vivification,
-    vivified_to_dict,
-    write_exif_tag,
-)
+
+# isort: split
+
 from .network import (
     GraphBatchMergeHDRI,
     GraphHDRI,
@@ -177,7 +186,7 @@ class MockPlotting:  # pragma: no cover
         """
 
         def __getattr__(self, attribute: str) -> Any:
-            """Return the value from the attribute with given name."""
+            """Return the value from the attribute with specified name."""
 
             is_matplotlib_installed(raise_exception=True)
 
@@ -192,6 +201,31 @@ def __getattr__(self, attribute: str) -> Any:
 __status__ = "Production"
 
 __all__ = [
+    "EXIF_EXECUTABLE",
+    "EXIFTag",
+    "Image",
+    "ImageStack",
+    "Metadata",
+    "copy_exif_tags",
+    "delete_exif_tags",
+    "filter_files",
+    "is_lensfunpy_installed",
+    "is_opencv_installed",
+    "is_rawpy_installed",
+    "parse_exif_array",
+    "parse_exif_data",
+    "parse_exif_fraction",
+    "parse_exif_number",
+    "parse_exif_string",
+    "path_exists",
+    "read_exif_tag",
+    "read_exif_tags",
+    "update_exif_tags",
+    "vivification",
+    "vivified_to_dict",
+    "write_exif_tag",
+]
+__all__ += [
     "absolute_luminance_calibration_Lagarde2016",
     "camera_response_functions_Debevec1997",
     "g_solve",
@@ -264,31 +298,6 @@ def __getattr__(self, attribute: str) -> Any:
     "tonemapping_operator_simple",
     "tonemapping_operator_Tumblin1999",
 ]
-__all__ += [
-    "EXIF_EXECUTABLE",
-    "EXIFTag",
-    "Image",
-    "ImageStack",
-    "Metadata",
-    "copy_exif_tags",
-    "delete_exif_tags",
-    "filter_files",
-    "is_rawpy_installed",
-    "is_lensfunpy_installed",
-    "is_opencv_installed",
-    "parse_exif_array",
-    "parse_exif_data",
-    "parse_exif_fraction",
-    "parse_exif_number",
-    "parse_exif_string",
-    "path_exists",
-    "read_exif_tag",
-    "read_exif_tags",
-    "update_exif_tags",
-    "vivification",
-    "vivified_to_dict",
-    "write_exif_tag",
-]
 __all__ += [
     "GraphBatchMergeHDRI",
     "GraphHDRI",
@@ -308,8 +317,8 @@ def __getattr__(self, attribute: str) -> Any:
     "NodeDownsample",
     "NodeMergeImageStack",
     "NodeNormaliseExposure",
-    "NodeProcessRawFileRawpy",
     "NodeProcessingMetadata",
+    "NodeProcessRawFileRawpy",
     "NodeReadFileMetadataDNG",
     "NodeReadImage",
     "NodeRemoveFile",
@@ -335,7 +344,7 @@ def __getattr__(self, attribute: str) -> Any:
 
 try:
     _version: str = (
-        subprocess.check_output(  # noqa: S603
+        subprocess.check_output(
             ["git", "describe"],  # noqa: S607
             cwd=os.path.dirname(__file__),
             stderr=subprocess.STDOUT,
@@ -383,7 +392,7 @@ class colour_hdri(ModuleAPI):
     """Define a class acting like the *colour_hdri* module."""
 
     def __getattr__(self, attribute: str) -> Any:
-        """Return the value from the attribute with given name."""
+        """Return the value from the attribute with specified name."""
 
         return super().__getattr__(attribute)
 

colour_hdri/calibration/__init__.py

@@ -1,16 +1,28 @@
-# isort: skip_file
+"""
+Camera Calibration
+==================
+
+Camera response function estimation and absolute luminance calibration.
+
+This subpackage provides algorithms for determining camera response functions
+from image sequences with known exposure values, and methods for absolute
+luminance calibration using reference illumination measurements.
+"""
 
 from .absolute_luminance import (
-    upper_hemisphere_illuminance_weights_Lagarde2016,
     absolute_luminance_calibration_Lagarde2016,
+    upper_hemisphere_illuminance_weights_Lagarde2016,
 )
-from .debevec1997 import g_solve, camera_response_functions_Debevec1997
+
+# isort: split
+
+from .debevec1997 import camera_response_functions_Debevec1997, g_solve
 
 __all__ = [
-    "upper_hemisphere_illuminance_weights_Lagarde2016",
     "absolute_luminance_calibration_Lagarde2016",
+    "upper_hemisphere_illuminance_weights_Lagarde2016",
 ]
 __all__ += [
-    "g_solve",
     "camera_response_functions_Debevec1997",
+    "g_solve",
 ]

colour_hdri/calibration/debevec1997.py

@@ -143,7 +143,7 @@ def extrapolating_function_polynomial(
 ) -> NDArrayFloat:
     """
     Polynomial extrapolating function used to handle zero-weighted data of
-    given camera response functions.
+    specified camera response functions.
 
     The extrapolation occurs where the weighting function masks fully the
     camera response functions, e.g., at both ends for *Debevec (1997)*.
@@ -194,7 +194,7 @@ def camera_response_functions_Debevec1997(
     normalise: bool = True,
 ) -> NDArrayFloat:
     """
-    Return the camera response functions for given image stack using
+    Return the camera response functions for specified image stack using
     *Debevec (1997)* method.
 
     Image channels are sampled with :math:`s` sampling function and the output

colour_hdri/distortion/__init__.py

@@ -1,35 +1,44 @@
-# isort: skip_file
+"""
+Lens Distortion Correction
+==========================
+
+Vignetting characterisation and correction algorithms.
+
+This subpackage provides methods for characterising and correcting lens
+vignetting effects using various mathematical models including 2D functions,
+bivariate splines, and radial basis functions.
+"""
 
 from .vignette import (
-    apply_radial_gradient,
-    parabolic_2D_function,
-    hyperbolic_cosine_2D_function,
+    VIGNETTE_CHARACTERISATION_METHODS,
+    VIGNETTE_CORRECTION_METHODS,
     DataVignetteCharacterisation,
+    apply_radial_gradient,
+    characterise_vignette,
     characterise_vignette_2D_function,
-    correct_vignette_2D_function,
     characterise_vignette_bivariate_spline,
-    correct_vignette_bivariate_spline,
     characterise_vignette_RBF,
-    correct_vignette_RBF,
-    VIGNETTE_CHARACTERISATION_METHODS,
-    characterise_vignette,
-    VIGNETTE_CORRECTION_METHODS,
     correct_vignette,
+    correct_vignette_2D_function,
+    correct_vignette_bivariate_spline,
+    correct_vignette_RBF,
+    hyperbolic_cosine_2D_function,
+    parabolic_2D_function,
 )
 
 __all__ = [
-    "apply_radial_gradient",
-    "parabolic_2D_function",
-    "hyperbolic_cosine_2D_function",
+    "VIGNETTE_CHARACTERISATION_METHODS",
+    "VIGNETTE_CORRECTION_METHODS",
     "DataVignetteCharacterisation",
+    "apply_radial_gradient",
+    "characterise_vignette",
     "characterise_vignette_2D_function",
-    "correct_vignette_2D_function",
     "characterise_vignette_bivariate_spline",
-    "correct_vignette_bivariate_spline",
     "characterise_vignette_RBF",
-    "correct_vignette_RBF",
-    "VIGNETTE_CHARACTERISATION_METHODS",
-    "characterise_vignette",
-    "VIGNETTE_CORRECTION_METHODS",
     "correct_vignette",
+    "correct_vignette_2D_function",
+    "correct_vignette_bivariate_spline",
+    "correct_vignette_RBF",
+    "hyperbolic_cosine_2D_function",
+    "parabolic_2D_function",
 ]