Subclass SegmentationMethod definition in protocol config (#318)

This commit subclasses the `SegmentationMethod` configurer to account
for the unique inheritance structure of `SegmentationMethods`. In brief,
there are three levels of inheritance, but the last two levels are
supposed to be alternative selections. Between the alternative
selections, two of them (`UniformWater` and `UniformTissue`) are
supposed to be the same as `UniformSegmentation` except that
`ref_material` is set as water/tissue and is not intended to be mutable.
The subclassing of the definition form takes all these details into
account.

[See the discussion on GitHub
here.](OpenwaterHealth/OpenLIFU-python#289 (comment))

Author: arhowe00

OpenLIFULib/OpenLIFULib/Resources/python-requirements.txt

@@ -1,2 +1,2 @@
-openlifu==0.3.1
+git+https://github.com/OpenwaterHealth/OpenLIFU-python.git@0e09d41ae8eb862319de0598187687db21b3081b
 bcrypt

OpenLIFUProtocolConfig/OpenLIFUProtocolConfig.py

@@ -1,6 +1,7 @@
 # Standard library imports
 from enum import Enum
 from pathlib import Path
+import types
 from typing import (
     List,
     Optional,
@@ -257,8 +258,8 @@ def setup(self) -> None:
         self.abstract_apodization_method_definition_widget = OpenLIFUAbstractApodizationMethodDefinitionFormWidget()
         replace_widget(self.ui.abstractApodizationMethodDefinitionWidgetPlaceholder, self.abstract_apodization_method_definition_widget, self.ui)
 
-        self.segmentation_method_definition_widget = OpenLIFUAbstractDataclassDefinitionFormWidget(cls=openlifu_lz().seg.SegmentationMethod, parent=self.ui.segmentationMethodDefinitionWidgetPlaceholder.parentWidget(), collapsible_title="Segmentation Method")
-        replace_widget(self.ui.segmentationMethodDefinitionWidgetPlaceholder, self.segmentation_method_definition_widget, self.ui)
+        self.abstract_segmentation_method_definition_widget = OpenLIFUAbstractSegmentationMethodDefinitionFormWidget()
+        replace_widget(self.ui.abstractSegmentationMethodDefinitionWidgetPlaceholder, self.abstract_segmentation_method_definition_widget, self.ui)
 
         self.parameter_constraints_widget = OpenLIFUParameterConstraintsWidget()
         replace_widget(self.ui.parameterConstraintsWidgetPlaceholder, self.parameter_constraints_widget, self.ui)
@@ -301,7 +302,7 @@ def setup(self) -> None:
         self.sim_setup_definition_widget.add_value_changed_signals(trigger_unsaved_changes)
         self.abstract_delay_method_definition_widget.add_value_changed_signals(trigger_unsaved_changes)
         self.abstract_apodization_method_definition_widget.add_value_changed_signals(trigger_unsaved_changes)
-        self.segmentation_method_definition_widget.add_value_changed_signals(trigger_unsaved_changes)
+        self.abstract_segmentation_method_definition_widget.add_value_changed_signals(trigger_unsaved_changes)
         self.parameter_constraints_widget.table.itemChanged.connect(lambda *_: trigger_unsaved_changes())
         self.target_constraints_widget.table.itemChanged.connect(lambda *_: trigger_unsaved_changes())
         self.solution_analysis_options_definition_widget.add_value_changed_signals(trigger_unsaved_changes)
@@ -655,7 +656,7 @@ def updateProtocolDisplayFromProtocol(self, protocol: "openlifu.plan.Protocol"):
         self.sim_setup_definition_widget.update_form_from_class(protocol.sim_setup)
         self.abstract_delay_method_definition_widget.update_form_from_class(protocol.delay_method)
         self.abstract_apodization_method_definition_widget.update_form_from_class(protocol.apod_method)
-        self.segmentation_method_definition_widget.update_form_from_class(protocol.seg_method)
+        self.abstract_segmentation_method_definition_widget.update_form_from_class(protocol.seg_method)
         self.parameter_constraints_widget.from_dict(protocol.param_constraints)
         self.target_constraints_widget.from_list(protocol.target_constraints)
         self.solution_analysis_options_definition_widget.update_form_from_class(protocol.analysis_options)
@@ -694,7 +695,7 @@ def getProtocolFromGUI(self) -> "openlifu.plan.Protocol":
         sim_setup = self.sim_setup_definition_widget.get_form_as_class()
         delay_method = self.abstract_delay_method_definition_widget.get_form_as_class()
         apodization_method = self.abstract_apodization_method_definition_widget.get_form_as_class()
-        segmentation_method = self.segmentation_method_definition_widget.get_form_as_class()
+        segmentation_method = self.abstract_segmentation_method_definition_widget.get_form_as_class()
         parameter_constraints = self.parameter_constraints_widget.to_dict()
         target_constraints = self.target_constraints_widget.to_list()
         solution_analysis_options = self.solution_analysis_options_definition_widget.get_form_as_class()
@@ -737,7 +738,7 @@ def setProtocolEditorEnabled(self, enabled: bool) -> None:
         self.sim_setup_definition_widget.setEnabled(enabled)
         self.abstract_delay_method_definition_widget.setEnabled(enabled)
         self.abstract_apodization_method_definition_widget.setEnabled(enabled)
-        self.segmentation_method_definition_widget.setEnabled(enabled)
+        self.abstract_segmentation_method_definition_widget.setEnabled(enabled)
         self.parameter_constraints_widget.setEnabled(enabled)
         self.target_constraints_widget.setEnabled(enabled)
         self.solution_analysis_options_definition_widget.setEnabled(enabled)
@@ -926,7 +927,7 @@ def get_default_apodization_method(cls):
 
     @classmethod
     def get_default_segmentation_method(cls):
-        return openlifu_lz().seg.seg_methods.Water()
+        return openlifu_lz().seg.seg_methods.UniformWater()
 
     @classmethod
     def get_default_parameter_constraints(cls):
@@ -1061,6 +1062,81 @@ def __init__(self):
         max_angle_spinbox = maxangle_definition_form_widget._field_widgets['max_angle']
         maxangle_definition_form_widget.modify_widget_spinbox(max_angle_spinbox, default_value=30, min_value=0, max_value=90)
 
+def _get_form_as_segmentation_method(self):
+    """
+    Custom replacement for get_form_as_class, used to override
+    widgets inside the segmentation method form.
+    """
+    d = self.get_form_as_dict()
+
+    # Remove ref_material if class is UniformWater or UniformTissue
+    if self._cls.__name__ in ["UniformWater", "UniformTissue"]:
+        d.pop("ref_material")
+
+    return self._cls(**d)
+
+class OpenLIFUAbstractSegmentationMethodDefinitionFormWidget(OpenLIFUAbstractMultipleABCDefinitionFormWidget):
+
+
+    def __init__(self):
+        """
+        Overwrite of __init__ that mimics most of super()'s behavior, except
+        accounts for the unique inheritance structure of SegmentationMethod.
+        """
+        # ---- Begin constructor overwrite ----
+
+        cls_list = [openlifu_lz().seg.seg_methods.UniformSegmentation, openlifu_lz().seg.seg_methods.UniformTissue, openlifu_lz().seg.seg_methods.UniformWater]
+        is_collapsible = False
+        parent: Optional[qt.QWidget] = None
+        collapsible_title = "Segmentation Method"
+        custom_abc_title = "Segmentation Method"
+
+        self.cls_list = cls_list
+        self.base_class_name = cls_list[0].__bases__[0].__name__
+        self.custom_abc_title = self.base_class_name if custom_abc_title is None else custom_abc_title
+
+        qt.QWidget.__init__(self, parent)
+
+        top_level_layout = qt.QFormLayout(self)
+
+        self.selector = qt.QComboBox()
+        self.forms = qt.QStackedWidget()
+
+        for cls in cls_list:
+            self.selector.addItem(cls.__name__)
+            widget = OpenLIFUAbstractDataclassDefinitionFormWidget(cls, parent, is_collapsible, collapsible_title)
+            # Override get_form_as_class
+            widget.get_form_as_class = types.MethodType(_get_form_as_segmentation_method, widget)
+            self.forms.addWidget(widget)
+
+        top_level_layout.addRow(qt.QLabel(f"{self.custom_abc_title} type"), self.selector) 
+        top_level_layout.addRow(qt.QLabel(f"{self.custom_abc_title} options"), self.forms) 
+
+        # Connect combo box to setting the widget. Assumes indices match
+        self.selector.currentIndexChanged.connect(self._on_index_changed)
+
+        # ---- Configure selector behavior ----
+
+        # Select UniformWater as the default
+        self.forms.setCurrentIndex(2)
+
+        # ---- Configure UniformTissue editor ----
+
+        uniformtissue_definition_form_widget = self.forms.widget(1)
+
+        # Disable editing the reference material
+        ref_material_line_edit = uniformtissue_definition_form_widget._field_widgets['ref_material']
+        ref_material_line_edit.setEnabled(False)
+
+        # ---- Configure UniformWater editor ----
+
+        uniformwater_definition_form_widget = self.forms.widget(2)
+
+        # Disable editing the reference material
+        ref_material_line_edit = uniformwater_definition_form_widget._field_widgets['ref_material']
+        ref_material_line_edit.setEnabled(False)
+
+
 class OpenLIFUParameterConstraintsWidget(DictTableWidget):
 
     class CreateParameterParameterConstraintDialog(qt.QDialog):

OpenLIFUProtocolConfig/Resources/UI/OpenLIFUProtocolConfig.ui

@@ -274,13 +274,13 @@ OpenLIFUAbstractApodizationMethodDefinitionWidget</string>
            </widget>
           </item>
           <item>
-           <widget class="QWidget" name="segmentationMethodDefinitionWidgetPlaceholder" native="true">
+           <widget class="QWidget" name="abstractSegmentationMethodDefinitionWidgetPlaceholder" native="true">
             <layout class="QVBoxLayout" name="verticalLayout_13">
              <item>
-              <widget class="QLabel" name="segmentationMethodDefinitionWidgetPlaceholderLabel">
+              <widget class="QLabel" name="abstractSegmentationMethodDefinitionWidgetPlaceholderLabel">
                <property name="text">
                 <string>Placeholder for an
-OpenLIFUSegmentationMethodDefinitionWidget</string>
+OpenLIFUAbstractSegmentationMethodDefinitionWidget</string>
                </property>
               </widget>
              </item>