bec-widgets 1.3.3__tar.gz → 1.4.0__tar.gz

bec_widgets-1.4.0/CHANGELOG.md

@@ -0,0 +1,209 @@
+# CHANGELOG
+
+
+## v1.4.0 (2024-11-11)
+
+### Bug Fixes
+
+- **crosshair**: Label of coordinates of TextItem displays numbers in general format
+  ([`11e5937`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/11e5937ae0f3c1413acd4e66878a692ebe4ef7d0))
+
+- **crosshair**: Label of coordinates of TextItem is updated according to the current theme of qapp
+  ([`4f31ea6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f31ea655cf6190e141e6a2720a2d6da517a2b5b))
+
+- **crosshair**: Log is separately scaled for backend logic and for signal emit
+  ([`b2eb71a`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b2eb71aae0b6a7c82158f2d150ae1e31411cfdeb))
+
+### Features
+
+- **crosshair**: Textitem to display crosshair coordinates
+  ([`035136d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/035136d5171ec5f4311d15a9aa5bad2bdbc1f6cb))
+
+### Testing
+
+- **crosshair**: Tests extended
+  ([`64df805`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/64df805a9ed92bb97e580ac3bc0a1bbd2b1cb81e))
+
+
+## v1.3.3 (2024-11-07)
+
+### Bug Fixes
+
+- **scan_control**: Devicelineedit kwargs readings changed to get name of the positioner
+  ([`5fabd4b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5fabd4bea95bafd2352102686357cc1db80813fd))
+
+### Documentation
+
+- Update outdated text in docs
+  ([`4f0693c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f0693cae34b391d75884837e1ae6353a0501868))
+
+
+## v1.3.2 (2024-11-05)
+
+### Bug Fixes
+
+- **plot_base**: Legend text color is changed when changing dark-light theme
+  ([`2304c9f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2304c9f8497c1ab1492f3e6690bb79b0464c0df8))
+
+### Build System
+
+- Pyside6 version fixed 6.7.2
+  ([`c6e48ec`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/c6e48ec1fe5aaee6a7c7a6f930f1520cd439cdb2))
+
+
+## v1.3.1 (2024-10-31)
+
+### Bug Fixes
+
+- **ophyd_kind_util**: Kind enums are imported from the bec widget util class
+  ([`940ee65`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/940ee6552c1ee8d9b4e4a74c62351f2e133ab678))
+
+
+## v1.3.0 (2024-10-30)
+
+### Bug Fixes
+
+- **colors**: Extend color map validation for matplotlib and colorcet maps (if available)
+  ([`14dd8c5`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/14dd8c5b2947c92f6643b888d71975e4e8d4ee88))
+
+### Features
+
+- **colormap_button**: Colormap button with menu to select colormap filtered by the colormap type
+  ([`b039933`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b039933405e2fbe92bd81bd0748e79e8d443a741))
+
+
+## v1.2.0 (2024-10-25)
+
+### Features
+
+- **colors**: Evenly spaced color generation + new golden ratio calculation
+  ([`40c9fea`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/40c9fea35f869ef52e05948dd1989bcd99f602e0))
+
+### Refactoring
+
+- Add bec_lib version to statusbox
+  ([`5d4b86e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5d4b86e1c6e1800051afce4f991153e370767fa6))
+
+
+## v1.1.0 (2024-10-25)
+
+### Features
+
+- Add filter i/o utility class
+  ([`0350833`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0350833f36e0a7cadce4173f9b1d1fbfdf985375))
+
+### Refactoring
+
+- Do not flush selection upon receiving config update; allow widgetIO to receive kwargs to be able
+  to use get_value to receive string instead of int for QComboBox
+  ([`91959e8`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/91959e82de8586934af3ebb5aaa0923930effc51))
+
+- Allow to set selection in DeviceInput; automatic update of selection on device config update;
+  cleanup
+  ([`5eb15b7`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/5eb15b785f12e30eb8ccbc56d4ad9e759a4cf5eb))
+
+- Cleanup, added device_signal for signal inputs
+  ([`6fb2055`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6fb20552ff57978f4aeb79fd7f062f8d6b5581e7))
+
+### Testing
+
+- **scan_control**: Tests added for grid_scan to ensure scan_args signal validity
+  ([`acb7902`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/acb79020d4be546efc001ff47b6f5cdba2ee9375))
+
+
+## v1.0.2 (2024-10-22)
+
+### Bug Fixes
+
+- **scan_control**: Scan args signal fixed to emit list instead of hardcoded structure
+  ([`4f5448c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/4f5448cf51a204e077af162c7f0aed1f1a60e57a))
+
+
+## v1.0.1 (2024-10-22)
+
+### Bug Fixes
+
+- **waveform**: Added support for live_data and data access
+  ([`7469c89`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/7469c892c8076fc09e61f173df6920c551241cec))
+
+
+## v1.0.0 (2024-10-18)
+
+### Bug Fixes
+
+- **crosshair**: Downsample clear markers
+  ([`f9a889f`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f9a889fc6d380b9e587edcb465203122ea0bffc1))
+
+### Features
+
+- Ability to disable scatter from waveform & compatible crosshair with down sampling
+  ([`2ab12ed`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/2ab12ed60abb995abc381d9330fdcf399796d9e5))
+
+
+## v0.119.0 (2024-10-17)
+
+### Bug Fixes
+
+- Fix syntax due to change of api for simulated devices
+  ([`19f4e40`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/19f4e407e00ee242973ca4c3f90e4e41a4d3e315))
+
+- Remove wrongly scoped test
+  ([`a23841b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a23841b2553dc7162da943715d58275c7dc39ed9))
+
+- Rename 'compact' property -> 'compact_view'
+  ([`6982711`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/6982711fea5fb8a73845ed7c0692e3ec53ef7871))
+
+- Alignment 1D update, make app window a main window (in .ui file)
+  ([`0015f0e`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0015f0e2d62adc02d3ef334e1f6dbb2d0288fec6))
+
+- Set (Minimum, Fixed) size policy on Stop button
+  ([`523cc43`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/523cc435725b10b7d59a4477a1aaa24a1f3e37a2))
+
+### Features
+
+- New PositionerGroup widget
+  ([`af9655d`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/af9655de0c541092437accfbaa779628a2f48ccb))
+
+- Add 'expand_popup' property to CompactPopupWidget
+  ([`e4121a0`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e4121a01cb6b8d496e630cd43bc642b994b8f310))
+
+This property tells if expand should show a popup (by default), or if the widget should expand
+  in-place
+
+- Positionerbox with a popup view
+  ([`2615787`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/261578796f1de8ca9cab9b91659bc1484f7aa89d))
+
+- Emit 'device_selected' and 'scan_axis' from scan control widget
+  ([`0b9b1a3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0b9b1a3c89a98505079f7d4078915b7bbfaa1e23))
+
+- New 'device_selected' signals to ScanControl, ScanGroupBox, DeviceLineEdit
+  ([`9801d27`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9801d2769eb0ee95c94ec0c011e1dac1407142ae))
+
+### Refactoring
+
+- Redesign of scan selection and scan control boxes
+  ([`a69d287`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/a69d2870e2b3539739781d741b27b8599c0f4abd))
+
+- Move add/remove bundle to scan group box
+  ([`e3d0a7b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e3d0a7bbf9918dc16eb7227a178c310256ce570d))
+
+
+## v0.118.0 (2024-10-13)
+
+### Documentation
+
+- **sphinx-build**: Adjusted pyside verion
+  ([`b236951`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b23695167ab969f754a058ffdccca2b40f00a008))
+
+### Features
+
+- **image**: Image widget can take data from monitor_1d endpoint
+  ([`9ef1d1c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9ef1d1c9ac2178d9fa2e655942208f8abbdf5c1b))
+
+
+## v0.117.1 (2024-10-11)
+
+### Bug Fixes
+
+- **FPS**: Qtimer cleanup leaking
+  ([`3a22392`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/3a2239278075de7489ad10a58c31d7d89715e221))

{bec_widgets-1.3.3 → bec_widgets-1.4.0}/PKG-INFO

@@ -1,10 +1,9 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 1.3.3
+Version: 1.4.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
-License-File: LICENSE
 Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering

{bec_widgets-1.3.3 → bec_widgets-1.4.0}/bec_widgets/utils/crosshair.py

@@ -2,10 +2,8 @@ from collections import defaultdict
 
 import numpy as np
 import pyqtgraph as pg
-
-# from qtpy.QtCore import QObject, pyqtSignal
-from qtpy.QtCore import QObject, Qt
-from qtpy.QtCore import Signal as pyqtSignal
+from qtpy.QtCore import QObject, Qt, Signal, Slot
+from qtpy.QtWidgets import QApplication
 
 
 class NonDownsamplingScatterPlotItem(pg.ScatterPlotItem):
@@ -17,14 +15,18 @@ class NonDownsamplingScatterPlotItem(pg.ScatterPlotItem):
 
 
 class Crosshair(QObject):
-    positionChanged = pyqtSignal(tuple)
-    positionClicked = pyqtSignal(tuple)
+    # QT Position of mouse cursor
+    positionChanged = Signal(tuple)
+    positionClicked = Signal(tuple)
+    # Plain crosshair position signals mapped to real coordinates
+    crosshairChanged = Signal(tuple)
+    crosshairClicked = Signal(tuple)
     # Signal for 1D plot
-    coordinatesChanged1D = pyqtSignal(tuple)
-    coordinatesClicked1D = pyqtSignal(tuple)
+    coordinatesChanged1D = Signal(tuple)
+    coordinatesClicked1D = Signal(tuple)
     # Signal for 2D plot
-    coordinatesChanged2D = pyqtSignal(tuple)
-    coordinatesClicked2D = pyqtSignal(tuple)
+    coordinatesChanged2D = Signal(tuple)
+    coordinatesClicked2D = Signal(tuple)
 
     def __init__(self, plot_item: pg.PlotItem, precision: int = 3, parent=None):
         """
@@ -47,11 +49,21 @@ class Crosshair(QObject):
         self.h_line.skip_auto_range = True
         self.plot_item.addItem(self.v_line, ignoreBounds=True)
         self.plot_item.addItem(self.h_line, ignoreBounds=True)
+
+        # Add TextItem to display coordinates
+        self.coord_label = pg.TextItem("", anchor=(1, 1), fill=(0, 0, 0, 100))
+        self.coord_label.setVisible(False)  # Hide initially
+        self.coord_label.skip_auto_range = True
+        self.plot_item.addItem(self.coord_label)
+
+        # Signals to connect
         self.proxy = pg.SignalProxy(
             self.plot_item.scene().sigMouseMoved, rateLimit=60, slot=self.mouse_moved
         )
+        self.positionChanged.connect(self.update_coord_label)
         self.plot_item.scene().sigMouseClicked.connect(self.mouse_clicked)
 
+        # Connect signals from pyqtgraph right click menu
         self.plot_item.ctrl.derivativeCheck.checkStateChanged.connect(self.check_derivatives)
         self.plot_item.ctrl.logXCheck.checkStateChanged.connect(self.check_log)
         self.plot_item.ctrl.logYCheck.checkStateChanged.connect(self.check_log)
@@ -62,6 +74,44 @@ class Crosshair(QObject):
         self.marker_clicked_1d = {}
         self.marker_2d = None
         self.update_markers()
+        self.check_log()
+        self.check_derivatives()
+
+        self._connect_to_theme_change()
+
+    def _connect_to_theme_change(self):
+        """Connect to the theme change signal."""
+        qapp = QApplication.instance()
+        if hasattr(qapp, "theme_signal"):
+            qapp.theme_signal.theme_updated.connect(self._update_theme)
+            self._update_theme()
+
+    @Slot(str)
+    def _update_theme(self, theme: str | None = None):
+        """Update the theme."""
+        if theme is None:
+            qapp = QApplication.instance()
+            if hasattr(qapp, "theme"):
+                theme = qapp.theme.theme
+            else:
+                theme = "dark"
+        self.apply_theme(theme)
+
+    def apply_theme(self, theme: str):
+        """Apply the theme to the plot."""
+        if theme == "dark":
+            text_color = "w"
+            label_bg_color = (50, 50, 50, 150)
+        elif theme == "light":
+            text_color = "k"
+            label_bg_color = (240, 240, 240, 150)
+        else:
+            text_color = "w"
+            label_bg_color = (50, 50, 50, 150)
+
+        self.coord_label.setColor(text_color)
+        self.coord_label.fill = pg.mkBrush(label_bg_color)
+        self.coord_label.border = pg.mkPen(None)
 
     def update_markers(self):
         """Update the markers for the crosshair, creating new ones if necessary."""
@@ -151,21 +201,34 @@ class Crosshair(QObject):
 
         return None, None
 
-    def closest_x_y_value(self, input_value: float, list_x: list, list_y: list) -> tuple:
+    def closest_x_y_value(self, input_x: float, list_x: list, list_y: list) -> tuple:
         """
         Find the closest x and y value to the input value.
 
         Args:
-            input_value (float): Input value
+            input_x (float): Input value
             list_x (list): List of x values
             list_y (list): List of y values
 
         Returns:
             tuple: Closest x and y value
         """
-        arr = np.asarray(list_x)
-        i = (np.abs(arr - input_value)).argmin()
-        return list_x[i], list_y[i]
+        # Convert lists to NumPy arrays
+        arr_x = np.asarray(list_x)
+
+        # Get the indices where x is not NaN
+        valid_indices = ~np.isnan(arr_x)
+
+        # Filter x array to exclude NaN values
+        filtered_x = arr_x[valid_indices]
+
+        # Find the index of the closest value in the filtered x array
+        closest_index = np.abs(filtered_x - input_x).argmin()
+
+        # Map back to the original index in the list_x and list_y arrays
+        original_index = np.where(valid_indices)[0][closest_index]
+
+        return list_x[original_index], list_y[original_index]
 
     def mouse_moved(self, event):
         """Handles the mouse moved event, updating the crosshair position and emitting signals.
@@ -175,17 +238,15 @@ class Crosshair(QObject):
         """
         pos = event[0]
         self.update_markers()
-        self.positionChanged.emit((pos.x(), pos.y()))
         if self.plot_item.vb.sceneBoundingRect().contains(pos):
             mouse_point = self.plot_item.vb.mapSceneToView(pos)
-            self.v_line.setPos(mouse_point.x())
-            self.h_line.setPos(mouse_point.y())
-
             x, y = mouse_point.x(), mouse_point.y()
-            if self.is_log_x:
-                x = 10**x
-            if self.is_log_y:
-                y = 10**y
+            self.v_line.setPos(x)
+            self.h_line.setPos(y)
+            scaled_x, scaled_y = self.scale_emitted_coordinates(mouse_point.x(), mouse_point.y())
+            self.crosshairChanged.emit((scaled_x, scaled_y))
+            self.positionChanged.emit((x, y))
+
             x_snap_values, y_snap_values = self.snap_to_data(x, y)
             if x_snap_values is None or y_snap_values is None:
                 return
@@ -202,7 +263,12 @@ class Crosshair(QObject):
                     if x is None or y is None:
                         continue
                     self.marker_moved_1d[name].setData([x], [y])
-                    coordinate_to_emit = (name, round(x, self.precision), round(y, self.precision))
+                    x_snapped_scaled, y_snapped_scaled = self.scale_emitted_coordinates(x, y)
+                    coordinate_to_emit = (
+                        name,
+                        round(x_snapped_scaled, self.precision),
+                        round(y_snapped_scaled, self.precision),
+                    )
                     self.coordinatesChanged1D.emit(coordinate_to_emit)
                 elif isinstance(item, pg.ImageItem):
                     name = item.config.monitor
@@ -229,12 +295,10 @@ class Crosshair(QObject):
         if self.plot_item.vb.sceneBoundingRect().contains(event._scenePos):
             mouse_point = self.plot_item.vb.mapSceneToView(event._scenePos)
             x, y = mouse_point.x(), mouse_point.y()
+            scaled_x, scaled_y = self.scale_emitted_coordinates(mouse_point.x(), mouse_point.y())
+            self.crosshairClicked.emit((scaled_x, scaled_y))
             self.positionClicked.emit((x, y))
 
-            if self.is_log_x:
-                x = 10**x
-            if self.is_log_y:
-                y = 10**y
             x_snap_values, y_snap_values = self.snap_to_data(x, y)
 
             if x_snap_values is None or y_snap_values is None:
@@ -252,7 +316,12 @@ class Crosshair(QObject):
                     if x is None or y is None:
                         continue
                     self.marker_clicked_1d[name].setData([x], [y])
-                    coordinate_to_emit = (name, round(x, self.precision), round(y, self.precision))
+                    x_snapped_scaled, y_snapped_scaled = self.scale_emitted_coordinates(x, y)
+                    coordinate_to_emit = (
+                        name,
+                        round(x_snapped_scaled, self.precision),
+                        round(y_snapped_scaled, self.precision),
+                    )
                     self.coordinatesClicked1D.emit(coordinate_to_emit)
                 elif isinstance(item, pg.ImageItem):
                     name = item.config.monitor
@@ -272,10 +341,40 @@ class Crosshair(QObject):
         for marker in self.marker_clicked_1d.values():
             marker.clear()
 
+    def scale_emitted_coordinates(self, x, y):
+        """Scales the emitted coordinates if the axes are in log scale.
+
+        Args:
+            x (float): The x-coordinate
+            y (float): The y-coordinate
+
+        Returns:
+            tuple: The scaled x and y coordinates
+        """
+        if self.is_log_x:
+            x = 10**x
+        if self.is_log_y:
+            y = 10**y
+        return x, y
+
+    def update_coord_label(self, pos: tuple):
+        """Updates the coordinate label based on the crosshair position and axis scales.
+
+        Args:
+            pos (tuple): The (x, y) position of the crosshair.
+        """
+        x, y = pos
+        x_scaled, y_scaled = self.scale_emitted_coordinates(x, y)
+
+        # # Update coordinate label
+        self.coord_label.setText(f"({x_scaled:.{self.precision}g}, {y_scaled:.{self.precision}g})")
+        self.coord_label.setPos(x, y)
+        self.coord_label.setVisible(True)
+
     def check_log(self):
         """Checks if the x or y axis is in log scale and updates the internal state accordingly."""
-        self.is_log_x = self.plot_item.ctrl.logXCheck.isChecked()
-        self.is_log_y = self.plot_item.ctrl.logYCheck.isChecked()
+        self.is_log_x = self.plot_item.axes["bottom"]["item"].logMode
+        self.is_log_y = self.plot_item.axes["left"]["item"].logMode
         self.clear_markers()
 
     def check_derivatives(self):
@@ -284,6 +383,8 @@ class Crosshair(QObject):
         self.clear_markers()
 
     def cleanup(self):
-        self.v_line.deleteLater()
-        self.h_line.deleteLater()
+        self.plot_item.removeItem(self.v_line)
+        self.plot_item.removeItem(self.h_line)
+        self.plot_item.removeItem(self.coord_label)
+
         self.clear_markers()

{bec_widgets-1.3.3 → bec_widgets-1.4.0}/bec_widgets/widgets/figure/plots/plot_base.py

@@ -397,8 +397,8 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
         """Hook the crosshair to all plots."""
         if self.crosshair is None:
             self.crosshair = Crosshair(self.plot_item, precision=3)
-            self.crosshair.positionChanged.connect(self.crosshair_position_changed)
-            self.crosshair.positionClicked.connect(self.crosshair_position_clicked)
+            self.crosshair.crosshairChanged.connect(self.crosshair_position_changed)
+            self.crosshair.crosshairClicked.connect(self.crosshair_position_clicked)
             self.crosshair.coordinatesChanged1D.connect(self.crosshair_coordinates_changed)
             self.crosshair.coordinatesClicked1D.connect(self.crosshair_coordinates_clicked)
             self.crosshair.coordinatesChanged2D.connect(self.crosshair_coordinates_changed)
@@ -407,8 +407,8 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     def unhook_crosshair(self) -> None:
         """Unhook the crosshair from all plots."""
         if self.crosshair is not None:
-            self.crosshair.positionChanged.disconnect(self.crosshair_position_changed)
-            self.crosshair.positionClicked.disconnect(self.crosshair_position_clicked)
+            self.crosshair.crosshairChanged.disconnect(self.crosshair_position_changed)
+            self.crosshair.crosshairClicked.disconnect(self.crosshair_position_clicked)
             self.crosshair.coordinatesChanged1D.disconnect(self.crosshair_coordinates_changed)
             self.crosshair.coordinatesClicked1D.disconnect(self.crosshair_coordinates_clicked)
             self.crosshair.coordinatesChanged2D.disconnect(self.crosshair_coordinates_changed)

{bec_widgets-1.3.3 → bec_widgets-1.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "1.3.3"
+version = "1.4.0"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [