Add VF options to Protocol (OpenwaterHealth#165)

Author: ebrahimebrahim

src/openlifu/plan/protocol.py

@@ -22,6 +22,7 @@
 from openlifu.sim import run_simulation
 from openlifu.util.checkgpu import gpu_available
 from openlifu.util.json import PYFUSEncoder
+from openlifu.virtual_fit import VirtualFitOptions
 from openlifu.xdc import Transducer
 
 OnPulseMismatchAction = Enum("OnPulseMismatchAction", ["ERROR", "ROUND", "ROUNDUP", "ROUNDDOWN"])
@@ -68,6 +69,8 @@ class Protocol:
     analysis_options: SolutionAnalysisOptions = field(default_factory=SolutionAnalysisOptions)
     """ Options to adjust solution analysis. By default, the analysis is configured with default options """
 
+    virtual_fit_options : VirtualFitOptions = field(default_factory=VirtualFitOptions)
+
     def __post_init__(self):
         self.logger = logging.getLogger(__name__)
 
@@ -86,6 +89,8 @@ def from_dict(d : Dict[str,Any]) -> Protocol:
         d['param_constraints'] = d.get("param_constraints", {})
         if "target_constraints" in d:
             d['target_constraints'] = [TargetConstraints.from_dict(d_tc) for d_tc in d.get("target_constraints", {})]
+        if "virtual_fit_options" in d:
+            d['virtual_fit_options'] = VirtualFitOptions.from_dict(d['virtual_fit_options'])
         if "analysis_options" in d:
             if "mainlobe_aspect_ratio" in d["analysis_options"]:
                 d["analysis_options"]["mainlobe_aspect_ratio"] = tuple(d["analysis_options"]["mainlobe_aspect_ratio"])
@@ -106,6 +111,7 @@ def to_dict(self):
             "seg_method": self.seg_method.to_dict(),
             "param_constraints": self.param_constraints,
             "target_constraints": self.target_constraints,
+            "virtual_fit_options": self.virtual_fit_options.to_dict(),
             "analysis_options": self.analysis_options,
         }
 

src/openlifu/virtual_fit.py

@@ -2,7 +2,7 @@
 
 import logging
 from dataclasses import dataclass
-from typing import List, Sequence, Tuple
+from typing import Any, Dict, List, Sequence, Tuple
 
 import numpy as np
 
@@ -95,6 +95,14 @@ def to_units(self, target_units:str) -> VirtualFitOptions:
             planefit_dpitch_step = conversion_factor * self.planefit_dpitch_step,
         )
 
+    @staticmethod
+    def from_dict(parameter_dict:Dict[str,Any]) -> VirtualFitOptions: # Override DictMixin here
+        parameter_dict["pitch_range"] = tuple(parameter_dict["pitch_range"])
+        parameter_dict["yaw_range"] = tuple(parameter_dict["yaw_range"])
+        parameter_dict["steering_limits"] = tuple(map(tuple,parameter_dict["steering_limits"]))
+        return VirtualFitOptions(**parameter_dict)
+
+
 # (Currently we disable pylint E1121 because it is a temporary issue
 # which should be resolved by #165 and #166)
 def virtual_fit( # pylint: disable=E1121

tests/resources/example_db/protocols/example_protocol/example_protocol.json

@@ -90,6 +90,23 @@
   },
   "param_constraints": [],
   "target_constraints": [],
+  "virtual_fit_options": {
+    "units": "mm",
+    "transducer_steering_center_distance": 50.0,
+    "steering_limits": [
+      [-49, 47.5],
+      [-51.2, 53],
+      [-55, 58]
+    ],
+    "pitch_range": [-1, 120],
+    "pitch_step": 3,
+    "yaw_range": [-60, 66],
+    "yaw_step": 2,
+    "planefit_dyaw_extent": 14,
+    "planefit_dyaw_step": 2,
+    "planefit_dpitch_extent": 16,
+    "planefit_dpitch_step": 7
+  },
   "analysis_options": {
     "standoff_sound_speed": 1500.0,
     "standoff_density": 1000.0,