Fix handling of null transducer models (#218)

Author: ebrahimebrahim

src/openlifu/db/database.py

@@ -707,29 +707,33 @@ def load_photoscan(self, subject_id, session_id, photoscan_id, load_data = False
         return photoscan
 
     def get_transducer_absolute_filepaths(self, transducer_id:str) -> dict:
-        """ Returns the absolute filepaths to the model data files i.e. transducer body and registration surface model files affiliated with the transducer, with ID `transducer_id`.
-        Unlike `load_transducer`, which specifies the relative paths to the model datafiles along with other transducer attributes, this function only returns the absolute filepaths to
-        the datafiles based on the Database directory.
+        """ Returns the absolute filepaths to the model data files i.e. transducer body and registration surface
+        model files affiliated with the transducer, with ID `transducer_id`. Unlike `load_transducer`, which
+        specifies the relative paths to the model datafiles along with other transducer attributes, this function
+        only returns the absolute filepaths to  the datafiles based on the Database directory.
+
         Args:
             transducer_id: Transducer ID
+
         Returns:
-            dict: A dictionary containing the absolute filepaths to the affiliated transducer data files with the following keys:
+            dict: A dictionary containing the absolute filepaths to the affiliated transducer data files with the following possible keys:
                 - "id" (str): transducer ID
                 - "name" (str): transducer name
-                - "registration_surface_abspath" (str): absolute path to the transducer registration surface (open-surface mesh used for transducer tracking registration)
-                - "transducer_body_abspath" (str): absolute path to the transducer body model (closed-surface mesh for visualizing the transducer)
+                - "registration_surface_abspath" (str): absolute path to the transducer registration surface (open-surface mesh
+                  used for transducer tracking registration). This key is only included if there *is* an affiliated registration surface.
+                - "transducer_body_abspath" (str): absolute path to the transducer body model (closed-surface mesh for visualizing the
+                  transducer). This key is only included if there *is* an affiliated body model.
         """
         transducer_metadata_filepath = self.get_transducer_filename(transducer_id)
         with open(transducer_metadata_filepath) as f:
             transducer = json.load(f)
-            if "registration_surface_filename" not in transducer and "transducer_body_filename" not in transducer:
-                raise ValueError(f"Data filepaths not found affiliated with transducer {transducer_id}")
-            transducer_filepaths_dict = {"id": transducer["id"],\
-                    "name": transducer["name"],
-                    }
-            if "registration_surface_filename" in transducer:
+            transducer_filepaths_dict = {
+                "id": transducer["id"],
+                "name": transducer["name"],
+            }
+            if "registration_surface_filename" in transducer and transducer["registration_surface_filename"] is not None:
                 transducer_filepaths_dict["registration_surface_abspath"] = Path(transducer_metadata_filepath).parent/transducer["registration_surface_filename"]
-            if "transducer_body_filename" in transducer:
+            if "transducer_body_filename" in transducer and transducer["transducer_body_filename"] is not None:
                 transducer_filepaths_dict["transducer_body_abspath"] = Path(transducer_metadata_filepath).parent/transducer["transducer_body_filename"]
             return transducer_filepaths_dict
 

tests/test_database.py

@@ -649,3 +649,38 @@ def test_write_transducer(example_database:Database, example_transducer: Transdu
     example_transducer.registration_surface_filename = "bogus_transducer_model.obj"
     with pytest.raises(ValueError, match="file associated with transducer"):
         example_database.write_transducer(example_transducer, on_conflict=OnConflictOpts.OVERWRITE)
+
+@pytest.mark.parametrize("include_registration_surface", [True, False])
+@pytest.mark.parametrize("include_body_model", [True, False])
+def test_get_transducer_absolute_filepaths(example_database:Database, tmp_path:Path, include_registration_surface:bool, include_body_model:bool):
+    transducer = Transducer(id="transducer_for_test_get_transducer_absolute_filepaths")
+
+    registration_surface_path = None
+    transducer_body_path = None
+    if include_registration_surface:
+        registration_surface_path = Path(tmp_path/"test_db_files/example_registration_surface.obj")
+        registration_surface_path.parent.mkdir(parents=True, exist_ok=True)
+        registration_surface_path.touch()
+    if include_body_model:
+        transducer_body_path = Path(tmp_path/"test_db_files/example_transducer_body.obj")
+        transducer_body_path.parent.mkdir(parents=True, exist_ok=True)
+        transducer_body_path.touch()
+
+    example_database.write_transducer(
+        transducer=transducer,
+        registration_surface_model_filepath = registration_surface_path,
+        transducer_body_model_filepath = transducer_body_path,
+    )
+    absolute_file_paths = example_database.get_transducer_absolute_filepaths("transducer_for_test_get_transducer_absolute_filepaths")
+    if include_registration_surface:
+        reconstructed_path = Path(absolute_file_paths["registration_surface_abspath"])
+        assert reconstructed_path.exists()
+        assert reconstructed_path.name == registration_surface_path.name
+    else:
+        assert "registration_surface_abspath" not in absolute_file_paths
+    if include_body_model:
+        reconstructed_path = Path(absolute_file_paths["transducer_body_abspath"])
+        assert reconstructed_path.exists()
+        assert reconstructed_path.name == transducer_body_path.name
+    else:
+        assert "transducer_body_abspath" not in absolute_file_paths