Rename "colour.utilities.CaseInsensitiveMapping" class to "colour.uti…

…lities.CanonicalMapping" and "colour.utilities.LazyCaseInsensitiveMapping" class to "colour.utilities.LazyCanonicalMapping".
colour-science · Jun 11, 2022 · 727d9f3 · 727d9f3
1 parent 802477e
commit 727d9f3
Show file tree

Hide file tree

Showing 80 changed files with 1,035 additions and 1,075 deletions.
diff --git a/colour/__init__.py b/colour/__init__.py
@@ -939,5 +939,5 @@ def __getattr__(self, attribute) -> Any:
 __disable_lazy_load__ = colour.__disable_lazy_load__  # type: ignore[attr-defined]
 """
 Ensures that the lazy loaded datasets are not transformed during import.
-See :class:`colour.utilities.LazyCaseInsensitiveMapping` for more information.
+See :class:`colour.utilities.LazyCanonicalMapping` for more information.
 """
diff --git a/colour/adaptation/__init__.py b/colour/adaptation/__init__.py
@@ -28,7 +28,7 @@
 
 from colour.hints import Any, ArrayLike, Literal, NDArray, Union
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     filter_kwargs,
     get_domain_range_scale,
     as_float_array,
@@ -101,7 +101,7 @@
     "chromatic_adaptation_Zhai2018",
 ]
 
-CHROMATIC_ADAPTATION_METHODS: CaseInsensitiveMapping = CaseInsensitiveMapping(
+CHROMATIC_ADAPTATION_METHODS: CanonicalMapping = CanonicalMapping(
     {
         "CIE 1994": chromatic_adaptation_CIE1994,
         "CMCCAT2000": chromatic_adaptation_CMCCAT2000,

diff --git a/colour/adaptation/cmccat2000.py b/colour/adaptation/cmccat2000.py
@@ -36,7 +36,7 @@
     Union,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     as_float_array,
     from_range_100,
     to_domain_100,
@@ -84,7 +84,7 @@ class InductionFactors_CMCCAT2000(NamedTuple):
     F: Floating
 
 
-VIEWING_CONDITIONS_CMCCAT2000: CaseInsensitiveMapping = CaseInsensitiveMapping(
+VIEWING_CONDITIONS_CMCCAT2000: CanonicalMapping = CanonicalMapping(
     {
         "Average": InductionFactors_CMCCAT2000(1),
         "Dim": InductionFactors_CMCCAT2000(0.8),

diff --git a/colour/adaptation/datasets/cat.py b/colour/adaptation/datasets/cat.py
@@ -76,7 +76,7 @@
 import numpy as np
 
 from colour.hints import NDArray
-from colour.utilities import CaseInsensitiveMapping
+from colour.utilities import CanonicalMapping
 
 __author__ = "Colour Developers"
 __copyright__ = "Copyright 2013 Colour Developers"
@@ -281,23 +281,21 @@
 -   This chromatic adaptation transform has no negative lobes.
 """
 
-CHROMATIC_ADAPTATION_TRANSFORMS: CaseInsensitiveMapping = (
-    CaseInsensitiveMapping(
-        {
-            "XYZ Scaling": CAT_XYZ_SCALING,
-            "Von Kries": CAT_VON_KRIES,
-            "Bradford": CAT_BRADFORD,
-            "Sharp": CAT_SHARP,
-            "Fairchild": CAT_FAIRCHILD,
-            "CMCCAT97": CAT_CMCCAT97,
-            "CMCCAT2000": CAT_CMCCAT2000,
-            "CAT02": CAT_CAT02,
-            "CAT02 Brill 2008": CAT_CAT02_BRILL2008,
-            "CAT16": CAT_CAT16,
-            "Bianco 2010": CAT_BIANCO2010,
-            "Bianco PC 2010": CAT_PC_BIANCO2010,
-        }
-    )
+CHROMATIC_ADAPTATION_TRANSFORMS: CanonicalMapping = CanonicalMapping(
+    {
+        "XYZ Scaling": CAT_XYZ_SCALING,
+        "Von Kries": CAT_VON_KRIES,
+        "Bradford": CAT_BRADFORD,
+        "Sharp": CAT_SHARP,
+        "Fairchild": CAT_FAIRCHILD,
+        "CMCCAT97": CAT_CMCCAT97,
+        "CMCCAT2000": CAT_CMCCAT2000,
+        "CAT02": CAT_CAT02,
+        "CAT02 Brill 2008": CAT_CAT02_BRILL2008,
+        "CAT16": CAT_CAT16,
+        "Bianco 2010": CAT_BIANCO2010,
+        "Bianco PC 2010": CAT_PC_BIANCO2010,
+    }
 )
 CHROMATIC_ADAPTATION_TRANSFORMS.__doc__ = """
 Chromatic adaptation transforms.

diff --git a/colour/algebra/geometry.py b/colour/algebra/geometry.py
@@ -53,7 +53,7 @@
     cast,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     as_float,
     as_float_array,
     ones,
@@ -603,7 +603,7 @@ def ellipse_fitting_Halir1998(a: ArrayLike) -> NDArray:
     return A
 
 
-ELLIPSE_FITTING_METHODS: CaseInsensitiveMapping = CaseInsensitiveMapping(
+ELLIPSE_FITTING_METHODS: CanonicalMapping = CanonicalMapping(
     {"Halir 1998": ellipse_fitting_Halir1998}
 )
 ELLIPSE_FITTING_METHODS.__doc__ = """

diff --git a/colour/algebra/interpolation.py b/colour/algebra/interpolation.py
@@ -86,7 +86,7 @@
     cast,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     as_array,
     as_float_array,
     as_float,
@@ -1948,7 +1948,7 @@ def table_interpolation_tetrahedral(
     return xyz_o
 
 
-TABLE_INTERPOLATION_METHODS = CaseInsensitiveMapping(
+TABLE_INTERPOLATION_METHODS = CanonicalMapping(
     {
         "Trilinear": table_interpolation_trilinear,
         "Tetrahedral": table_interpolation_tetrahedral,

diff --git a/colour/appearance/cam16.py b/colour/appearance/cam16.py
@@ -59,7 +59,7 @@
     Union,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     MixinDataclassArithmetic,
     as_float,
     as_float_array,
@@ -122,7 +122,7 @@ class InductionFactors_CAM16(
     """
 
 
-VIEWING_CONDITIONS_CAM16: CaseInsensitiveMapping = CaseInsensitiveMapping(
+VIEWING_CONDITIONS_CAM16: CanonicalMapping = CanonicalMapping(
     VIEWING_CONDITIONS_CIECAM02
 )
 VIEWING_CONDITIONS_CAM16.__doc__ = """

diff --git a/colour/appearance/ciecam02.py b/colour/appearance/ciecam02.py
@@ -58,7 +58,7 @@
 )
 from colour.models import xy_to_XYZ
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     MixinDataclassArithmetic,
     as_float,
     as_float_array,
@@ -148,7 +148,7 @@ class InductionFactors_CIECAM02(
     """
 
 
-VIEWING_CONDITIONS_CIECAM02: CaseInsensitiveMapping = CaseInsensitiveMapping(
+VIEWING_CONDITIONS_CIECAM02: CanonicalMapping = CanonicalMapping(
     {
         "Average": InductionFactors_CIECAM02(1, 0.69, 1),
         "Dim": InductionFactors_CIECAM02(0.9, 0.59, 0.9),

diff --git a/colour/appearance/hellwig2022.py b/colour/appearance/hellwig2022.py
@@ -53,7 +53,7 @@
     Union,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     MixinDataclassArithmetic,
     as_float,
     as_float_array,
@@ -109,8 +109,8 @@ class InductionFactors_Hellwig2022(
     """
 
 
-VIEWING_CONDITIONS_HELLWIG2022: CaseInsensitiveMapping = (
-    CaseInsensitiveMapping(VIEWING_CONDITIONS_CIECAM02)
+VIEWING_CONDITIONS_HELLWIG2022: CanonicalMapping = CanonicalMapping(
+    VIEWING_CONDITIONS_CIECAM02
 )
 VIEWING_CONDITIONS_HELLWIG2022.__doc__ = """
 Reference *Hellwig and Fairchild (2022)* colour appearance model viewing

diff --git a/colour/appearance/hke.py b/colour/appearance/hke.py
@@ -36,7 +36,7 @@
     Union,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     as_float_array,
     tsplit,
     validate_method,
@@ -57,7 +57,7 @@
     "coefficient_K_Br_Nayatani1997",
 ]
 
-HKE_NAYATANI1997_METHODS = CaseInsensitiveMapping(
+HKE_NAYATANI1997_METHODS = CanonicalMapping(
     {
         "VAC": -0.1340,
         "VCC": -0.8660,

diff --git a/colour/appearance/hunt.py b/colour/appearance/hunt.py
@@ -35,7 +35,7 @@
     cast,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     MixinDataclassArithmetic,
     as_float,
     as_float_array,
@@ -122,7 +122,7 @@ def __new__(cls, N_c, N_b, N_cb=None, N_bb=None):
         return super().__new__(cls, N_c, N_b, N_cb, N_bb)
 
 
-VIEWING_CONDITIONS_HUNT: CaseInsensitiveMapping = CaseInsensitiveMapping(
+VIEWING_CONDITIONS_HUNT: CanonicalMapping = CanonicalMapping(
     {
         "Small Areas, Uniform Background & Surrounds": InductionFactors_Hunt(
             1, 300

diff --git a/colour/appearance/kim2009.py b/colour/appearance/kim2009.py
@@ -47,7 +47,7 @@
     Optional,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     MixinDataclassArithmetic,
     as_float,
     as_float_array,
@@ -110,7 +110,7 @@ class InductionFactors_Kim2009(
     """
 
 
-VIEWING_CONDITIONS_KIM2009: CaseInsensitiveMapping = CaseInsensitiveMapping(
+VIEWING_CONDITIONS_KIM2009: CanonicalMapping = CanonicalMapping(
     VIEWING_CONDITIONS_CIECAM02
 )
 VIEWING_CONDITIONS_KIM2009.__doc__ = """
@@ -146,7 +146,7 @@ def __new__(cls, E):
         return super().__new__(cls, E)
 
 
-MEDIA_PARAMETERS_KIM2009: CaseInsensitiveMapping = CaseInsensitiveMapping(
+MEDIA_PARAMETERS_KIM2009: CanonicalMapping = CanonicalMapping(
     {
         "High-luminance LCD Display": MediaParameters_Kim2009(1),
         "Transparent Advertising Media": MediaParameters_Kim2009(1.2175),

diff --git a/colour/appearance/llab.py b/colour/appearance/llab.py
@@ -44,7 +44,7 @@
     Optional,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     MixinDataclassArithmetic,
     as_float,
     as_float_array,
@@ -104,7 +104,7 @@ class InductionFactors_LLAB(
     """
 
 
-VIEWING_CONDITIONS_LLAB: CaseInsensitiveMapping = CaseInsensitiveMapping(
+VIEWING_CONDITIONS_LLAB: CanonicalMapping = CanonicalMapping(
     {
         "Reference Samples & Images, Average Surround, Subtending > 4": (
             InductionFactors_LLAB(1, 3, 0, 1)

diff --git a/colour/appearance/rlab.py b/colour/appearance/rlab.py
@@ -33,7 +33,7 @@
     Optional,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     MixinDataclassArray,
     as_float,
     as_float_array,
@@ -68,7 +68,7 @@
 )
 """*RLAB* colour appearance model precomputed helper matrix."""
 
-VIEWING_CONDITIONS_RLAB: CaseInsensitiveMapping = CaseInsensitiveMapping(
+VIEWING_CONDITIONS_RLAB: CanonicalMapping = CanonicalMapping(
     {"Average": 1 / 2.3, "Dim": 1 / 2.9, "Dark": 1 / 3.5}
 )
 VIEWING_CONDITIONS_RLAB.__doc__ = """
@@ -79,7 +79,7 @@
 :cite:`Fairchild1996a`, :cite:`Fairchild2013w`
 """
 
-D_FACTOR_RLAB: CaseInsensitiveMapping = CaseInsensitiveMapping(
+D_FACTOR_RLAB: CanonicalMapping = CanonicalMapping(
     {
         "Hard Copy Images": 1,
         "Soft Copy Images": 0,

diff --git a/colour/appearance/zcam.py b/colour/appearance/zcam.py
@@ -49,7 +49,7 @@
 )
 from colour.models import Izazbz_to_XYZ, XYZ_to_Izazbz, xy_to_XYZ
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     MixinDataclassArithmetic,
     as_float,
     as_float_array,
@@ -109,7 +109,7 @@ class InductionFactors_ZCAM(
     """
 
 
-VIEWING_CONDITIONS_ZCAM: CaseInsensitiveMapping = CaseInsensitiveMapping(
+VIEWING_CONDITIONS_ZCAM: CanonicalMapping = CanonicalMapping(
     {
         "Average": InductionFactors_ZCAM(
             0.69, *VIEWING_CONDITIONS_CIECAM02["Average"]

diff --git a/colour/biochemistry/michaelis_menten.py b/colour/biochemistry/michaelis_menten.py
@@ -35,7 +35,7 @@
     Union,
 )
 from colour.utilities import (
-    CaseInsensitiveMapping,
+    CanonicalMapping,
     as_float,
     as_float_array,
     filter_kwargs,
@@ -157,13 +157,11 @@ def reaction_rate_MichaelisMenten_Abebe2017(
     return as_float(v)
 
 
-REACTION_RATE_MICHAELISMENTEN_METHODS: CaseInsensitiveMapping = (
-    CaseInsensitiveMapping(
-        {
-            "Michaelis 1913": reaction_rate_MichaelisMenten_Michaelis1913,
-            "Abebe 2017": reaction_rate_MichaelisMenten_Abebe2017,
-        }
-    )
+REACTION_RATE_MICHAELISMENTEN_METHODS: CanonicalMapping = CanonicalMapping(
+    {
+        "Michaelis 1913": reaction_rate_MichaelisMenten_Michaelis1913,
+        "Abebe 2017": reaction_rate_MichaelisMenten_Abebe2017,
+    }
 )
 REACTION_RATE_MICHAELISMENTEN_METHODS.__doc__ = """
 Supported *Michaelis-Menten* kinetics reaction rate equation computation
@@ -330,8 +328,8 @@ def substrate_concentration_MichaelisMenten_Abebe2017(
 
 
 SUBSTRATE_CONCENTRATION_MICHAELISMENTEN_METHODS: (
-    CaseInsensitiveMapping
-) = CaseInsensitiveMapping(
+    CanonicalMapping
+) = CanonicalMapping(
     {
         "Michaelis 1913": substrate_concentration_MichaelisMenten_Michaelis1913,
         "Abebe 2017": substrate_concentration_MichaelisMenten_Abebe2017,

diff --git a/colour/blindness/datasets/machado2010.py b/colour/blindness/datasets/machado2010.py
@@ -15,7 +15,7 @@
 
 import numpy as np
 
-from colour.utilities import CaseInsensitiveMapping
+from colour.utilities import CanonicalMapping
 
 __author__ = "Colour Developers"
 __copyright__ = "Copyright 2013 Colour Developers"
@@ -28,7 +28,7 @@
     "CVD_MATRICES_MACHADO2010",
 ]
 
-CVD_MATRICES_MACHADO2010: CaseInsensitiveMapping = CaseInsensitiveMapping(
+CVD_MATRICES_MACHADO2010: CanonicalMapping = CanonicalMapping(
     {
         "Protanomaly": {
             0.0: np.array(