Merge branch 'feature/cie2024_varnish' into develop

Author: KelSolaar

BIBLIOGRAPHY.bib

@@ -1802,6 +1802,14 @@ Colour Rendering Index
 
     64.233724121664793
 
+.. code-block:: python
+
+    sorted(colour.COLOUR_RENDERING_INDEX_METHODS)
+
+.. code-block:: text
+
+    ['CIE 1995', 'CIE 2024']
+
 Academy Spectral Similarity Index (SSI)
 ***************************************
 

README.rst

@@ -443,6 +443,7 @@
 from .quality import (
     COLOUR_FIDELITY_INDEX_METHODS,
     COLOUR_QUALITY_SCALE_METHODS,
+    COLOUR_RENDERING_INDEX_METHODS,
     colour_fidelity_index,
     colour_quality_scale,
     colour_rendering_index,
@@ -838,6 +839,7 @@
 __all__ += [
     "COLOUR_FIDELITY_INDEX_METHODS",
     "COLOUR_QUALITY_SCALE_METHODS",
+    "COLOUR_RENDERING_INDEX_METHODS",
     "colour_fidelity_index",
     "colour_quality_scale",
     "colour_rendering_index",

colour/__init__.py

@@ -240,13 +240,15 @@ def test_spectral_uniformity(self) -> None:
         from colour.quality.datasets import SDS_TCS
 
         np.testing.assert_allclose(
-            spectral_uniformity(SDS_TCS.values()),
+            spectral_uniformity(SDS_TCS["CIE 1995"].values()),
             DATA_UNIFORMITY_FIRST_ORDER_DERIVATIVES,
             atol=TOLERANCE_ABSOLUTE_TESTS,
         )
 
         np.testing.assert_allclose(
-            spectral_uniformity(SDS_TCS.values(), use_second_order_derivatives=True),
+            spectral_uniformity(
+                SDS_TCS["CIE 1995"].values(), use_second_order_derivatives=True
+            ),
             DATA_UNIFORMITY_SECOND_ORDER_DERIVATIVES,
             atol=TOLERANCE_ABSOLUTE_TESTS,
         )

colour/colorimetry/tests/test_uniformity.py

@@ -90,7 +90,7 @@ def spectral_uniformity(
     Examples
     --------
     >>> from colour.quality.datasets import SDS_TCS
-    >>> spectral_uniformity(SDS_TCS.values())  # doctest: +ELLIPSIS
+    >>> spectral_uniformity(SDS_TCS["CIE 1995"].values())  # doctest: +ELLIPSIS
     array([  9.5514285...e-06,   1.1482142...e-05,   1.8784285...e-05,
              2.8711428...e-05,   3.1971428...e-05,   3.2342857...e-05,
              3.3850000...e-05,   3.9925714...e-05,   4.1333571...e-05,

colour/colorimetry/uniformity.py

@@ -14,7 +14,11 @@
     ColourRendering_Specification_CIE2017,
     colour_fidelity_index_CIE2017,
 )
-from .cri import ColourRendering_Specification_CRI, colour_rendering_index
+from .cri import (
+    COLOUR_RENDERING_INDEX_METHODS,
+    ColourRendering_Specification_CRI,
+    colour_rendering_index,
+)
 from .cqs import (
     COLOUR_QUALITY_SCALE_METHODS,
     ColourRendering_Specification_CQS,
@@ -38,6 +42,7 @@
     "colour_fidelity_index_ANSIIESTM3018",
 ]
 __all__ += [
+    "COLOUR_RENDERING_INDEX_METHODS",
     "ColourRendering_Specification_CRI",
     "colour_rendering_index",
 ]

colour/quality/__init__.py

@@ -42,7 +42,8 @@
 from colour.models import UCS_to_uv, XYZ_to_UCS, XYZ_to_xyY
 from colour.quality.datasets.tcs import INDEXES_TO_NAMES_TCS, SDS_TCS
 from colour.temperature import CCT_to_xy_CIE_D, uv_to_CCT_Robertson1968
-from colour.utilities import domain_range_scale
+from colour.utilities import domain_range_scale, validate_method
+from colour.utilities.documentation import DocstringTuple, is_documentation_building
 
 __author__ = "Colour Developers"
 __copyright__ = "Copyright 2013 Colour Developers"
@@ -55,6 +56,7 @@
     "DataColorimetry_TCS",
     "DataColourQualityScale_TCS",
     "ColourRendering_Specification_CRI",
+    "COLOUR_RENDERING_INDEX_METHODS",
     "colour_rendering_index",
     "tcs_colorimetry_data",
     "colour_rendering_indexes",
@@ -110,26 +112,47 @@ class ColourRendering_Specification_CRI:
     ]
 
 
+COLOUR_RENDERING_INDEX_METHODS: tuple = ("CIE 1995", "CIE 2024")
+if is_documentation_building():  # pragma: no cover
+    COLOUR_RENDERING_INDEX_METHODS = DocstringTuple(COLOUR_RENDERING_INDEX_METHODS)
+    COLOUR_RENDERING_INDEX_METHODS.__doc__ = """
+Supported *Colour Rendering Index* (CRI) computation methods.
+
+References
+----------
+:cite:`Ohno2008a`
+"""
+
+
 @typing.overload
 def colour_rendering_index(
-    sd_test: SpectralDistribution, additional_data: Literal[True] = True
+    sd_test: SpectralDistribution,
+    additional_data: Literal[True] = True,
+    method: Literal["CIE 1995", "CIE 2024"] | str = ...,
 ) -> ColourRendering_Specification_CRI: ...
 
 
 @typing.overload
 def colour_rendering_index(
-    sd_test: SpectralDistribution, *, additional_data: Literal[False]
+    sd_test: SpectralDistribution,
+    *,
+    additional_data: Literal[False],
+    method: Literal["CIE 1995", "CIE 2024"] | str = ...,
 ) -> float: ...
 
 
 @typing.overload
 def colour_rendering_index(
-    sd_test: SpectralDistribution, additional_data: Literal[False]
+    sd_test: SpectralDistribution,
+    additional_data: Literal[False],
+    method: Literal["CIE 1995", "CIE 2024"] | str = ...,
 ) -> float: ...
 
 
 def colour_rendering_index(
-    sd_test: SpectralDistribution, additional_data: bool = False
+    sd_test: SpectralDistribution,
+    additional_data: bool = False,
+    method: Literal["CIE 1995", "CIE 2024"] | str = "CIE 1995",
 ) -> float | ColourRendering_Specification_CRI:
     """
     Return the *Colour Rendering Index* (CRI) :math:`Q_a` of given spectral
@@ -141,6 +164,8 @@ def colour_rendering_index(
         Test spectral distribution.
     additional_data
         Whether to output additional data.
+    method
+        Computation method.
 
     Returns
     -------
@@ -160,6 +185,8 @@ def colour_rendering_index(
     64.2337241...
     """
 
+    method = validate_method(method, tuple(COLOUR_RENDERING_INDEX_METHODS))
+
     cmfs = reshape_msds(
         MSDS_CMFS["CIE 1931 2 Degree Standard Observer"],
         SPECTRAL_SHAPE_DEFAULT,
@@ -168,7 +195,8 @@ def colour_rendering_index(
 
     shape = cmfs.shape
     sd_test = reshape_sd(sd_test, shape, copy=False)
-    tcs_sds = {sd.name: reshape_sd(sd, shape, copy=False) for sd in SDS_TCS.values()}
+    sds_tcs = SDS_TCS[method]
+    tcs_sds = {sd.name: reshape_sd(sd, shape, copy=False) for sd in sds_tcs.values()}
 
     with domain_range_scale("1"):
         XYZ = sd_to_XYZ(sd_test, cmfs)
@@ -184,11 +212,11 @@ def colour_rendering_index(
         sd_reference.align(shape)
 
     test_tcs_colorimetry_data = tcs_colorimetry_data(
-        sd_test, sd_reference, tcs_sds, cmfs, chromatic_adaptation=True
+        sd_test, sd_reference, tcs_sds, cmfs, chromatic_adaptation=True, method=method
     )
 
     reference_tcs_colorimetry_data = tcs_colorimetry_data(
-        sd_reference, sd_reference, tcs_sds, cmfs
+        sd_reference, sd_reference, tcs_sds, cmfs, method=method
     )
 
     Q_as = colour_rendering_indexes(
@@ -217,6 +245,7 @@ def tcs_colorimetry_data(
     sds_tcs: Dict[str, SpectralDistribution],
     cmfs: MultiSpectralDistributions,
     chromatic_adaptation: bool = False,
+    method: Literal["CIE 1995", "CIE 2024"] | str = "CIE 1995",
 ) -> Tuple[DataColorimetry_TCS, ...]:
     """
     Return the *test colour samples* colorimetry data.
@@ -240,6 +269,8 @@ def tcs_colorimetry_data(
         *Test colour samples* colorimetry data.
     """
 
+    method = validate_method(method, tuple(COLOUR_RENDERING_INDEX_METHODS))
+
     XYZ_t = sd_to_XYZ(sd_t, cmfs)
     uv_t = UCS_to_uv(XYZ_to_UCS(XYZ_t))
     u_t, v_t = uv_t[0], uv_t[1]
@@ -249,7 +280,10 @@ def tcs_colorimetry_data(
     u_r, v_r = uv_r[0], uv_r[1]
 
     tcs_data = []
-    for _key, value in sorted(INDEXES_TO_NAMES_TCS.items()):
+    for _key, value in sorted(INDEXES_TO_NAMES_TCS[method].items()):
+        if value not in sds_tcs:
+            continue
+
         sd_tcs = sds_tcs[value]
         XYZ_tcs = sd_to_XYZ(sd_tcs, cmfs, sd_t)
         xyY_tcs = XYZ_to_xyY(XYZ_tcs)

colour/quality/cri.py

@@ -2,6 +2,7 @@
 from .vs import SDS_VS
 
 __all__ = [
+    "SDS_TCS",
     "SDS_TCS",
     "SDS_VS",
 ]