Option To Flatten The Matrix In The CLF

aces/idt/core/common.py

@@ -421,6 +421,7 @@ def clf_processing_elements(
     k_factor: float,
     use_range: bool = True,
     include_white_balance_in_clf: bool = False,
+    flatten_clf: bool = True,
 ) -> Et.Element:
     """
     Add the *Common LUT Format* (CLF) elements for given *IDT* matrix,
@@ -440,6 +441,8 @@ def clf_processing_elements(
         factor :math:`k`.
     include_white_balance_in_clf
         Whether to include the white balance multipliers in the *CLF*.
+    flatten_clf
+        Whether to flatten the *CLF*. into a single 1D Lut & 1 3x3 Matrix
 
     Returns
     -------
@@ -460,39 +463,56 @@ def format_array(a: NDArrayFloat) -> str:
 
         return formatted_string
 
-    if include_white_balance_in_clf:
-        et_RGB_w = Et.SubElement(root, "Matrix", inBitDepth="32f", outBitDepth="32f")
-        et_description = Et.SubElement(et_RGB_w, "Description")
-        et_description.text = "White balance multipliers *b*."
-        et_array = Et.SubElement(et_RGB_w, "Array", dim="3 3")
-        et_array.text = f"\n\t\t{format_array(np.diag(multipliers))}"
-
-    if use_range:
-        et_range = Et.SubElement(
-            root,
-            "Range",
-            inBitDepth="32f",
-            outBitDepth="32f",
+    if not flatten_clf:
+        if include_white_balance_in_clf:
+            et_RGB_w = Et.SubElement(
+                root, "Matrix", inBitDepth="32f", outBitDepth="32f"
+            )
+            et_description = Et.SubElement(et_RGB_w, "Description")
+            et_description.text = "White balance multipliers *b*."
+            et_array = Et.SubElement(et_RGB_w, "Array", dim="3 3")
+            et_array.text = f"\n\t\t{format_array(np.diag(multipliers))}"
+
+        # TODO is this even used any more? Default param is False, and the calling
+        # TODO function is hard coded to False
+        if use_range:
+            et_range = Et.SubElement(
+                root,
+                "Range",
+                inBitDepth="32f",
+                outBitDepth="32f",
+            )
+            et_max_in_value = Et.SubElement(et_range, "maxInValue")
+            et_max_in_value.text = "1"
+            et_max_out_value = Et.SubElement(et_range, "maxOutValue")
+            et_max_out_value.text = "1"
+
+        et_k = Et.SubElement(root, "Matrix", inBitDepth="32f", outBitDepth="32f")
+        et_description = Et.SubElement(et_k, "Description")
+        et_description.text = (
+            'Exposure factor *k* that results in a nominally "18% gray" object in '
+            "the scene producing ACES values [0.18, 0.18, 0.18]."
         )
-        et_max_in_value = Et.SubElement(et_range, "maxInValue")
-        et_max_in_value.text = "1"
-        et_max_out_value = Et.SubElement(et_range, "maxOutValue")
-        et_max_out_value.text = "1"
-
-    et_k = Et.SubElement(root, "Matrix", inBitDepth="32f", outBitDepth="32f")
-    et_description = Et.SubElement(et_k, "Description")
-    et_description.text = (
-        'Exposure factor *k* that results in a nominally "18% gray" object in '
-        "the scene producing ACES values [0.18, 0.18, 0.18]."
-    )
-    et_array = Et.SubElement(et_k, "Array", dim="3 3")
-    et_array.text = f"\n\t\t{format_array(np.ravel(np.diag([k_factor] * 3)))}"
-
-    et_M = Et.SubElement(root, "Matrix", inBitDepth="32f", outBitDepth="32f")
-    et_description = Et.SubElement(et_M, "Description")
-    et_description.text = "*Input Device Transform* (IDT) matrix *B*."
-    et_array = Et.SubElement(et_M, "Array", dim="3 3")
-    et_array.text = f"\n\t\t{format_array(matrix)}"
+        et_array = Et.SubElement(et_k, "Array", dim="3 3")
+        et_array.text = f"\n\t\t{format_array(np.ravel(np.diag([k_factor] * 3)))}"
+
+        et_M = Et.SubElement(root, "Matrix", inBitDepth="32f", outBitDepth="32f")
+        et_description = Et.SubElement(et_M, "Description")
+        et_description.text = "*Input Device Transform* (IDT) matrix *B*."
+        et_array = Et.SubElement(et_M, "Array", dim="3 3")
+        et_array.text = f"\n\t\t{format_array(matrix)}"
+
+    else:
+        # If we are flattening the clf we output just a single matrix into the clf
+        output_matrix = np.diag([k_factor] * 3) @ matrix
+        if include_white_balance_in_clf:
+            output_matrix = np.diag(multipliers) @ np.diag([k_factor] * 3) @ matrix
+
+        et_M = Et.SubElement(root, "Matrix", inBitDepth="32f", outBitDepth="32f")
+        et_description = Et.SubElement(et_M, "Description")
+        et_description.text = "*Input Device Transform* (IDT) matrix *B*."
+        et_array = Et.SubElement(et_M, "Array", dim="3 3")
+        et_array.text = f"\n\t\t{format_array(output_matrix)}"
 
     return root
 

aces/idt/core/constants.py

@@ -405,6 +405,14 @@ class ProjectSettingsMetadataConstants:
         ui_category=UICategories.STANDARD,
     )
 
+    FLATTEN_CLF = Metadata(
+        default_value=False,
+        description="Whether to flatten the CLF to a 1D Lut and a single 3x3 Matrix ",
+        display_name="Flatten CLF",
+        ui_type=UITypes.BOOLEAN_FIELD,
+        ui_category=UICategories.STANDARD,
+    )
+
     ALL: ClassVar[tuple[Metadata, ...]] = (
         SCHEMA_VERSION,
         CAMERA_MAKE,
@@ -436,4 +444,5 @@ class ProjectSettingsMetadataConstants:
         EV_WEIGHTS,
         OPTIMIZATION_KWARGS,
         INCLUDE_WHITE_BALANCE_IN_CLF,
+        FLATTEN_CLF,
     )

aces/idt/framework/project_settings.py

@@ -170,6 +170,10 @@ def __init__(self, **kwargs: Dict):
             "include_white_balance_in_clf",
             IDTProjectSettings.include_white_balance_in_clf.metadata.default_value,
         )
+        self._flatten_clf = kwargs.get(
+            "flatten_clf",
+            IDTProjectSettings.flatten_clf.metadata.default_value,
+        )
 
     @metadata_property(metadata=MetadataConstants.SCHEMA_VERSION)
     def schema_version(self) -> str:
@@ -560,6 +564,19 @@ def include_white_balance_in_clf(self) -> bool:
         """
         return self._include_white_balance_in_clf
 
+    @metadata_property(metadata=MetadataConstants.FLATTEN_CLF)
+    def flatten_clf(self) -> str:
+        """
+        Getter property for the flatten_clf.
+
+        Returns
+        -------
+        :class:`bool`
+            Whether to flatten the clf output into a 1D LUT and a single 3x3 Matrix
+        """
+
+        return self._flatten_clf
+
     def get_reference_colour_checker_samples(self) -> NDArrayFloat:
         """
         Return the reference colour checker samples.

aces/idt/generators/base_generator.py

@@ -737,6 +737,7 @@ def format_array(a):
             self._k,
             False,
             self.project_settings.include_white_balance_in_clf,
+            self.project_settings.flatten_clf,
         )
 
         clf_path = (

tests/resources/example_from_folder.json

@@ -6,6 +6,7 @@
     "camera_make": "",
     "camera_model": "",
     "include_white_balance_in_clf": false,
+    "flatten_clf": false,
     "iso": 800,
     "temperature": 6000,
     "additional_camera_settings": "",