Add alignment gui 1d v1

Description

This MR adds a first draft for the alignment GUI. It is a preliminary version of the GUI which is not yet fully functional and can produce popup errors. Those are mostly link to its usage with its components which we will tackle in refactoring of the individual components. For the moment, I suggest to merge it and tackle the refactoring in separate MRs. A list of toDos will be added below.

Related Issues

relates to #350, #349 (closed), #348 (closed), #322 (closed), #323 (closed), #329 (closed)

Type of Change

• added plot_indicator_items (BECArrowItem and BECTickItem). They can be used to visualise the position of for instance a motor. The TickItem is attached to the layout and plotted below the Axis of the WaveformWidget, while the ArrowItem is attached to the plot_item allowing to follow the 1D curve or in future point to a specific pixel in the 2D plot. They consider log scale (note: the arrowItem is a bit off when moved to negative x values. There is a manual fix with the ViewBox.)
• added a button to the LMFitDialog that emits a signal with the parameter value of the fit. This can be hooked up to move the motor to the center position of the fit
• improves the linear region selector to consider logarithmic axis

Screenshots / GIFs (if applicable)

Plot Indicators:

Screen_Recording_2024-09-11_at_20.09.01

The full app is best tested with this branch. The recording was too large. Be aware, there are 3 prompt errors upon starting due to the filters in the comboboxes, and one more error if you change the motor. This is to be tackled via separate MRs.

Additional Comments

ToDo list for future improvements of the GUI:

• refactoring of filters for BECDeviceBox. Changing the filter after stating the GUI is generating errors because the currentTextChanged signal is already hooked up to adding a plot to the BECWaveformWidget. This creates issues since we cycle through devices that cannot be plotted, i.e. have no hinted signals/ no signals of type kind.normal/hinted at all. relates to these two issues #323 (closed) #322 (closed) #329 (closed)
• Related to the above, the logic for accepting device plot (scan_segment) and dap plots may be improved. Even with properly set filters, I would currently face the issue that I could change the x axis while a DAP process is still added with a different axis. This creates a popup error and removes the DAP. An easier logic to add/remove curves is desired and discussed in more detail, related issue is created (#349 (closed))
• Refactor of positioner_box to facilitate a more flexible arrangement of its components (#348 (closed) )
• Review LMFitDialog. A button has been added to the ListWidget for each parameter that can be hooked up to an action. This logic should be reviewed and optimised. Maybe we can generalise this even. (#350)

Definition of Done

• Documentation is up-to-date.

bec_widgets/widgets/lmfit_dialog/lmfit_dialog.py

@@ -3,7 +3,7 @@ import os
 from bec_lib.endpoints import MessageEndpoints
 from bec_lib.logger import bec_logger
 from qtpy.QtCore import Property, Signal, Slot
-from qtpy.QtWidgets import QTreeWidgetItem, QVBoxLayout, QWidget
+from qtpy.QtWidgets import QPushButton, QTreeWidgetItem, QVBoxLayout, QWidget
 
 from bec_widgets.utils import UILoader
 from bec_widgets.utils.bec_widget import BECWidget
@@ -15,7 +15,10 @@ class LMFitDialog(BECWidget, QWidget):
     """Dialog for displaying the fit summary and params for LMFit DAP processes"""
 
     ICON_NAME = "monitoring"
+    # Signal to emit the currently selected fit curve_id
     selected_fit = Signal(str)
+    # Signal to emit a position to move to.
+    move_to_position = Signal(float)
 
     def __init__(
         self,
@@ -49,9 +52,66 @@ class LMFitDialog(BECWidget, QWidget):
         self.summary_data = {}
         self._fit_curve_id = None
         self._deci_precision = 3
+        self._always_show_latest = False
+        self._activated_buttons_for_move_action = []
         self.ui.curve_list.currentItemChanged.connect(self.display_fit_details)
         self.layout.setContentsMargins(0, 0, 0, 0)
         self.setLayout(self.layout)
+        self._enable_move_to_buttons = False
+        self._move_buttons = []
+
+    @Property(bool)
+    def enable_move_to_buttons(self):
+        """Property to enable the move to buttons."""
+        return self._enable_move_to_buttons
+
+    @enable_move_to_buttons.setter
+    def enable_move_to_buttons(self, enable: bool):
+        self._enable_move_to_buttons = enable
+        for button in self._move_buttons:
+            if button.text().split(" ")[-1] in self.activated_buttons_for_move_action:
+                button.setEnabled(enable)
+
+    @Slot(bool)
+    def set_enable_move_to_buttons(self, enable: bool):
+        """Slot to enable the move to buttons.
+
+        Args:
+            enable (bool): Whether to enable the move to buttons.
+        """
+        self.enable_move_to_buttons = enable
+
+    @Property(list)
+    def activated_buttons_for_move_action(self) -> list:
+        """Property for the buttons that should be activated for the move action in the parameter list."""
+        return self._activated_buttons_for_move_action
+
+    @activated_buttons_for_move_action.setter
+    def activated_buttons_for_move_action(self, buttons: list):
+        """Setter for the buttons that should be activated for the move action.
+
+        Args:
+            buttons (list): The buttons that should be activated for the move action.
+        """
+        self._activated_buttons_for_move_action = buttons
+
+    @Slot(list)
+    def update_activated_button_list(self, names: list) -> None:
+        """Update the list of activated buttons for the move action.
+
+        Args:
+            names (list): List of button names to be activated.
+        """
+        self.activated_buttons_for_move_action = names
+
+    @Property(bool)
+    def always_show_latest(self):
+        """Property to indicate if always the latest DAP update is displayed."""
+        return self._always_show_latest
+
+    @always_show_latest.setter
+    def always_show_latest(self, show: bool):
+        self._always_show_latest = show
 
     @Property(bool)
     def hide_curve_selection(self):
@@ -67,6 +127,34 @@ class LMFitDialog(BECWidget, QWidget):
         """
         self.ui.group_curve_selection.setVisible(not show)
 
+    @Property(bool)
+    def hide_summary(self):
+        """Property for showing the summary."""
+        return not self.ui.group_summary.isVisible()
+
+    @hide_summary.setter
+    def hide_summary(self, show: bool):
+        """Setter for showing the summary.
+
+        Args:
+            show (bool): Whether to show the summary.
+        """
+        self.ui.group_summary.setVisible(not show)
+
+    @Property(bool)
+    def hide_parameters(self):
+        """Property for showing the parameters."""
+        return not self.ui.group_parameters.isVisible()
+
+    @hide_parameters.setter
+    def hide_parameters(self, show: bool):
+        """Setter for showing the parameters.
+
+        Args:
+            show (bool): Whether to show the parameters.
+        """
+        self.ui.group_parameters.setVisible(not show)
+
     @property
     def fit_curve_id(self):
         """Property for the currently displayed fit curve_id."""
@@ -112,19 +200,34 @@ class LMFitDialog(BECWidget, QWidget):
         curve_id = metadata.get("curve_id", "")
         self.summary_data.update({curve_id: data})
         self.refresh_curve_list()
-        if self.fit_curve_id is None:
+        if self.fit_curve_id is None or self.always_show_latest is True:
             self.fit_curve_id = curve_id
         if curve_id != self.fit_curve_id:
             return
         if data is None:
             return
         self.ui.summary_tree.clear()
+        chi_squared = data.get("chisqr", 0.0)
+        if isinstance(chi_squared, float) or isinstance(chi_squared, int):
+            chi_squared = f"{chi_squared:.{self._deci_precision}f}"
+        else:
+            chi_squared = "None"
+        reduced_chi_squared = data.get("redchi", 0.0)
+        if isinstance(reduced_chi_squared, float) or isinstance(reduced_chi_squared, int):
+            reduced_chi_squared = f"{reduced_chi_squared:.{self._deci_precision}f}"
+        else:
+            reduced_chi_squared = "None"
+        r_squared = data.get("rsquared", 0.0)
+        if isinstance(r_squared, float) or isinstance(r_squared, int):
+            r_squared = f"{r_squared:.{self._deci_precision}f}"
+        else:
+            r_squared = "None"
         properties = [
             ("Model", data.get("model", "")),
             ("Method", data.get("method", "")),
-            ("Chi-Squared", f"{data.get('chisqr', 0.0):.{self._deci_precision}f}"),
-            ("Reduced Chi-Squared", f"{data.get('redchi', 0.0):.{self._deci_precision}f}"),
-            ("R-Squared", f"{data.get('rsquared', 0.0):.{self._deci_precision}f}"),
+            ("Chi-Squared", chi_squared),
+            ("Reduced Chi-Squared", reduced_chi_squared),
+            ("R-Squared", r_squared),
             ("Message", data.get("message", "")),
         ]
         for prop, val in properties:
@@ -149,14 +252,38 @@ class LMFitDialog(BECWidget, QWidget):
         Args:
             params (list): List of LMFit parameters for the fit curve.
         """
+        self._move_buttons = []
         self.ui.param_tree.clear()
         for param in params:
-            param_name, param_value, param_std = (
-                param[0],
-                f"{param[1]:.{self._deci_precision}f}",
-                f"{param[7]:.{self._deci_precision}f}",
-            )
-            QTreeWidgetItem(self.ui.param_tree, [param_name, param_value, param_std])
+            param_name = param[0]
+            param_value = param[1]
+            if isinstance(param_value, float) or isinstance(param_value, int):
+                param_value = f"{param_value:.{self._deci_precision}f}"
+            else:
+                param_value = "None"
+            param_std = param[7]
+            if isinstance(param_std, float) or isinstance(param_std, int):
+                param_std = f"{param_std:.{self._deci_precision}f}"
+            else:
+                param_std = "None"
+            # Create a push button to move the motor to a specific position
+            # Per default, this feature is deactivated
+            widget = QWidget()
+            layout = QVBoxLayout(widget)
+            push_button = QPushButton(f"Move to {param_name}")
+            if param_name in self.activated_buttons_for_move_action:
+                push_button.setEnabled(True)
+                push_button.clicked.connect(
+                    lambda _, value=param[1]: self.move_to_position.emit(float(value))
+                )
+            else:
+                push_button.setEnabled(False)
+            self._move_buttons.append(push_button)
+            layout.addWidget(push_button)
+            layout.setContentsMargins(0, 0, 0, 0)
+
+            tree_item = QTreeWidgetItem(self.ui.param_tree, [param_name, param_value, param_std])
+            self.ui.param_tree.setItemWidget(tree_item, 3, widget)
 
     def populate_curve_list(self):
         """Populate the curve list with the available fit curves."""