Rename "colour.models.RGB_COLOURSPACE_ALEXA_WIDE_GAMUT" attribute to …

…"RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3".
berchan · Nov 7, 2022 · 964b51a · 964b51a
1 parent aa28736
commit 964b51a
Show file tree

Hide file tree

Showing 10 changed files with 128 additions and 107 deletions.
diff --git a/README.rst b/README.rst
@@ -1010,7 +1010,7 @@ RGB Colourspaces
      'ACEScct',
      'ACEScg',
      'ACESproxy',
-     'ALEXA Wide Gamut',
+     'ARRI Wide Gamut 3',
      'Adobe RGB (1998)',
      'Adobe Wide Gamut RGB',
      'Apple RGB',

diff --git a/colour/models/__init__.py b/colour/models/__init__.py
@@ -270,7 +270,7 @@
     RGB_COLOURSPACE_ACESCG,
     RGB_COLOURSPACE_ADOBE_RGB1998,
     RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB,
-    RGB_COLOURSPACE_ALEXA_WIDE_GAMUT,
+    RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3,
     RGB_COLOURSPACE_APPLE_RGB,
     RGB_COLOURSPACE_BEST_RGB,
     RGB_COLOURSPACE_BETA_RGB,
@@ -668,7 +668,7 @@
     "RGB_COLOURSPACE_ACESCG",
     "RGB_COLOURSPACE_ADOBE_RGB1998",
     "RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB",
-    "RGB_COLOURSPACE_ALEXA_WIDE_GAMUT",
+    "RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3",
     "RGB_COLOURSPACE_APPLE_RGB",
     "RGB_COLOURSPACE_BEST_RGB",
     "RGB_COLOURSPACE_BETA_RGB",
@@ -804,6 +804,10 @@ def __getattr__(self, attribute) -> Any:
 # v0.4.2
 API_CHANGES["ObjectRenamed"].extend(
     [
+        [
+            "colour.models.RGB_COLOURSPACE_ALEXA_WIDE_GAMUT",
+            "colour.models.RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3",
+        ],
         [
             "colour.models.eotf_inverse_BT2020",
             "colour.models.oetf_BT2020",

diff --git a/colour/models/rgb/__init__.py b/colour/models/rgb/__init__.py
@@ -165,7 +165,7 @@
     RGB_COLOURSPACE_ACESCG,
     RGB_COLOURSPACE_ADOBE_RGB1998,
     RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB,
-    RGB_COLOURSPACE_ALEXA_WIDE_GAMUT,
+    RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3,
     RGB_COLOURSPACE_APPLE_RGB,
     RGB_COLOURSPACE_BEST_RGB,
     RGB_COLOURSPACE_BETA_RGB,
@@ -430,7 +430,7 @@
     "RGB_COLOURSPACE_ACESCG",
     "RGB_COLOURSPACE_ADOBE_RGB1998",
     "RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB",
-    "RGB_COLOURSPACE_ALEXA_WIDE_GAMUT",
+    "RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3",
     "RGB_COLOURSPACE_APPLE_RGB",
     "RGB_COLOURSPACE_BEST_RGB",
     "RGB_COLOURSPACE_BETA_RGB",

diff --git a/colour/models/rgb/datasets/__init__.py b/colour/models/rgb/datasets/__init__.py
@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from colour.utilities import CanonicalMapping
+from colour.utilities import LazyCanonicalMapping, usage_warning
 from .aces import (
     RGB_COLOURSPACE_ACES2065_1,
     RGB_COLOURSPACE_ACESCC,
@@ -11,7 +11,7 @@
 from .adobe_rgb_1998 import RGB_COLOURSPACE_ADOBE_RGB1998
 from .adobe_wide_gamut_rgb import RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB
 from .apple_rgb import RGB_COLOURSPACE_APPLE_RGB
-from .arri_alexa_wide_gamut import RGB_COLOURSPACE_ALEXA_WIDE_GAMUT
+from .arri import RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3
 from .best_rgb import RGB_COLOURSPACE_BEST_RGB
 from .beta_rgb import RGB_COLOURSPACE_BETA_RGB
 from .blackmagic_design import RGB_COLOURSPACE_BLACKMAGIC_WIDE_GAMUT
@@ -74,7 +74,7 @@
 
 from colour.models.rgb import RGB_Colourspace
 
-RGB_COLOURSPACES: CanonicalMapping = CanonicalMapping(
+RGB_COLOURSPACES: LazyCanonicalMapping = LazyCanonicalMapping(
     dict(
         sorted(
             (colourspace.name, colourspace)
@@ -112,7 +112,7 @@
     "RGB_COLOURSPACE_ACESCG",
     "RGB_COLOURSPACE_ADOBE_RGB1998",
     "RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB",
-    "RGB_COLOURSPACE_ALEXA_WIDE_GAMUT",
+    "RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3",
     "RGB_COLOURSPACE_APPLE_RGB",
     "RGB_COLOURSPACE_BEST_RGB",
     "RGB_COLOURSPACE_BETA_RGB",
@@ -169,3 +169,20 @@
     "RGB_COLOURSPACE_XTREME_RGB",
     "RGB_COLOURSPACE_F_GAMUT",
 ]
+
+
+# ----------------------------------------------------------------------------#
+# ---                API Changes and Deprecation Management                ---#
+# ----------------------------------------------------------------------------#
+# v0.4.2
+def _alexa_wide_gamut():
+    usage_warning(
+        'The "ALEXA Wide Gamut" RGB colourspace has been renamed to '
+        '"ARRI Wide Gamut 3" for consistency with "ARRI" new naming '
+        "convention."
+    )
+
+    return RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3
+
+
+RGB_COLOURSPACES["ALEXA Wide Gamut"] = _alexa_wide_gamut
diff --git a/colour/models/rgb/datasets/arri.py b/colour/models/rgb/datasets/arri.py
@@ -0,0 +1,94 @@
+"""
+ARRI Colourspaces
+=================
+
+Defines the *ARRI* colourspaces:
+
+-   :attr:`colour.models.RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3`.
+
+References
+----------
+-   :cite:`ARRI2012a` : ARRI. (2012). ALEXA - Log C Curve - Usage in VFX.
+    https://drive.google.com/open?id=1t73fAG_QpV7hJxoQPYZDWvOojYkYDgvn
+"""
+
+from __future__ import annotations
+
+import numpy as np
+
+from colour.colorimetry import CCS_ILLUMINANTS
+from colour.hints import NDArray
+from colour.models.rgb import (
+    RGB_Colourspace,
+    log_encoding_ALEXALogC,
+    log_decoding_ALEXALogC,
+)
+
+__author__ = "Colour Developers"
+__copyright__ = "Copyright 2013 Colour Developers"
+__license__ = "New BSD License - https://opensource.org/licenses/BSD-3-Clause"
+__maintainer__ = "Colour Developers"
+__email__ = "[email protected]"
+__status__ = "Production"
+
+__all__ = [
+    "PRIMARIES_ARRI_WIDE_GAMUT_3",
+    "WHITEPOINT_NAME_ARRI_WIDE_GAMUT_3",
+    "CCS_WHITEPOINT_ARRI_WIDE_GAMUT_3",
+    "MATRIX_ARRI_WIDE_GAMUT_3_TO_XYZ",
+    "MATRIX_XYZ_TO_ARRI_WIDE_GAMUT_3",
+    "RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3",
+]
+
+PRIMARIES_ARRI_WIDE_GAMUT_3: NDArray = np.array(
+    [
+        [0.6840, 0.3130],
+        [0.2210, 0.8480],
+        [0.0861, -0.1020],
+    ]
+)
+"""*ARRI Wide Gamut 3* colourspace primaries."""
+
+WHITEPOINT_NAME_ARRI_WIDE_GAMUT_3: str = "D65"
+"""*ARRI Wide Gamut 3* colourspace whitepoint name."""
+
+CCS_WHITEPOINT_ARRI_WIDE_GAMUT_3: NDArray = CCS_ILLUMINANTS[
+    "CIE 1931 2 Degree Standard Observer"
+][WHITEPOINT_NAME_ARRI_WIDE_GAMUT_3]
+"""*ARRI Wide Gamut 3* colourspace whitepoint chromaticity coordinates."""
+
+MATRIX_ARRI_WIDE_GAMUT_3_TO_XYZ: NDArray = np.array(
+    [
+        [0.638008, 0.214704, 0.097744],
+        [0.291954, 0.823841, -0.115795],
+        [0.002798, -0.067034, 1.153294],
+    ]
+)
+"""*ARRI Wide Gamut 3* colourspace to *CIE XYZ* tristimulus values matrix."""
+
+MATRIX_XYZ_TO_ARRI_WIDE_GAMUT_3: NDArray = np.array(
+    [
+        [1.789066, -0.482534, -0.200076],
+        [-0.639849, 1.396400, 0.194432],
+        [-0.041532, 0.082335, 0.878868],
+    ]
+)
+"""*CIE XYZ* tristimulus values to *ARRI Wide Gamut 3* colourspace matrix."""
+
+RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3: RGB_Colourspace = RGB_Colourspace(
+    "ARRI Wide Gamut 3",
+    PRIMARIES_ARRI_WIDE_GAMUT_3,
+    CCS_WHITEPOINT_ARRI_WIDE_GAMUT_3,
+    WHITEPOINT_NAME_ARRI_WIDE_GAMUT_3,
+    MATRIX_ARRI_WIDE_GAMUT_3_TO_XYZ,
+    MATRIX_XYZ_TO_ARRI_WIDE_GAMUT_3,
+    log_encoding_ALEXALogC,
+    log_decoding_ALEXALogC,
+)
+RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3.__doc__ = """
+*ARRI Wide Gamut 3* colourspace.
+
+References
+----------
+:cite:`ARRI2012a`
+"""
diff --git a/colour/models/rgb/datasets/arri_alexa_wide_gamut.py b/colour/models/rgb/datasets/arri_alexa_wide_gamut.py
diff --git a/colour/models/rgb/datasets/tests/test__init__.py b/colour/models/rgb/datasets/tests/test__init__.py
@@ -39,7 +39,7 @@ def test_transformation_matrices(self):
 
         tolerances = {
             "Adobe RGB (1998)": 1e-5,
-            "ALEXA Wide Gamut": 1e-6,
+            "ARRI Wide Gamut 3": 1e-6,
             "DJI D-Gamut": 1e-4,
             "ERIMM RGB": 1e-3,
             "ProPhoto RGB": 1e-3,

diff --git a/docs/basics.rst b/docs/basics.rst
@@ -42,7 +42,7 @@ Similarly, all the RGB colourspaces can be individually accessed from the
                              RGB_COLOURSPACE_ACES2065_1           RGB_COLOURSPACE_ACESPROXY            RGB_COLOURSPACE_APPLE_RGB            RGB_COLOURSPACE_BT470_525
                              RGB_COLOURSPACE_ACESCC               RGB_COLOURSPACE_ADOBE_RGB1998        RGB_COLOURSPACE_BEST_RGB             RGB_COLOURSPACE_BT470_625
                              RGB_COLOURSPACE_ACESCCT              RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB RGB_COLOURSPACE_BETA_RGB             RGB_COLOURSPACE_BT709                >
-                             RGB_COLOURSPACE_ACESCG               RGB_COLOURSPACE_ALEXA_WIDE_GAMUT     RGB_COLOURSPACE_BT2020               RGB_COLOURSPACE_CIE_RGB
+                             RGB_COLOURSPACE_ACESCG               RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3    RGB_COLOURSPACE_BT2020               RGB_COLOURSPACE_CIE_RGB
 
 Abbreviations
 -------------

diff --git a/docs/colour.models.rst b/docs/colour.models.rst
@@ -414,7 +414,7 @@ RGB Colourspaces
     RGB_COLOURSPACE_ACESCG
     RGB_COLOURSPACE_ADOBE_RGB1998
     RGB_COLOURSPACE_ADOBE_WIDE_GAMUT_RGB
-    RGB_COLOURSPACE_ALEXA_WIDE_GAMUT
+    RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3
     RGB_COLOURSPACE_APPLE_RGB
     RGB_COLOURSPACE_BEST_RGB
     RGB_COLOURSPACE_BETA_RGB

diff --git a/docs/index.rst b/docs/index.rst
@@ -791,7 +791,7 @@ RGB Colourspaces
      'ACEScct',
      'ACEScg',
      'ACESproxy',
-     'ALEXA Wide Gamut',
+     'ARRI Wide Gamut 3',
      'Adobe RGB (1998)',
      'Adobe Wide Gamut RGB',
      'Apple RGB',