wip 2

Author: arhowe00

db_dvc.dvc

@@ -1,6 +1,6 @@
 outs:
-- md5: 4e002abfa508c89a5c7afdff8c3c61a1.dir
+- md5: b61cbb96c629b2ea7130c5a06166975e.dir
   nfiles: 257
   hash: md5
   path: db_dvc
-  size: 933884330
+  size: 933883287

notebooks/test_solution_analysis.py

@@ -13,6 +13,8 @@
 # ---
 from __future__ import annotations
 
+import numpy as np
+
 from openlifu.bf import Pulse, Sequence, apod_methods, focal_patterns
 from openlifu.geo import Point
 from openlifu.plan import Protocol
@@ -27,7 +29,7 @@
 focal_pattern = focal_patterns.SinglePoint(target_pressure=1.2e6)
 focal_pattern = focal_patterns.Wheel(center=False, spoke_radius=5, num_spokes=3, target_pressure=1.2e6)
 apod_method = apod_methods.MaxAngle(30)
-sim_setup = SimSetup(x_extent=[-30,30], y_extent=[-30,30], z_extent=[-4,70])
+sim_setup = SimSetup(x_extent=(-30,30), y_extent=(-30,30), z_extent=(-4,70))
 protocol = Protocol(
     id='test_protocol',
     name='Test Protocol',
@@ -37,7 +39,8 @@
     apod_method=apod_method,
     sim_setup=sim_setup)
 
-target = Point(position=(0,0,50), units="mm", radius=2)
+target = Point(position=np.array([0, 0, 50]), units="mm", radius=2)
+# You can't assign kerf as 0.5 because it's an int
 trans = Transducer.gen_matrix_array(nx=8, ny=8, pitch=4, kerf=0.5, id="m3", name="openlifu", impulse_response=1e6/10)
 # -
 
@@ -48,12 +51,14 @@
     scale=True)
 
 pc = {"MI":ParameterConstraint('<', 1.8, 1.85), "TIC":ParameterConstraint('<', 2.0), 'global_isppa_Wcm2':ParameterConstraint('within', error_value=(49, 190))}
-scaled_analysis.to_table(constraints=pc).set_index('Param')[['Value', 'Units', 'Status']]
+if scaled_analysis is not None:
+    scaled_analysis.to_table(constraints=pc).set_index('Param')[['Value', 'Units', 'Status']]
 
 protocol = Protocol.from_file('../tests/resources/example_db/protocols/example_protocol/example_protocol.json')
 solution, sim_res, analysis = protocol.calc_solution(
     target=target,
     transducer=trans,
     simulate=True,
     scale=True)
-analysis.to_table().set_index('Param')[['Value', 'Units', 'Status']]
+if analysis is not None:
+    analysis.to_table().set_index('Param')[['Value', 'Units', 'Status']]

src/openlifu/plan/param_constraint.py

@@ -3,8 +3,8 @@
 from dataclasses import dataclass
 from typing import Annotated, Literal, Tuple
 
-from openlifu.util.dict_conversion import DictMixin
 from openlifu.util.annotations import OpenLIFUFieldData
+from openlifu.util.dict_conversion import DictMixin
 
 PARAM_STATUS_SYMBOLS = {
     "ok": "✅",
@@ -27,13 +27,19 @@ def __post_init__(self):
         if self.warning_value is None and self.error_value is None:
             raise ValueError("At least one of warning_value or error_value must be set")
         if self.operator in ['within','inside','outside','outside_inclusive']:
-            if self.warning_value is not None:
-                if not isinstance(self.warning_value, tuple) or len(self.warning_value) != 2 or (self.warning_value[0] >= self.warning_value[1]):
-                    raise ValueError("Warning value must be a sorted tuple of two numbers")
+            if self.warning_value is not None and (
+                not isinstance(self.warning_value, tuple) or
+                len(self.warning_value) != 2 or
+                self.warning_value[0] >= self.warning_value[1]
+            ):
+                raise ValueError("Warning value must be a sorted tuple of two numbers")
 
-            if self.error_value is not None:
-                if not isinstance(self.error_value, tuple) or len(self.error_value) != 2 or not (self.error_value[0] >= self.error_value[1]):
-                    raise ValueError("Error value must be a sorted tuple of two numbers")
+            if self.error_value is not None and (
+                not isinstance(self.error_value, tuple) or
+                len(self.error_value) != 2 or
+                self.error_value[0] >= self.error_value[1]
+            ):
+                raise ValueError("Error value must be a sorted tuple of two numbers")
         elif self.operator in ['<','<=','>','>=']:
             if self.warning_value is not None and not isinstance(self.warning_value, (int, float)):
                 raise ValueError("Warning value must be a single value")

src/openlifu/plan/solution.py

@@ -99,7 +99,7 @@ def num_foci(self) -> int:
     def analyze(self,
                 transducer: Transducer,
                 options: SolutionAnalysisOptions = SolutionAnalysisOptions(),
-                param_constraints: Dict[str,ParameterConstraint] = {}) -> SolutionAnalysis:
+                param_constraints: Dict[str,ParameterConstraint] | None = None) -> SolutionAnalysis:
         """Analyzes the treatment solution.
 
         Args:
@@ -108,6 +108,9 @@ def analyze(self,
 
         Returns: A struct containing the results of the analysis.
         """
+        # Avoid using a mutable default argument ({}); it can lead to unexpected shared state across function calls. Use None and initialize inside the function instead.
+        if param_constraints is None:
+            param_constraints = {}
         solution_analysis = SolutionAnalysis()
 
         if transducer.id != self.transducer_id:

src/openlifu/plan/solution_analysis.py

@@ -8,11 +8,14 @@
 import pandas as pd
 import xarray as xa
 
+from openlifu.plan.param_constraint import PARAM_STATUS_SYMBOLS, ParameterConstraint
 from openlifu.util.annotations import OpenLIFUFieldData
 from openlifu.util.dict_conversion import DictMixin
 
 DEFAULT_ORIGIN = np.zeros(3)
 
+# We might have some redundancies here to fix later, but it should be easy to
+# resolve these things
 PARAM_FORMATS = {
     "mainlobe_pnp_MPa": ["max", "0.3f", "MPa", "Mainlobe Peak Negative Pressure"],
     "mainlobe_isppa_Wcm2": ["max", "0.3f", "W/cm^2", "Mainlobe I_SPPA"],

tests/test_solution.py

@@ -20,6 +20,7 @@ def example_transducer() -> Transducer:
     return Transducer(
         id="trans_456",
         name="Test Transducer",
+        # I'm getting a type mismatch here. Currently, elements is a Tuple of a single Element. I think you should change it to a list of elements, but I don't know if this will affect the codebase in many places (@ebrahimebrahim, any thoughts?); TODO: fix
         elements=[
             Element(index=1, x=-14, y=-14, units="m"),
             Element(index=2, x=-2, y=-2, units="m"),