Speed up mask highlighting

Signed-off-by: Brianna Major <[email protected]>

Author: bnmajor

hexrdgui/hexrd_config.py

@@ -1079,7 +1079,7 @@ def create_raw_masks_dict(self, images_dict, display=False):
                     # Only apply visible masks for display
                     continue
 
-                if not mask.visible and not mask.show_border and not mask.highlight:
+                if not mask.visible and not mask.show_border:
                     # This mask should not be applied at all.
                     continue
 

hexrdgui/image_canvas.py

@@ -122,6 +122,10 @@ def setup_connections(self):
         HexrdConfig().oscillation_stage_changed.connect(
             self.oscillation_stage_changed)
         MaskManager().polar_masks_changed.connect(self.polar_masks_changed)
+        # Update mask highlights without re-running expensive mask logic
+        MaskManager().mask_highlights_changed.connect(
+            self.mask_highlights_changed
+        )
         HexrdConfig().overlay_renamed.connect(self.overlay_renamed)
         HexrdConfig().azimuthal_options_modified.connect(
             self.update_azimuthal_integral_plot)
@@ -1599,6 +1603,21 @@ def is_stereo_from_polar(self):
             self.iviewer.project_from_polar
         )
 
+    def mask_highlights_changed(self):
+        if not self.iviewer:
+            return
+
+        if self.mode == ViewType.raw:
+            self.clear_mask_highlights()
+            for det_name, ax in self.raw_axes.items():
+                self.highlight_masks(ax, det_name)
+            self.draw_idle()
+            return
+
+        if self.mode in (ViewType.polar, ViewType.stereo):
+            self.update_mask_highlights(self.axis)
+            self.draw_idle()
+
     def polar_masks_changed(self):
         skip = (
             not self.iviewer or

hexrdgui/masking/mask_manager.py

@@ -31,7 +31,7 @@ def __init__(
         show_border=False,
         mode=None,
         xray_source=None,
-        highlight=False
+        highlight=False,
     ):
         self.type = mtype
         self.visible = visible
@@ -232,6 +232,11 @@ def data(self, values):
     def highlight(self):
         return False
 
+    @highlight.setter
+    def highlight(self, value):
+        # Threshold masks do not support highlight; ignore assignments
+        pass
+
     def update_masked_arrays(self, view=ViewType.raw):
         self.masked_arrays = recompute_raw_threshold_mask()
 
@@ -284,6 +289,9 @@ class MaskManager(QObject, metaclass=QSingleton):
     """
     export_masks_to_file = Signal(dict)
 
+    """Emitted when mask highlight states change"""
+    mask_highlights_changed = Signal()
+
     def __init__(self):
         super().__init__(None)
         self.masks = {}
@@ -361,6 +369,9 @@ def view_mode_changed(self, mode):
         self.view_mode = mode
         self.update_masks_for_active_beam()
 
+    def highlights_changed(self):
+        self.mask_highlights_changed.emit()
+
     def masks_changed(self):
         if self.view_mode in (ViewType.polar, ViewType.stereo):
             self.polar_masks_changed.emit()

hexrdgui/masking/mask_manager_dialog.py

@@ -433,7 +433,7 @@ def selected_changed(self):
                 if not hasattr(self, '_mask_highlight_update_timer'):
                     timer = QTimer()
                     timer.setSingleShot(True)
-                    timer.timeout.connect(MaskManager().masks_changed)
+                    timer.timeout.connect(MaskManager().highlights_changed)
                     self._mask_highlight_update_timer = timer
                 self._mask_highlight_update_timer.start(100)