Rename "colour.models.log_encoding_ALEXALogC" and "colour.models.log_…

…decoding_ALEXALogC" definitions to "log_encoding_ARRILogC3" and "log_decoding_ARRILogC3" respectively.
colour-science · Nov 7, 2022 · a593876 · a593876
1 parent 964b51a
commit a593876
Show file tree

Hide file tree

Showing 10 changed files with 241 additions and 233 deletions.
diff --git a/README.rst b/README.rst
@@ -1126,7 +1126,7 @@ Log Encoding / Decoding
     ['ACEScc',
      'ACEScct',
      'ACESproxy',
-     'ALEXA Log C',
+     'ARRI LogC3',
      'Canon Log',
      'Canon Log 2',
      'Canon Log 3',
@@ -1161,7 +1161,7 @@ CCTFs Encoding / Decoding
     ['ACEScc',
      'ACEScct',
      'ACESproxy',
-     'ALEXA Log C',
+     'ARRI LogC3',
      'ARIB STD-B67',
      'Canon Log',
      'Canon Log 2',

diff --git a/colour/models/__init__.py b/colour/models/__init__.py
@@ -126,8 +126,8 @@
     log_decoding_ACEScct,
     oetf_ARIBSTDB67,
     oetf_inverse_ARIBSTDB67,
-    log_encoding_ALEXALogC,
-    log_decoding_ALEXALogC,
+    log_encoding_ARRILogC3,
+    log_decoding_ARRILogC3,
     oetf_BlackmagicFilmGeneration5,
     oetf_inverse_BlackmagicFilmGeneration5,
     log_encoding_CanonLog,
@@ -524,8 +524,8 @@
     "log_decoding_ACEScct",
     "oetf_ARIBSTDB67",
     "oetf_inverse_ARIBSTDB67",
-    "log_encoding_ALEXALogC",
-    "log_decoding_ALEXALogC",
+    "log_encoding_ARRILogC3",
+    "log_decoding_ARRILogC3",
     "oetf_BlackmagicFilmGeneration5",
     "oetf_inverse_BlackmagicFilmGeneration5",
     "log_encoding_CanonLog",
@@ -864,6 +864,14 @@ def __getattr__(self, attribute) -> Any:
             "colour.models.ootf_inverse_HLG_BT2100",
             "colour.models.ootf_inverse_BT2100_HLG",
         ],
+        [
+            "colour.models.log_decoding_ALEXALogC",
+            "colour.models.log_decoding_ARRILogC3",
+        ],
+        [
+            "colour.models.log_encoding_ALEXALogC",
+            "colour.models.log_encoding_ARRILogC3",
+        ],
     ]
 )
 """Defines the *colour.models* sub-package API changes."""

diff --git a/colour/models/rgb/__init__.py b/colour/models/rgb/__init__.py
@@ -21,8 +21,8 @@
     log_decoding_ACEScct,
     oetf_ARIBSTDB67,
     oetf_inverse_ARIBSTDB67,
-    log_encoding_ALEXALogC,
-    log_decoding_ALEXALogC,
+    log_encoding_ARRILogC3,
+    log_decoding_ARRILogC3,
     oetf_BlackmagicFilmGeneration5,
     oetf_inverse_BlackmagicFilmGeneration5,
     log_encoding_CanonLog,
@@ -286,8 +286,8 @@
     "log_decoding_ACEScct",
     "oetf_ARIBSTDB67",
     "oetf_inverse_ARIBSTDB67",
-    "log_encoding_ALEXALogC",
-    "log_decoding_ALEXALogC",
+    "log_encoding_ARRILogC3",
+    "log_decoding_ARRILogC3",
     "oetf_BlackmagicFilmGeneration5",
     "oetf_inverse_BlackmagicFilmGeneration5",
     "log_encoding_CanonLog",

diff --git a/colour/models/rgb/datasets/arri.py b/colour/models/rgb/datasets/arri.py
@@ -20,8 +20,8 @@
 from colour.hints import NDArray
 from colour.models.rgb import (
     RGB_Colourspace,
-    log_encoding_ALEXALogC,
-    log_decoding_ALEXALogC,
+    log_encoding_ARRILogC3,
+    log_decoding_ARRILogC3,
 )
 
 __author__ = "Colour Developers"
@@ -82,8 +82,8 @@
     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,
+    log_encoding_ARRILogC3,
+    log_decoding_ARRILogC3,
 )
 RGB_COLOURSPACE_ARRI_WIDE_GAMUT_3.__doc__ = """
 *ARRI Wide Gamut 3* colourspace.

diff --git a/colour/models/rgb/transfer_functions/__init__.py b/colour/models/rgb/transfer_functions/__init__.py
@@ -27,7 +27,7 @@
     log_decoding_ACEScct,
 )
 from .arib_std_b67 import oetf_ARIBSTDB67, oetf_inverse_ARIBSTDB67
-from .arri_alexa_log_c import log_encoding_ALEXALogC, log_decoding_ALEXALogC
+from .arri import log_encoding_ARRILogC3, log_decoding_ARRILogC3
 from .blackmagic_design import (
     oetf_BlackmagicFilmGeneration5,
     oetf_inverse_BlackmagicFilmGeneration5,
@@ -158,8 +158,8 @@
     "oetf_inverse_ARIBSTDB67",
 ]
 __all__ += [
-    "log_encoding_ALEXALogC",
-    "log_decoding_ALEXALogC",
+    "log_encoding_ARRILogC3",
+    "log_decoding_ARRILogC3",
 ]
 __all__ += [
     "oetf_BlackmagicFilmGeneration5",
@@ -343,7 +343,7 @@
         "ACEScc": log_encoding_ACEScc,
         "ACEScct": log_encoding_ACEScct,
         "ACESproxy": log_encoding_ACESproxy,
-        "ALEXA Log C": log_encoding_ALEXALogC,
+        "ARRI LogC3": log_encoding_ARRILogC3,
         "Canon Log 2": log_encoding_CanonLog2,
         "Canon Log 3": log_encoding_CanonLog3,
         "Canon Log": log_encoding_CanonLog,
@@ -382,7 +382,7 @@ def log_encoding(
             "ACEScc",
             "ACEScct",
             "ACESproxy",
-            "ALEXA Log C",
+            "ARRI LogC3",
             "Canon Log 2",
             "Canon Log 3",
             "Canon Log",
@@ -429,7 +429,7 @@ def log_encoding(
         {:func:`colour.models.log_encoding_ACEScc`,
         :func:`colour.models.log_encoding_ACEScct`,
         :func:`colour.models.log_encoding_ACESproxy`,
-        :func:`colour.models.log_encoding_ALEXALogC`,
+        :func:`colour.models.log_encoding_ARRILogC3`,
         :func:`colour.models.log_encoding_CanonLog2`,
         :func:`colour.models.log_encoding_CanonLog3`,
         :func:`colour.models.log_encoding_CanonLog`,
@@ -490,7 +490,7 @@ def log_encoding(
         "ACEScc": log_decoding_ACEScc,
         "ACEScct": log_decoding_ACEScct,
         "ACESproxy": log_decoding_ACESproxy,
-        "ALEXA Log C": log_decoding_ALEXALogC,
+        "ARRI LogC3": log_decoding_ARRILogC3,
         "Canon Log 2": log_decoding_CanonLog2,
         "Canon Log 3": log_decoding_CanonLog3,
         "Canon Log": log_decoding_CanonLog,
@@ -529,7 +529,7 @@ def log_decoding(
             "ACEScc",
             "ACEScct",
             "ACESproxy",
-            "ALEXA Log C",
+            "ARRI LogC3",
             "Canon Log 2",
             "Canon Log 3",
             "Canon Log",
@@ -576,7 +576,7 @@ def log_decoding(
         {:func:`colour.models.log_decoding_ACEScc`,
         :func:`colour.models.log_decoding_ACEScct`,
         :func:`colour.models.log_decoding_ACESproxy`,
-        :func:`colour.models.log_decoding_ALEXALogC`,
+        :func:`colour.models.log_decoding_ARRILogC3`,
         :func:`colour.models.log_decoding_CanonLog2`,
         :func:`colour.models.log_decoding_CanonLog3`,
         :func:`colour.models.log_decoding_CanonLog`,
@@ -1043,7 +1043,7 @@ def cctf_encoding(
             "ACEScc",
             "ACEScct",
             "ACESproxy",
-            "ALEXA Log C",
+            "ARRI LogC3",
             "ARIB STD-B67",
             "Blackmagic Film Generation 5",
             "Canon Log 2",
@@ -1198,7 +1198,7 @@ def cctf_decoding(
             "ACEScc",
             "ACEScct",
             "ACESproxy",
-            "ALEXA Log C",
+            "ARRI LogC3",
             "ARIB STD-B67",
             "Blackmagic Film Generation 5",
             "Canon Log 2",

diff --git a/...gb/transfer_functions/arri_alexa_log_c.py → colour/models/rgb/transfer_functions/arri.py b/...gb/transfer_functions/arri_alexa_log_c.py → colour/models/rgb/transfer_functions/arri.py
@@ -1,11 +1,11 @@
 """
-ARRI ALEXA Log C Log Encoding
-=============================
+ARRI Log Encodings
+==================
 
-Defines the *ARRI ALEXA Log C* log encoding:
+Defines the *ARRI LogC3* log encoding:
 
--   :func:`colour.models.log_encoding_ALEXALogC`
--   :func:`colour.models.log_decoding_ALEXALogC`
+-   :func:`colour.models.log_encoding_ARRILogC3`
+-   :func:`colour.models.log_decoding_ARRILogC3`
 
 References
 ----------
@@ -36,8 +36,8 @@
 __all__ = [
     "DATA_ALEXA_LOG_C_CURVE_BCL",
     "DATA_ALEXA_LOG_C_CURVE_CONVERSION",
-    "log_encoding_ALEXALogC",
-    "log_decoding_ALEXALogC",
+    "log_encoding_ARRILogC3",
+    "log_decoding_ARRILogC3",
 ]
 
 DATA_ALEXA_LOG_C_CURVE_BCL: CanonicalMapping = CanonicalMapping(
@@ -73,7 +73,7 @@
         },
     }
 )
-"""*ARRI ALEXA Log C* curve *Ei, Black, Clipping Level* data."""
+"""*ARRI LogC3* curve *Ei, Black, Clipping Level* data."""
 
 DATA_ALEXA_LOG_C_CURVE_CONVERSION: CanonicalMapping = CanonicalMapping(
     {
@@ -536,13 +536,13 @@
     }
 )
 """
-*ARRI ALEXA Log C* curve conversion data between signal and linear scene
+*ARRI LogC3* curve conversion data between signal and linear scene
 exposure factor for *SUP 3.x* and signal and normalised sensor signal for
 *SUP 2.x*.
 """
 
 
-def log_encoding_ALEXALogC(
+def log_encoding_ARRILogC3(
     x: FloatingOrArrayLike,
     firmware: Union[Literal["SUP 2.x", "SUP 3.x"], str] = "SUP 3.x",
     method: Union[
@@ -554,8 +554,8 @@ def log_encoding_ALEXALogC(
     ] = 800,
 ) -> FloatingOrNDArray:
     """
-    Define the *ARRI ALEXA Log C* log encoding curve / opto-electronic
-    transfer function.
+    Define the *ARRI LogC3* log encoding curve / opto-electronic transfer
+    function.
 
     Parameters
     ----------
@@ -571,7 +571,7 @@ def log_encoding_ALEXALogC(
     Returns
     -------
     :class:`numpy.floating` or :class:`numpy.ndarray`
-        *ARRI ALEXA Log C* encoded data :math:`t`.
+        *ARRI LogC3* encoded data :math:`t`.
 
     References
     ----------
@@ -593,7 +593,7 @@ def log_encoding_ALEXALogC(
 
     Examples
     --------
-    >>> log_encoding_ALEXALogC(0.18)  # doctest: +ELLIPSIS
+    >>> log_encoding_ARRILogC3(0.18)  # doctest: +ELLIPSIS
     0.3910068...
     """
 
@@ -612,7 +612,7 @@ def log_encoding_ALEXALogC(
     return as_float(from_range_1(t))
 
 
-def log_decoding_ALEXALogC(
+def log_decoding_ARRILogC3(
     t: FloatingOrArrayLike,
     firmware: Union[Literal["SUP 2.x", "SUP 3.x"], str] = "SUP 3.x",
     method: Union[
@@ -624,13 +624,13 @@ def log_decoding_ALEXALogC(
     ] = 800,
 ) -> FloatingOrNDArray:
     """
-    Define the *ARRI ALEXA Log C* log decoding curve / electro-optical
-    transfer function.
+    Define the *ARRI LogC3* log decoding curve / electro-optical transfer
+    function.
 
     Parameters
     ----------
     t
-        *ARRI ALEXA Log C* encoded data :math:`t`.
+        *ARRI LogC3* encoded data :math:`t`.
     firmware
         Alexa firmware version.
     method
@@ -663,7 +663,7 @@ def log_decoding_ALEXALogC(
 
     Examples
     --------
-    >>> log_decoding_ALEXALogC(0.391006832034084)  # doctest: +ELLIPSIS
+    >>> log_decoding_ARRILogC3(0.391006832034084)  # doctest: +ELLIPSIS
     0.18...
     """