Refactor ROI management to delegate colour, visibility, and alpha to SpectrumROI (#2340)

Author: samtygier-stfc

mantidimaging/gui/windows/spectrum_viewer/spectrum_widget.py

@@ -89,6 +89,15 @@ def colour(self) -> tuple[int, int, int, int]:
     def colour(self, colour: tuple[int, int, int, int]) -> None:
         self._colour = colour
         self.setPen(self._colour)
+        self.hoverPen = mkPen(self._colour, width=3)
+
+    def set_visibility(self, visible: bool) -> None:
+        """
+        Set the visibility of the ROI and its handles.
+        """
+        self.setVisible(visible)
+        for handle in self.getHandles():
+            handle.setVisible(visible)
 
     @property
     def selected_row(self) -> int | None:
@@ -166,12 +175,8 @@ def colour_generator(self) -> tuple[int, int, int, int]:
     def change_roi_colour(self, name: str, colour: tuple[int, int, int, int]) -> None:
         """
         Change the colour of an existing ROI
-
-        @param name: The name of the ROI.
-        @param colour: The new colour of the ROI.
         """
         self.roi_dict[name].colour = colour
-        self.roi_dict[name].setPen(self.roi_dict[name].colour)
 
     def set_roi_visibility_flags(self, name: str, visible: bool) -> None:
         """
@@ -181,19 +186,14 @@ def set_roi_visibility_flags(self, name: str, visible: bool) -> None:
         @param name: The name of the ROI.
         @param visible: The new visibility of the ROI.
         """
-        handles = self.roi_dict[name].getHandles()
-        for handle in handles:
-            handle.setVisible(visible)
-        self.roi_dict[name].setVisible(visible)
+        self.roi_dict[name].set_visibility(visible)
 
     def set_roi_alpha(self, name: str, alpha: float) -> None:
         """
         Change the alpha value of an existing ROI
-
         @param name: The name of the ROI.
         @param alpha: The new alpha value of the ROI.
         """
-
         self.roi_dict[name].colour = self.roi_dict[name].colour[:3] + (alpha, )
         self.roi_dict[name].setPen(self.roi_dict[name].colour)
         self.roi_dict[name].hoverPen = mkPen(self.roi_dict[name].colour, width=3)
@@ -271,7 +271,7 @@ def rename_roi(self, old_name: str, new_name: str) -> None:
 class CustomViewBox(ViewBox):
 
     def __init__(self, *args, **kwds) -> None:
-        #kwds['enableMenu'] = False
+        # kwds['enableMenu'] = False
         ViewBox.__init__(self, *args, **kwds)
         self.setMouseMode(self.PanMode)
 

mantidimaging/gui/windows/spectrum_viewer/test/spectrum_test.py

@@ -90,7 +90,7 @@ def test_WHEN_set_roi_visibility_flags_called_THEN_roi_Visibility_flags_toggled(
         self.spectrum_widget.set_roi_visibility_flags(name, alpha)
         self.assertEqual(bool(alpha), self.spectrum_widget.roi_dict[name].isVisible())
 
-    @parameterized.expand([("Visible", "visible_roi", 1), ("Invisible", "invisible_roi", 0)])
+    @parameterized.expand([("Visible", "visible_roi", 255), ("Invisible", "invisible_roi", 0)])
     def test_WHEN_set_roi_alpha_called_THEN_roi_alpha_updated(self, _, name, alpha):
         spectrum_roi = SpectrumROI(name, self.sensible_roi, rotatable=False, scaleSnap=True, translateSnap=True)
         self.spectrum_widget.roi_dict[name] = spectrum_roi