bec-widgets 0.115.0__tar.gz → 0.117.0__tar.gz

{bec_widgets-0.115.0 → bec_widgets-0.117.0}/CHANGELOG.md

@@ -1,6 +1,37 @@
 # CHANGELOG
 
 
+## v0.117.0 (2024-10-11)
+
+### Features
+
+* feat(utils): FPS counter utility based on the viewBox updates, integrated to waveform and image widget ([`8c5ef26`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8c5ef268430d5243ac05fcbbdb6b76ad24ac5735))
+
+### Unknown
+
+* tests(plot_base): tests extended ([`8dc892d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/8dc892df0a47ccbdd812555b7c5775a455a23ede))
+
+
+## v0.116.0 (2024-10-11)
+
+### Build System
+
+* build: fix PySide6 to 6.7.2 ([`908dbc1`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/908dbc1760da5b323722207163f00850b84fb90b))
+
+### Features
+
+* feat: UI changes to have top toolbar with compact popup widgets (fix issue #360) ([`499b6b9`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/499b6b9a12efd931b5728b519404c41a7e29e4d6))
+
+* feat: adapt BECQueue and BECStatusBox widgets to use CompactPopupWidget ([`94ce92f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/94ce92f5b054d25ea3bb7976c1f75e14b78b9edc))
+
+* feat: add 'CompactPopupWidget' container widget
+
+Makes it easy to write widgets which can have a compact
+representation with LED-like global state indicator,
+with the possibility to display a popup dialog with more
+complete UI ([`49268e3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/49268e3829406d70b09e4d88989812f5578e46f4))
+
+
 ## v0.115.0 (2024-10-08)
 
 ### Features
@@ -143,31 +174,3 @@ Fixes #361, do not try to change x axis when not permitted ([`efa2763`](https://
 ### Features
 
 * feat(progressbar): added bec progressbar ([`f6d1d0b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f6d1d0bbe3ba30a3b7291cd36a1f7f8e6bd5b895))
-
-* feat(generate_cli): added support for property and qproperty setter ([`a52182d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a52182dca978833bfc3fad755c596d3a2ef45c42))
-
-
-## v0.107.0 (2024-09-06)
-
-### Documentation
-
-* docs: extend waveform docs ([`e6976dc`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e6976dc15105209852090a00a97b7cda723142e9))
-
-### Features
-
-* feat: add roi select for dap, allow automatic clear curves on plot request ([`7bdca84`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7bdca8431496fe6562d2c28f5a6af869d1a2e654))
-
-### Refactoring
-
-* refactor: change style to bec_accent_colors ([`bd126dd`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/bd126dddbbec3e6c448cce263433d328d577c5c0))
-
-### Testing
-
-* test: add tests, including extension to end-2-end test ([`b1aff6d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b1aff6d791ff847eb2f628e66ccaa4672fdeea08))
-
-
-## v0.106.0 (2024-09-05)
-
-### Features
-
-* feat(plot_base): toggle to switch outer axes for plotting widgets ([`06d7741`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/06d7741622aea8556208cd17cae521c37333f8b6))

{bec_widgets-0.115.0 → bec_widgets-0.117.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 0.115.0
+Version: 0.117.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets
@@ -32,4 +32,4 @@ Provides-Extra: pyqt6
 Requires-Dist: pyqt6-webengine>=6.7; extra == 'pyqt6'
 Requires-Dist: pyqt6>=6.7; extra == 'pyqt6'
 Provides-Extra: pyside6
-Requires-Dist: pyside6>=6.7; extra == 'pyside6'
+Requires-Dist: pyside6~=6.7.2; extra == 'pyside6'

{bec_widgets-0.115.0 → bec_widgets-0.117.0}/bec_widgets/applications/alignment/alignment_1d/alignment_1d.ui

@@ -15,47 +15,65 @@
   </property>
   <layout class="QVBoxLayout" name="verticalLayout">
    <item>
-    <layout class="QHBoxLayout" name="horizontalLayout_3" stretch="0,0,0,0,0,1">
+    <layout class="QHBoxLayout" name="horizontalLayout_3" stretch="0,0,0,0,0,0,0,0,0,0,1">
      <item>
       <widget class="DarkModeButton" name="dark_mode_button"/>
      </item>
      <item>
-      <widget class="QRadioButton" name="radioButton_2">
-       <property name="enabled">
-        <bool>false</bool>
-       </property>
-       <property name="text">
-        <string>BEC Server State</string>
+      <spacer name="horizontalSpacer_6">
+       <property name="orientation">
+        <enum>Qt::Orientation::Horizontal</enum>
        </property>
-       <property name="checkable">
-        <bool>true</bool>
+       <property name="sizeHint" stdset="0">
+        <size>
+         <width>40</width>
+         <height>20</height>
+        </size>
        </property>
-       <property name="checked">
+      </spacer>
+     </item>
+     <item>
+      <widget class="BECStatusBox" name="bec_status_box">
+       <property name="compact" stdset="0">
         <bool>true</bool>
        </property>
-       <property name="autoExclusive">
-        <bool>false</bool>
+       <property name="label" stdset="0">
+        <string>BEC Servers</string>
        </property>
       </widget>
      </item>
      <item>
-      <widget class="QRadioButton" name="radioButton_4">
-       <property name="enabled">
-        <bool>false</bool>
+      <spacer name="horizontalSpacer_4">
+       <property name="orientation">
+        <enum>Qt::Orientation::Horizontal</enum>
        </property>
-       <property name="text">
-        <string>BEC Queue</string>
+       <property name="sizeHint" stdset="0">
+        <size>
+         <width>40</width>
+         <height>20</height>
+        </size>
        </property>
-       <property name="checkable">
+      </spacer>
+     </item>
+     <item>
+      <widget class="BECQueue" name="bec_queue">
+       <property name="compact" stdset="0">
         <bool>true</bool>
        </property>
-       <property name="checked">
-        <bool>true</bool>
+      </widget>
+     </item>
+     <item>
+      <spacer name="horizontalSpacer_3">
+       <property name="orientation">
+        <enum>Qt::Orientation::Horizontal</enum>
        </property>
-       <property name="autoExclusive">
-        <bool>false</bool>
+       <property name="sizeHint" stdset="0">
+        <size>
+         <width>40</width>
+         <height>20</height>
+        </size>
        </property>
-      </widget>
+      </spacer>
      </item>
      <item>
       <widget class="QRadioButton" name="radioButton">
@@ -76,6 +94,19 @@
        </property>
       </widget>
      </item>
+     <item>
+      <spacer name="horizontalSpacer_5">
+       <property name="orientation">
+        <enum>Qt::Orientation::Horizontal</enum>
+       </property>
+       <property name="sizeHint" stdset="0">
+        <size>
+         <width>40</width>
+         <height>20</height>
+        </size>
+       </property>
+      </spacer>
+     </item>
      <item>
       <widget class="QRadioButton" name="radioButton_3">
        <property name="enabled">
@@ -95,6 +126,19 @@
        </property>
       </widget>
      </item>
+     <item>
+      <spacer name="horizontalSpacer_7">
+       <property name="orientation">
+        <enum>Qt::Orientation::Horizontal</enum>
+       </property>
+       <property name="sizeHint" stdset="0">
+        <size>
+         <width>40</width>
+         <height>20</height>
+        </size>
+       </property>
+      </spacer>
+     </item>
      <item>
       <widget class="StopButton" name="stop_button">
        <property name="sizePolicy">
@@ -652,14 +696,19 @@
  </widget>
  <customwidgets>
   <customwidget>
-   <class>DapComboBox</class>
+   <class>ToggleSwitch</class>
    <extends>QWidget</extends>
-   <header>dap_combo_box</header>
+   <header>toggle_switch</header>
   </customwidget>
   <customwidget>
-   <class>StopButton</class>
+   <class>BECWaveformWidget</class>
    <extends>QWidget</extends>
-   <header>stop_button</header>
+   <header>bec_waveform_widget</header>
+  </customwidget>
+  <customwidget>
+   <class>BECStatusBox</class>
+   <extends>QWidget</extends>
+   <header>bec_status_box</header>
   </customwidget>
   <customwidget>
    <class>WebsiteWidget</class>
@@ -667,44 +716,49 @@
    <header>website_widget</header>
   </customwidget>
   <customwidget>
-   <class>ScanControl</class>
+   <class>StopButton</class>
    <extends>QWidget</extends>
-   <header>scan_control</header>
+   <header>stop_button</header>
   </customwidget>
   <customwidget>
-   <class>ToggleSwitch</class>
+   <class>LMFitDialog</class>
    <extends>QWidget</extends>
-   <header>toggle_switch</header>
+   <header>lm_fit_dialog</header>
   </customwidget>
   <customwidget>
-   <class>PositionerBox</class>
+   <class>ScanControl</class>
    <extends>QWidget</extends>
-   <header>positioner_box</header>
+   <header>scan_control</header>
+  </customwidget>
+  <customwidget>
+   <class>BECQueue</class>
+   <extends>QWidget</extends>
+   <header>bec_queue</header>
   </customwidget>
   <customwidget>
    <class>BECProgressBar</class>
    <extends>QWidget</extends>
    <header>bec_progress_bar</header>
   </customwidget>
+  <customwidget>
+   <class>DeviceComboBox</class>
+   <extends>QComboBox</extends>
+   <header>device_combobox</header>
+  </customwidget>
   <customwidget>
    <class>DarkModeButton</class>
    <extends>QWidget</extends>
    <header>dark_mode_button</header>
   </customwidget>
   <customwidget>
-   <class>BECWaveformWidget</class>
+   <class>DapComboBox</class>
    <extends>QWidget</extends>
-   <header>bec_waveform_widget</header>
-  </customwidget>
-  <customwidget>
-   <class>DeviceComboBox</class>
-   <extends>QComboBox</extends>
-   <header>device_combobox</header>
+   <header>dap_combo_box</header>
   </customwidget>
   <customwidget>
-   <class>LMFitDialog</class>
+   <class>PositionerBox</class>
    <extends>QWidget</extends>
-   <header>lm_fit_dialog</header>
+   <header>positioner_box</header>
   </customwidget>
  </customwidgets>
  <tabstops>

{bec_widgets-0.115.0 → bec_widgets-0.117.0}/bec_widgets/cli/client.py

@@ -1135,6 +1135,15 @@ class BECImageShow(RPCBase):
             y(bool): Show grid on the y-axis.
         """
 
+    @rpc_call
+    def enable_fps_monitor(self, enable: "bool" = True):
+        """
+        Enable the FPS monitor.
+
+        Args:
+            enable(bool): True to enable, False to disable.
+        """
+
     @rpc_call
     def lock_aspect_ratio(self, lock):
         """
@@ -1330,6 +1339,15 @@ class BECImageWidget(RPCBase):
             y_grid(bool): Visibility of the y-axis grid.
         """
 
+    @rpc_call
+    def enable_fps_monitor(self, enabled: "bool"):
+        """
+        Enable the FPS monitor of the plot widget.
+
+        Args:
+            enabled(bool): If True, enable the FPS monitor.
+        """
+
     @rpc_call
     def lock_aspect_ratio(self, lock: "bool"):
         """
@@ -1666,6 +1684,15 @@ class BECPlotBase(RPCBase):
             show(bool): Show the outer axes.
         """
 
+    @rpc_call
+    def enable_fps_monitor(self, enable: "bool" = True):
+        """
+        Enable the FPS monitor.
+
+        Args:
+            enable(bool): True to enable, False to disable.
+        """
+
     @rpc_call
     def lock_aspect_ratio(self, lock):
         """
@@ -2069,6 +2096,15 @@ class BECWaveform(RPCBase):
             colormap(str, optional): Scale the colors of curves to colormap. If None, use the default color palette.
         """
 
+    @rpc_call
+    def enable_fps_monitor(self, enable: "bool" = True):
+        """
+        Enable the FPS monitor.
+
+        Args:
+            enable(bool): True to enable, False to disable.
+        """
+
     @rpc_call
     def lock_aspect_ratio(self, lock):
         """
@@ -2374,6 +2410,15 @@ class BECWaveformWidget(RPCBase):
             y_grid(bool): Visibility of the y-axis grid.
         """
 
+    @rpc_call
+    def enable_fps_monitor(self, enabled: "bool"):
+        """
+        Enable the FPS monitor of the plot widget.
+
+        Args:
+            enabled(bool): If True, enable the FPS monitor.
+        """
+
     @rpc_call
     def lock_aspect_ratio(self, lock: "bool"):
         """

bec_widgets-0.117.0/bec_widgets/qt_utils/compact_popup.py

@@ -0,0 +1,223 @@
+from types import SimpleNamespace
+
+from bec_qthemes import material_icon
+from qtpy.QtCore import Property, Qt
+from qtpy.QtGui import QColor
+from qtpy.QtWidgets import (
+    QDialog,
+    QHBoxLayout,
+    QLabel,
+    QPushButton,
+    QSizePolicy,
+    QVBoxLayout,
+    QWidget,
+)
+
+from bec_widgets.utils.colors import get_accent_colors
+
+
+class LedLabel(QLabel):
+    success_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.145, y1:0.16, x2:1, y2:1, stop:0 %s, stop:1 %s);"
+    emergency_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.145, y1:0.16, x2:0.92, y2:0.988636, stop:0 %s, stop:1 %s);"
+    warning_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.232, y1:0.272, x2:0.98, y2:0.959773, stop:0 %s, stop:1 %s);"
+    default_led = "color: white;border-radius: 10;background-color: qlineargradient(spread:pad, x1:0.04, y1:0.0565909, x2:0.799, y2:0.795, stop:0 %s, stop:1 %s);"
+
+    def __init__(self, parent=None):
+        super().__init__(parent)
+
+        self.palette = get_accent_colors()
+        if self.palette is None:
+            # no theme!
+            self.palette = SimpleNamespace(
+                default=QColor("blue"),
+                success=QColor("green"),
+                warning=QColor("orange"),
+                emergency=QColor("red"),
+            )
+        self.setState("default")
+        self.setFixedSize(20, 20)
+
+    def setState(self, state: str):
+        match state:
+            case "success":
+                r, g, b, a = self.palette.success.getRgb()
+                self.setStyleSheet(
+                    LedLabel.success_led
+                    % (
+                        f"rgba({r},{g},{b},{a})",
+                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
+                    )
+                )
+            case "default":
+                r, g, b, a = self.palette.default.getRgb()
+                self.setStyleSheet(
+                    LedLabel.default_led
+                    % (
+                        f"rgba({r},{g},{b},{a})",
+                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
+                    )
+                )
+            case "warning":
+                r, g, b, a = self.palette.warning.getRgb()
+                self.setStyleSheet(
+                    LedLabel.warning_led
+                    % (
+                        f"rgba({r},{g},{b},{a})",
+                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
+                    )
+                )
+            case "emergency":
+                r, g, b, a = self.palette.emergency.getRgb()
+                self.setStyleSheet(
+                    LedLabel.emergency_led
+                    % (
+                        f"rgba({r},{g},{b},{a})",
+                        f"rgba({int(r*0.8)},{int(g*0.8)},{int(b*0.8)},{a})",
+                    )
+                )
+            case unknown_state:
+                raise ValueError(
+                    f"Unknown state {repr(unknown_state)}, must be one of default, success, warning or emergency"
+                )
+
+
+class PopupDialog(QDialog):
+    def __init__(self, content_widget):
+        self.parent = content_widget.parent()
+        self.content_widget = content_widget
+
+        super().__init__(self.parent)
+
+        self.setAttribute(Qt.WA_DeleteOnClose)
+
+        self.content_widget.setParent(self)
+        QVBoxLayout(self)
+        self.layout().addWidget(self.content_widget)
+        self.content_widget.setVisible(True)
+
+    def closeEvent(self, event):
+        self.content_widget.setVisible(False)
+        self.content_widget.setParent(self.parent)
+
+
+class CompactPopupWidget(QWidget):
+    """Container widget, that can display its content or have a compact form,
+    in this case clicking on a small button pops the contained widget up.
+
+    In the compact form, a LED-like indicator shows a status indicator.
+    """
+
+    def __init__(self, parent=None, layout=QVBoxLayout):
+        super().__init__(parent)
+
+        self._popup_window = None
+
+        QVBoxLayout(self)
+        self.compact_view = QWidget(self)
+        self.compact_view.setSizePolicy(QSizePolicy.Fixed, QSizePolicy.Fixed)
+        QHBoxLayout(self.compact_view)
+        self.compact_view.layout().setSpacing(0)
+        self.compact_view.layout().setContentsMargins(0, 0, 0, 0)
+        self.compact_label = QLabel(self.compact_view)
+        self.compact_status = LedLabel(self.compact_view)
+        self.compact_show_popup = QPushButton(self.compact_view)
+        self.compact_show_popup.setFlat(True)
+        self.compact_show_popup.setIcon(
+            material_icon(icon_name="pan_zoom", size=(10, 10), convert_to_pixmap=False)
+        )
+        self.compact_view.layout().addWidget(self.compact_label)
+        self.compact_view.layout().addWidget(self.compact_status)
+        self.compact_view.layout().addWidget(self.compact_show_popup)
+        self.compact_view.setVisible(False)
+        self.layout().addWidget(self.compact_view)
+        self.container = QWidget(self)
+        self.layout().addWidget(self.container)
+        self.container.setVisible(True)
+        layout(self.container)
+        self.layout = self.container.layout()
+
+        self.compact_show_popup.clicked.connect(self.show_popup)
+
+    def set_global_state(self, state: str):
+        """Set the LED-indicator state
+
+        The LED indicator represents the 'global' state. State can be one of the
+        following: "default", "success", "warning", "emergency"
+        """
+        self.compact_status.setState(state)
+
+    def show_popup(self):
+        """Display the contained widgets in a popup dialog"""
+        self._popup_window = PopupDialog(self.container)
+        self._popup_window.show()
+
+    def setSizePolicy(self, size_policy1, size_policy2=None):
+        # setting size policy on the compact popup widget will set
+        # the policy for the container, and for itself
+        if size_policy2 is None:
+            # assuming first form: setSizePolicy(QSizePolicy)
+            self.container.setSizePolicy(size_policy1)
+            QWidget.setSizePolicy(self, size_policy1)
+        else:
+            self.container.setSizePolicy(size_policy1, size_policy2)
+            QWidget.setSizePolicy(self, size_policy1, size_policy2)
+
+    def addWidget(self, widget):
+        """Add a widget to the popup container
+
+        The popup container corresponds to the "full view" (not compact)
+        The widget is reparented to the container, and added to the container layout
+        """
+        widget.setParent(self.container)
+        self.container.layout().addWidget(widget)
+
+    @Property(bool)
+    def compact(self):
+        return self.compact_view.isVisible()
+
+    @compact.setter
+    def compact(self, set_compact: bool):
+        """Sets the compact form
+
+        If set_compact is True, the compact view is displayed ; otherwise,
+        the full view is displayed. This is handled by toggling visibility of
+        the container widget or the compact view widget.
+        """
+        if set_compact:
+            self.compact_view.setVisible(True)
+            self.container.setVisible(False)
+            QWidget.setSizePolicy(self, QSizePolicy.Fixed, QSizePolicy.Fixed)
+        else:
+            self.compact_view.setVisible(False)
+            self.container.setVisible(True)
+            QWidget.setSizePolicy(self, self.container.sizePolicy())
+        if self.parentWidget():
+            self.parentWidget().adjustSize()
+        else:
+            self.adjustSize()
+
+    @Property(str)
+    def label(self):
+        return self.compact_label.text()
+
+    @label.setter
+    def label(self, compact_label_text: str):
+        """Set the label text associated to the compact view"""
+        self.compact_label.setText(compact_label_text)
+
+    @Property(str)
+    def tooltip(self):
+        return self.compact_label.toolTip()
+
+    @tooltip.setter
+    def tooltip(self, tooltip: str):
+        """Set the tooltip text associated to the compact view"""
+        self.compact_label.setToolTip(tooltip)
+        self.compact_status.setToolTip(tooltip)
+
+    def closeEvent(self, event):
+        # Called by Qt, on closing - since the children widgets can be
+        # BECWidgets, it is good to explicitely call 'close' on them,
+        # to ensure proper resources cleanup
+        for child in self.container.findChildren(QWidget, options=Qt.FindDirectChildrenOnly):
+            child.close()

bec_widgets-0.117.0/bec_widgets/utils/fps_counter.py

@@ -0,0 +1,84 @@
+"""
+This module provides a utility class for counting and reporting frames per second (FPS) in a PyQtGraph application.
+
+Classes:
+    FPSCounter: A class that monitors the paint events of a `ViewBox` to calculate and emit FPS values.
+
+Usage:
+    The `FPSCounter` class can be used to monitor the rendering performance of a `ViewBox` in a PyQtGraph application.
+    It connects to the `ViewBox`'s paint event and calculates the FPS over a specified interval, emitting the FPS value
+    at regular intervals.
+
+Example:
+    from qtpy import QtWidgets, QtCore
+    import pyqtgraph as pg
+    from fps_counter import FPSCounter
+
+    app = pg.mkQApp("FPS Counter Example")
+    win = pg.GraphicsLayoutWidget()
+    win.show()
+
+    vb = pg.ViewBox()
+    plot_item = pg.PlotItem(viewBox=vb)
+    win.addItem(plot_item)
+
+    fps_counter = FPSCounter(vb)
+    fps_counter.sigFpsUpdate.connect(lambda fps: print(f"FPS: {fps:.2f}"))
+
+    sys.exit(app.exec_())
+"""
+
+from time import perf_counter
+
+import pyqtgraph as pg
+from qtpy import QtCore
+
+
+class FPSCounter(QtCore.QObject):
+    """
+    A utility class for counting and reporting frames per second (FPS).
+
+    This class connects to a `ViewBox`'s paint event to count the number of
+    frames rendered and calculates the FPS over a specified interval. It emits
+    a signal with the FPS value at regular intervals.
+
+    Attributes:
+        sigFpsUpdate (QtCore.Signal): Signal emitted with the FPS value.
+        view_box (pg.ViewBox): The `ViewBox` instance to monitor.
+    """
+
+    sigFpsUpdate = QtCore.Signal(float)
+
+    def __init__(self, view_box):
+        super().__init__()
+        self.view_box = view_box
+        self.view_box.sigPaint.connect(self.increment_count)
+        self.count = 0
+        self.last_update = perf_counter()
+        self.timer = QtCore.QTimer()
+        self.timer.timeout.connect(self.calculate_fps)
+        self.timer.start(1000)
+
+    def increment_count(self):
+        """
+        Increment the frame count when the `ViewBox` is painted.
+        """
+        self.count += 1
+
+    def calculate_fps(self):
+        """
+        Calculate the frames per second (FPS) based on the number of frames
+        """
+        now = perf_counter()
+        elapsed = now - self.last_update
+        fps = self.count / elapsed if elapsed > 0 else 0.0
+        self.last_update = now
+        self.count = 0
+        self.sigFpsUpdate.emit(fps)
+
+    def cleanup(self):
+        """
+        Clean up the FPS counter by stopping the timer and disconnecting the signal.
+        """
+        self.timer.stop()
+        self.timer.timeout.disconnect(self.calculate_fps)