Merge pull request #117 from ampas/feature/add_validation_to_key_settings

Feature/add validation to key settings

Author: KelSolaar

aces/idt/application.py

@@ -406,7 +406,7 @@ def validate_project_settings(self) -> None:
             If any of the validations fail
         """
 
-        # Check the aces_transform_id is a valid idt_urn
+        # Check the aces_transform_id is a valid idt_urn and try and auto populate it
         if not is_valid_csc_urn(self.project_settings.aces_transform_id):
             # If the aces_transform_id is not valid, generate a new one
             new_name = generate_idt_urn(
@@ -418,3 +418,8 @@ def validate_project_settings(self) -> None:
             # Update the project settings with the new name, if this is still invalid
             # it will raise an error from the setter
             self.project_settings.aces_transform_id = new_name
+
+        valid, errors = self.project_settings.validate()
+        if not valid:
+            msg = f"Invalid project settings\n: {'\n'.join(errors)}"
+            raise ValueError(msg)

aces/idt/framework/project_settings.py

@@ -778,3 +778,86 @@ def __str__(self) -> str:
         attributes.append({"line_break": True})
 
         return multiline_str(self, attributes)
+
+    def validate(self) -> tuple[bool, list[str]]:
+        """Validate the project settings to ensure that all the minimally required
+        inputs are set
+
+        Returns
+        -------
+        :class:`tuple`
+            Whether the minimum required settings are valid or not from the ui and what
+            the errors are
+
+        """
+        valid, errors = self.validate_core_requirements(
+            self.aces_user_name,
+            self.encoding_colourspace,
+            self.encoding_transfer_function,
+            self.camera_make,
+            self.camera_model,
+            self.aces_transform_id,
+        )
+        return valid, errors
+
+    @staticmethod
+    def validate_core_requirements(
+        aces_user_name: str,
+        encoding_colourspace: str,
+        encoding_transfer_function: str,
+        camera_make: str,
+        camera_model: str,
+        aces_transform_id: str,
+    ) -> tuple[bool, list[str]]:
+        """
+        Validate the key values needed to have a valid project
+
+        Parameters
+        ----------
+        aces_user_name: str
+            the ACES username
+        encoding_colourspace: str
+            the encoding colourspace
+        encoding_transfer_function: str
+            the encoding transfer function
+        camera_make: str
+            the camera make
+        camera_model : str
+            the camera model
+        aces_transform_id: str
+            the ACES transform id
+
+        Returns
+        -------
+        :class:`tuple`
+            Whether the minimum required settings are valid or not from the ui and
+            what the errors are
+
+        """
+        valid = True
+        errors = []
+        if not camera_make:
+            valid = False
+            errors.append("No Camera Make Specified")
+
+        if not camera_model:
+            valid = False
+            errors.append("No Camera Model Specified")
+
+        if not aces_user_name:
+            valid = False
+            errors.append("No ACES User Name Specified")
+
+        if not encoding_colourspace:
+            valid = False
+            errors.append("No Encoding Colourspace Specified")
+
+        if not encoding_transfer_function:
+            valid = False
+            errors.append("No Encoding Transfer Function Specified")
+
+        if not is_valid_csc_urn(aces_transform_id):
+            valid = False
+            errors.append("Invalid ACES Transform ID")
+
+        return valid, errors

aces/idt/generators/base_generator.py

@@ -720,6 +720,8 @@ def to_clf(self, output_directory: Path | str) -> Path:
         aces_user_name = project_settings.aces_user_name
         camera_make = project_settings.camera_make
         camera_model = project_settings.camera_model
+        encoding_colourspace = project_settings.encoding_colourspace
+        encoding_transfer_function = project_settings.encoding_transfer_function
 
         root = ET.Element(
             "ProcessList",
@@ -788,10 +790,11 @@ def format_array(a: NDArray) -> str:
             self.project_settings.include_exposure_factor_in_clf,
         )
 
-        clf_path = (
-            Path(output_directory)
-            / f"{camera_make}.Input.{camera_model}_to_ACES2065-1.clf"
+        file_name = (
+            f"idt.{aces_user_name}.{camera_model}.{encoding_colourspace}_"
+            f"{encoding_transfer_function}_to_ACES2065-1.clf"
         )
+        clf_path = Path(output_directory) / file_name
 
         ET.indent(root)
 

apps/idt_calculator_camera.py

@@ -78,7 +78,7 @@
     hash_file,
     png_compare_colour_checkers,
 )
-from aces.idt.core.transform_id import generate_idt_urn, is_valid_csc_urn
+from aces.idt.core.transform_id import generate_idt_urn
 from app import APP, SERVER_URL, __version__
 from apps.common import (
     COLOUR_ENVIRONMENT,
@@ -1274,8 +1274,8 @@ def compute_idt_camera(
 
     aces_transform_id = str(aces_transform_id)
     aces_user_name = str(aces_user_name or "")
-    camera_make = str(camera_make)
-    camera_model = str(camera_model)
+    camera_make = str(camera_make or "")
+    camera_model = str(camera_model or "")
     iso = float(iso)
     temperature = float(temperature)
     additional_camera_settings = str(additional_camera_settings)
@@ -1285,9 +1285,17 @@ def compute_idt_camera(
     encoding_colourspace = str(encoding_colourspace or "")
     encoding_transfer_function = str(encoding_transfer_function or "")
 
-    # Validation: Check if the ACES transform ID is valid
-    if not is_valid_csc_urn(aces_transform_id):
-        error_message = "Invalid ACES Transform ID!"
+    # Validation: Check if the inputs are valid
+    is_valid, errors = IDTProjectSettings.validate_core_requirements(
+        aces_user_name,
+        encoding_colourspace,
+        encoding_transfer_function,
+        camera_make,
+        camera_model,
+        aces_transform_id,
+    )
+    if not is_valid:
+        error_components = [P(e) for e in errors]
         return (
             "",  # loading-div children
             [],  # output-data-div children
@@ -1304,7 +1312,7 @@ def compute_idt_camera(
             debayering_settings,  # debayering-settings-field value
             encoding_colourspace,  # encoding-colourspace-field value
             encoding_transfer_function,  # encoding-transfer-function-field value
-            error_message,  # Modal body content (error message)
+            error_components,  # Modal body content (error message)
             True,  # Show the modal
         )
 

tests/resources/download_manifest.json

@@ -1,10 +1,10 @@
 {
   "FULL_STOPS_EXR.zip": {
     "URL": "https://www.dropbox.com/scl/fi/srna8mw98wxn47np0adoj/FULL_STOPS_EXR.zip?rlkey=e2n0t59g0olu40gxk31mm01sh&dl=0",
-    "SHA256": "90b9d9a83ccfa5550513ec94e5a82758c078be9404551a747b6aac460e6cb38a"
+    "SHA256": "7f4bb72394e502815e85ef4a45c4a1c027d111e6a54b058b9d4d75e5b76e1127"
   },
   "PTZ_160.zip": {
     "URL": "https://www.dropbox.com/scl/fi/9ni9vcpwahrx8s3l1zqkf/PTZ_160.zip?rlkey=m3ddjysrhmkbfxx7ktgpmgfft&dl=0",
-    "SHA256": "1be3d45442df67e62445b2792e1d73afdea3869b7f0326bdc579cd338fb143b6"
+    "SHA256": "4c3c85a293166ef4896713fc99f28870b90821c1f1d0118c6ceae3b40520d4c2"
   }
 }

tests/resources/synthetic_001.zip

@@ -11,7 +11,8 @@
     "lighting_setup_description": "D65",
     "debayering_platform": "",
     "debayering_settings": "",
-    "encoding_colourspace": "",
+    "encoding_colourspace": "synthetic_colourspace",
+    "encoding_transfer_function": "synthetic_tf",
     "rgb_display_colourspace": "sRGB",
     "cat": "CAT02",
     "optimisation_space": "CIE Lab",

tests/resources/synthetic_001/synthetic_001.json

@@ -11,7 +11,8 @@
     "lighting_setup_description": "D65",
     "debayering_platform": "",
     "debayering_settings": "",
-    "encoding_colourspace": "",
+    "encoding_colourspace": "synthetic_colourspace",
+    "encoding_transfer_function": "synthetic_tf",
     "rgb_display_colourspace": "sRGB",
     "cat": "CAT02",
     "optimisation_space": "CIE Lab",