bugfixes and plot settings quick access

Author: JoschD

omc3_gui/plotting/tfs_plotter.py

@@ -66,7 +66,7 @@ def plot_dataframes(
         try:
             df[ycolumn]
         except KeyError:
-            LOGGER.debug(f"Could not find column '{ycolumn}' in DataFrame '{name}. Skipping!'")
+            LOGGER.debug(f"Could not find column '{ycolumn}' in DataFrame for '{name}'. Skipping!")
             continue
 
         plot_errorbar(
@@ -101,7 +101,7 @@ def plot_errorbar(
     label: str | None = None,
     color: str | pg.Color | None = None,
     marker: str = 'o', 
-    markersize: int = 10,
+    markersize: int = 6,
     linestyle: PenStyle = PenStyle.SolidLine,
     linewidth: float = 2,
     ) -> tuple[pg.PlotDataItem, pg.ErrorBarItem]:

omc3_gui/segment_by_segment.py

@@ -1,3 +1,28 @@
+""" 
+Segment-by-Segment GUI
+----------------------
+
+Graphical user interface to run the Segment-by-Segment propagation.
+
+
+TODO:
+ 
+ GUI:
+ - Load segments from file or folder (check sbs/sbs_ files)
+ - Save segments to file
+ - Autoload segments when opening measurement folder
+ - Pass measurement folders via cli args.
+
+Settings:
+ - Save settings to json file
+ - Load settings from file
+ - Pass path to settings file as cli arg and load on startup
+
+Plotting:
+ - Going back through plot history on double-click
+
+"""
+
 import sys
 from omc3_gui.segment_by_segment.main_controller import SbSController
 from omc3_gui.utils.log_handler import init_logging

omc3_gui/segment_by_segment/main_controller.py

@@ -48,12 +48,11 @@ class SbSController(Controller):
 
     def __init__(self, settings: Settings | None = None):
         super().__init__(SbSWindow())
-        self.connect_signals()
         self.settings: Settings = settings or Settings()
-        
         self._last_selected_optics_path: Path = self.settings.main.cwd
         self._running_tasks: list[BackgroundThread] = []
 
+        self.connect_signals()
         self.set_measurement_interaction_buttons_enabled(False)
         self.set_all_segment_buttons_enabled(False)
 
@@ -64,6 +63,12 @@ def connect_signals(self):
         # Menu Bar -------------------------------------------------------------
         view.sig_menu_settings.connect(self.show_settings)
 
+        view.add_settings_to_menu(
+            menu="View",
+            settings=self.settings.plotting,
+            hook=partial(self.plot, weak=True),
+        )
+
         # Measurements -------------------------------------------------------------
         view.button_load_measurement.clicked.connect(self.open_measurements)
         view.button_edit_measurement.clicked.connect(self.edit_measurement)
@@ -607,7 +612,7 @@ def run_segments(self, segments: Sequence[SegmentItemModel] | None = None):
             return
 
         all_selected_segment_data: list[SegmentDataModel] = [sdata for s in segments for sdata in s.segments]
-        for measurement in selected_measurements:
+        for idx, measurement in enumerate(selected_measurements):
             # Filter segments that are in the measurement and sort into segments/elements
             selected_segments_in_meas = [s for s in measurement.segments if s in all_selected_segment_data]
             if not selected_segments_in_meas:
@@ -626,41 +631,47 @@ def run_segments(self, segments: Sequence[SegmentItemModel] | None = None):
                 )
 
             def clear_all():
-                """ Clear all segment data, so that the GUI loads the new SbS data. """
+                """ Clear all chached segment data, so that the GUI loads the new SbS data. """
                 for segment in selected_segments_in_meas:
                     segment.data.clear()
 
+                # At the very end, update plots.
+                if idx == len(selected_measurements) - 1:
+                    self.plot()
+
             # Create thread
             measurement_task = BackgroundThread(
                 function=sbs_function,
                 message=f"SbS for {measurement.display()}",
                 on_end_function=clear_all,
             )
 
-            # Run task
-            LOGGER.info(f"Starting {measurement_task.message}")
-            self._add_running_task(task=measurement_task)
-            measurement_task.start()
-            
+            # For Real Use: Run Task ---
+            # LOGGER.info(f"Starting {measurement_task.message}")
+            # self._add_running_task(task=measurement_task)
+            # measurement_task.start()
+
             # For Debugging: Start sbs directly ---
-            # sbs_function()
+            sbs_function()
+            clear_all()
             # -------------------------------------
 
 # Plotting ---------------------------------------------------------------------
-    def plot(self):
+    def plot(self, weak: bool = False):
         """ Trigger a plot update with the currently selected segments. """
         view: SbSWindow = self._view
         settings: PlotSettings = self.settings.plotting
-
-        segments = view.get_selected_segments()
-        if len(segments) != 1:
-            LOGGER.error("Please select exactly one segment to plot.")
-            return
 
         if not settings.forward and not settings.backward:
             LOGGER.error("Please enable at least one propagation method to show.")
             return
 
+        segments = view.get_selected_segments()
+        if len(segments) != 1:
+            if not weak:
+                LOGGER.error("Please select exactly one segment to plot.")
+            return
+
         self.clear_plots()
 
         segments_data: list[SegmentDataModel] = segments[0].segments
@@ -684,5 +695,10 @@ def show_settings(self):
         LOGGER.debug("Showing settings.")
         settings_dialog = SettingsDialog(settings=self.settings)
         if settings_dialog.exec_():
-            self.plot()
+            view: SbSWindow = self._view
+            view.update_menu_settings(
+                menu="View",
+                settings=self.settings.plotting,
+            )
+            self.plot(weak=True)
 

omc3_gui/segment_by_segment/main_view.py

@@ -3,14 +3,12 @@
 -----------------------
 
 This is the main view for the Segment-by-Segment application.
-
-TODO: 
- - Going back through plot history on double-click
-
 """
 # from omc3_gui.segment_by_segment.segment_by_segment_ui import Ui_main_window
 from __future__ import annotations
 
+from dataclasses import fields
+from functools import partial
 import logging
 from collections.abc import Sequence
 
@@ -129,6 +127,59 @@ def _add_menus(self):
         # insert before the last entry (which is "Exit")
         file_menu.insertAction(file_menu.actions()[-1], menu_settings)
 
+    def add_settings_to_menu(self, menu: str, settings: object, names: Sequence[str] | None = None, hook: callable = None):
+        """ Add quick-access checkboxes to the menu which are connected to the respective attributes in settings.
+        
+        Args:
+            menu (str): Main menu name to add the settings to.
+            settings (object): Settings to connect with the menu. Assumes dataclasses.
+            names (Sequence[str] | None): Which fields to connect. All fields need to be boolean.
+            hook (callable | None): Function to call after the settings have been updated.
+
+        """
+        qmenu: QtWidgets.QMenu = self.get_action_by_title(menu)
+        
+        def update_settings(value: bool, name: str):
+            setattr(settings, name, value)
+            if hook is not None:
+                hook()
+
+        for field in fields(settings): 
+            if names is not None and field.name not in names:
+                continue
+
+            if field.name.startswith("_"):
+                continue
+            label = field.metadata.get("label", field.name)
+            entry = QtWidgets.QAction(label, self)
+            entry.setCheckable(True)
+            entry.setChecked(getattr(settings, field.name))
+
+            entry.toggled.connect(partial(update_settings, name=field.name))
+            qmenu.addAction(entry)
+
+    def update_menu_settings(self, menu: str, settings: object, names: Sequence[str] | None = None):
+        """ Update the menu settings. 
+        See :func:`add_settings_to_menu`.
+        
+        Args:
+            menu (str): Main menu name where the settings are located.
+            settings (object): Settings to connected with the menu. Assumes dataclasses.
+            names (Sequence[str] | None): Which fields to connect. All fields need to be boolean.
+        """
+        qmenu: QtWidgets.QMenu = self.get_action_by_title(menu)
+
+        for field in fields(settings): 
+            if names is not None and field.name not in names:
+                continue
+
+            if field.name.startswith("_"):
+                continue
+
+            label = field.metadata.get("label", field.name)
+            entry: QtWidgets.QAction = self.get_action_by_title(label, parent=qmenu)
+            entry.setChecked(getattr(settings, field.name))
+
     def _build_gui(self):
         self._central = QtWidgets.QSplitter(Qt.Horizontal)
 

omc3_gui/segment_by_segment/settings.py

@@ -7,7 +7,7 @@
 from __future__ import annotations
 
 from pathlib import Path
-from dataclasses import dataclass, field
+from dataclasses import dataclass, field, fields
 
 from omc3_gui.ui_components.dataclass_ui import metafield
 
@@ -26,7 +26,6 @@ class PlotSettings:
     backward: bool = metafield("Backward Propagation", "Show backward propagation.", default=True)
     expected: bool = metafield("Expectation", "Show expected value after correction instead of correction itself.", default=False)
 
-
 @dataclass(slots=True)
 class Settings:
     main: MainSettings = field(default_factory=MainSettings)

omc3_gui/ui_components/base_classes_cvm.py

@@ -18,6 +18,7 @@
     QApplication,
     QDesktopWidget,
     QDockWidget,
+    QMenu,
     QMenuBar,
     QStatusBar,
     QStyle,
@@ -136,7 +137,7 @@ def build_menu_bar(self):
         # Set menu bar ---
         self.setMenuBar(self._menu_bar)
 
-    def get_action_by_title(self, title: str, parent: QMenuBar | None = None) -> QAction:
+    def get_action_by_title(self, title: str, parent: QMenuBar | QMenu | None = None) -> QAction | QMenu:
         """ Retrieve a menu action by its title. 
         
         Args:
@@ -152,7 +153,10 @@ def get_action_by_title(self, title: str, parent: QMenuBar | None = None) -> QAc
 
         for action in parent.actions():
             if action.text() == title:
-                return action.menu()
+                menu = action.menu()
+                if menu is not None:  # action is a menu (submenu)
+                    return menu
+                return action  # action is an entry (leaf)
 
         LOGGER.debug(f"Unable to find action with title: {title} in {parent!r}")
         return None