bec-widgets 2.12.2__tar.gz → 2.12.3__tar.gz

{bec_widgets-2.12.2 → bec_widgets-2.12.3}/CHANGELOG.md

@@ -1,6 +1,26 @@
 # CHANGELOG
 
 
+## v2.12.3 (2025-06-05)
+
+### Bug Fixes
+
+- **crosshair**: Use objectName instead of config for retrieving the monitor name
+  ([`edfac87`](https://github.com/bec-project/bec_widgets/commit/edfac87868605b4b755f7732b2841673de53bc3f))
+
+- **device_combobox**: Tuple entries of preview signals are checked in DeviceComboBoxes just for the
+  relevant device
+  ([`12f5233`](https://github.com/bec-project/bec_widgets/commit/12f523374586d55499f80baf56a50b6ef486cd43))
+
+- **image**: Preview signals can be used in Image widget; update logic adjusted; closes #683
+  ([`2711164`](https://github.com/bec-project/bec_widgets/commit/271116453d1ef5316b19457d04613b6ddc939cdb))
+
+### Build System
+
+- Update min dependency of bec to 3.38
+  ([`3740ac8`](https://github.com/bec-project/bec_widgets/commit/3740ac8e325a489d59faca648896ffcea29e1a02))
+
+
 ## v2.12.2 (2025-06-05)
 
 ### Bug Fixes

{bec_widgets-2.12.2 → bec_widgets-2.12.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bec_widgets
-Version: 2.12.2
+Version: 2.12.3
 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
@@ -9,8 +9,8 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Programming Language :: Python :: 3
 Classifier: Topic :: Scientific/Engineering
 Requires-Python: >=3.10
-Requires-Dist: bec-ipython-client<=4.0,>=2.21.4
-Requires-Dist: bec-lib<=4.0,>=3.29
+Requires-Dist: bec-ipython-client<=4.0,>=3.38
+Requires-Dist: bec-lib<=4.0,>=3.38
 Requires-Dist: bec-qthemes>=0.7,~=0.7
 Requires-Dist: black~=25.0
 Requires-Dist: isort>=5.13.2,~=5.13

{bec_widgets-2.12.2 → bec_widgets-2.12.3}/bec_widgets/cli/client.py

@@ -1459,12 +1459,12 @@ class Image(RPCBase):
     @rpc_call
     def image(
         self,
-        monitor: "str | None" = None,
+        monitor: "str | tuple | None" = None,
         monitor_type: "Literal['auto', '1d', '2d']" = "auto",
         color_map: "str | None" = None,
         color_bar: "Literal['simple', 'full'] | None" = None,
         vrange: "tuple[int, int] | None" = None,
-    ) -> "ImageItem":
+    ) -> "ImageItem | None":
         """
         Set the image source and update the image.
 

{bec_widgets-2.12.2 → bec_widgets-2.12.3}/bec_widgets/utils/crosshair.py

@@ -458,7 +458,7 @@ class Crosshair(QObject):
                     )
                     self.coordinatesClicked1D.emit(coordinate_to_emit)
                 elif isinstance(item, pg.ImageItem):
-                    name = item.config.monitor or str(id(item))
+                    name = item.objectName() or str(id(item))
                     x, y = x_snap_values[name], y_snap_values[name]
                     if x is None or y is None:
                         continue

{bec_widgets-2.12.2 → bec_widgets-2.12.3}/bec_widgets/widgets/control/device_input/device_combobox/device_combobox.py

@@ -149,6 +149,25 @@ class DeviceComboBox(DeviceInputBase, QComboBox):
             self._is_valid_input = False
         self.update()
 
+    def validate_device(self, device: str) -> bool:  # type: ignore[override]
+        """
+        Extend validation so that preview‑signal pseudo‑devices (labels like
+        ``"eiger_preview"``) are accepted as valid choices.
+
+        The validation run only on device not on the preview‑signal.
+
+        Args:
+            device: The text currently entered/selected.
+
+        Returns:
+            True if the device is a genuine BEC device *or* one of the
+            whitelisted preview‑signal entries.
+        """
+        idx = self.findText(device)
+        if idx >= 0 and isinstance(self.itemData(idx), tuple):
+            device = self.itemData(idx)[0]  # type: ignore[assignment]
+        return super().validate_device(device)
+
 
 if __name__ == "__main__":  # pragma: no cover
     # pylint: disable=import-outside-toplevel

{bec_widgets-2.12.2 → bec_widgets-2.12.3}/bec_widgets/widgets/plots/image/image.py

@@ -35,7 +35,7 @@ class ImageConfig(ConnectionConfig):
 
 
 class ImageLayerConfig(BaseModel):
-    monitor: str | None = Field(None, description="The name of the monitor.")
+    monitor: str | tuple | None = Field(None, description="The name of the monitor.")
     monitor_type: Literal["1d", "2d", "auto"] = Field("auto", description="The type of monitor.")
     source: Literal["device_monitor_1d", "device_monitor_2d", "auto"] = Field(
         "auto", description="The source of the image data."
@@ -179,12 +179,12 @@ class Image(ImageBase):
     @SafeSlot(popup_error=True)
     def image(
         self,
-        monitor: str | None = None,
+        monitor: str | tuple | None = None,
         monitor_type: Literal["auto", "1d", "2d"] = "auto",
         color_map: str | None = None,
         color_bar: Literal["simple", "full"] | None = None,
         vrange: tuple[int, int] | None = None,
-    ) -> ImageItem:
+    ) -> ImageItem | None:
         """
         Set the image source and update the image.
 
@@ -201,21 +201,13 @@ class Image(ImageBase):
 
         if self.subscriptions["main"].monitor:
             self.disconnect_monitor(self.subscriptions["main"].monitor)
-        self.entry_validator.validate_monitor(monitor)
-        self.subscriptions["main"].monitor = monitor
-
-        if monitor_type == "1d":
-            self.subscriptions["main"].source = "device_monitor_1d"
-            self.subscriptions["main"].monitor_type = "1d"
-        elif monitor_type == "2d":
-            self.subscriptions["main"].source = "device_monitor_2d"
-            self.subscriptions["main"].monitor_type = "2d"
-        elif monitor_type == "auto":
-            self.subscriptions["main"].source = "auto"
-            logger.warning(
-                f"Updates for '{monitor}' will be fetch from both 1D and 2D monitor endpoints."
-            )
-            self.subscriptions["main"].monitor_type = "auto"
+        if monitor is None or monitor == "":
+            logger.warning(f"No monitor specified, cannot set image, old monitor is unsubscribed")
+            return None
+        if isinstance(monitor, tuple):
+            self.entry_validator.validate_monitor(monitor[0])
+        else:
+            self.entry_validator.validate_monitor(monitor)
 
         self.set_image_update(monitor=monitor, type=monitor_type)
         if color_map is not None:
@@ -240,7 +232,12 @@ class Image(ImageBase):
                 self.selection_bundle.dim_combo_box,
             ):
                 combo.blockSignals(True)
-            self.selection_bundle.device_combo_box.set_device(config.monitor)
+            if isinstance(config.monitor, tuple):
+                self.selection_bundle.device_combo_box.setCurrentText(
+                    f"{config.monitor[0]}_{config.monitor[1]}"
+                )
+            else:
+                self.selection_bundle.device_combo_box.setCurrentText(config.monitor)
             self.selection_bundle.dim_combo_box.setCurrentText(config.monitor_type)
             for combo in (
                 self.selection_bundle.device_combo_box,
@@ -340,7 +337,8 @@ class Image(ImageBase):
     ########################################
     # Connections
 
-    def set_image_update(self, monitor: str, type: Literal["1d", "2d", "auto"]):
+    @SafeSlot()
+    def set_image_update(self, monitor: str | tuple, type: Literal["1d", "2d", "auto"]):
         """
         Set the image update method for the given monitor.
 
@@ -350,37 +348,95 @@ class Image(ImageBase):
         """
 
         # TODO consider moving connecting and disconnecting logic to Image itself if multiple images
-        if type == "1d":
-            self.bec_dispatcher.connect_slot(
-                self.on_image_update_1d, MessageEndpoints.device_monitor_1d(monitor)
-            )
-        elif type == "2d":
-            self.bec_dispatcher.connect_slot(
-                self.on_image_update_2d, MessageEndpoints.device_monitor_2d(monitor)
-            )
-        elif type == "auto":
-            self.bec_dispatcher.connect_slot(
-                self.on_image_update_1d, MessageEndpoints.device_monitor_1d(monitor)
-            )
-            self.bec_dispatcher.connect_slot(
-                self.on_image_update_2d, MessageEndpoints.device_monitor_2d(monitor)
-            )
+        if isinstance(monitor, tuple):
+            device = self.dev[monitor[0]]
+            signal = monitor[1]
+            if len(monitor) == 3:
+                signal_config = monitor[2]
+            else:
+                signal_config = device._info["signals"][signal]
+            signal_class = signal_config.get("signal_class", None)
+            if signal_class != "PreviewSignal":
+                logger.warning(f"Signal '{monitor}' is not a PreviewSignal.")
+                return
+
+            ndim = signal_config.get("describe", None).get("signal_info", None).get("ndim", None)
+            if ndim is None:
+                logger.warning(
+                    f"Signal '{monitor}' does not have a valid 'ndim' in its signal_info."
+                )
+                return
+
+            if ndim == 1:
+                self.bec_dispatcher.connect_slot(
+                    self.on_image_update_1d, MessageEndpoints.device_preview(device.name, signal)
+                )
+                self.subscriptions["main"].source = "device_monitor_1d"
+                self.subscriptions["main"].monitor_type = "1d"
+            elif ndim == 2:
+                self.bec_dispatcher.connect_slot(
+                    self.on_image_update_2d, MessageEndpoints.device_preview(device.name, signal)
+                )
+                self.subscriptions["main"].source = "device_monitor_2d"
+                self.subscriptions["main"].monitor_type = "2d"
+
+        else:  # FIXME old monitor 1d/2d endpoint handling, present for backwards compatibility, will be removed in future versions
+            if type == "1d":
+                self.bec_dispatcher.connect_slot(
+                    self.on_image_update_1d, MessageEndpoints.device_monitor_1d(monitor)
+                )
+                self.subscriptions["main"].source = "device_monitor_1d"
+                self.subscriptions["main"].monitor_type = "1d"
+            elif type == "2d":
+                self.bec_dispatcher.connect_slot(
+                    self.on_image_update_2d, MessageEndpoints.device_monitor_2d(monitor)
+                )
+                self.subscriptions["main"].source = "device_monitor_2d"
+                self.subscriptions["main"].monitor_type = "2d"
+            elif type == "auto":
+                self.bec_dispatcher.connect_slot(
+                    self.on_image_update_1d, MessageEndpoints.device_monitor_1d(monitor)
+                )
+                self.bec_dispatcher.connect_slot(
+                    self.on_image_update_2d, MessageEndpoints.device_monitor_2d(monitor)
+                )
+                self.subscriptions["main"].source = "auto"
+                logger.warning(
+                    f"Updates for '{monitor}' will be fetch from both 1D and 2D monitor endpoints."
+                )
+                self.subscriptions["main"].monitor_type = "auto"
+
         logger.info(f"Connected to {monitor} with type {type}")
         self.subscriptions["main"].monitor = monitor
 
-    def disconnect_monitor(self, monitor: str):
+    def disconnect_monitor(self, monitor: str | tuple):
         """
         Disconnect the monitor from the image update signals, both 1D and 2D.
 
         Args:
-            monitor(str): The name of the monitor to disconnect.
-        """
-        self.bec_dispatcher.disconnect_slot(
-            self.on_image_update_1d, MessageEndpoints.device_monitor_1d(monitor)
-        )
-        self.bec_dispatcher.disconnect_slot(
-            self.on_image_update_2d, MessageEndpoints.device_monitor_2d(monitor)
-        )
+            monitor(str|tuple): The name of the monitor to disconnect, or a tuple of (device, signal) for preview signals.
+        """
+        if isinstance(monitor, tuple):
+            if self.subscriptions["main"].source == "device_monitor_1d":
+                self.bec_dispatcher.disconnect_slot(
+                    self.on_image_update_1d, MessageEndpoints.device_preview(monitor[0], monitor[1])
+                )
+            elif self.subscriptions["main"].source == "device_monitor_2d":
+                self.bec_dispatcher.disconnect_slot(
+                    self.on_image_update_2d, MessageEndpoints.device_preview(monitor[0], monitor[1])
+                )
+            else:
+                logger.warning(
+                    f"Cannot disconnect monitor {monitor} with source {self.subscriptions['main'].source}"
+                )
+                return
+        else:  # FIXME old monitor 1d/2d endpoint handling, present for backwards compatibility, will be removed in future versions
+            self.bec_dispatcher.disconnect_slot(
+                self.on_image_update_1d, MessageEndpoints.device_monitor_1d(monitor)
+            )
+            self.bec_dispatcher.disconnect_slot(
+                self.on_image_update_2d, MessageEndpoints.device_monitor_2d(monitor)
+            )
         self.subscriptions["main"].monitor = None
         self._sync_device_selection()
 

bec_widgets-2.12.3/bec_widgets/widgets/plots/image/toolbar_bundles/image_selection.py

@@ -0,0 +1,107 @@
+from bec_lib.device import ReadoutPriority
+from qtpy.QtCore import Qt, QTimer
+from qtpy.QtWidgets import QComboBox, QStyledItemDelegate
+
+from bec_widgets.utils.error_popups import SafeSlot
+from bec_widgets.utils.toolbar import ToolbarBundle, WidgetAction
+from bec_widgets.widgets.control.device_input.base_classes.device_input_base import BECDeviceFilter
+from bec_widgets.widgets.control.device_input.device_combobox.device_combobox import DeviceComboBox
+
+
+class NoCheckDelegate(QStyledItemDelegate):
+    """To reduce space in combo boxes by removing the checkmark."""
+
+    def initStyleOption(self, option, index):
+        super().initStyleOption(option, index)
+        # Remove any check indicator
+        option.checkState = Qt.Unchecked
+
+
+class MonitorSelectionToolbarBundle(ToolbarBundle):
+    """
+    A bundle of actions for a toolbar that controls monitor selection on a plot.
+    """
+
+    def __init__(self, bundle_id="device_selection", target_widget=None, **kwargs):
+        super().__init__(bundle_id=bundle_id, actions=[], **kwargs)
+        self.target_widget = target_widget
+
+        # 1) Device combo box
+        self.device_combo_box = DeviceComboBox(
+            parent=self.target_widget,
+            device_filter=BECDeviceFilter.DEVICE,
+            readout_priority_filter=[ReadoutPriority.ASYNC],
+        )
+        self.device_combo_box.addItem("", None)
+        self.device_combo_box.setCurrentText("")
+        self.device_combo_box.setToolTip("Select Device")
+        self.device_combo_box.setFixedWidth(150)
+        self.device_combo_box.setItemDelegate(NoCheckDelegate(self.device_combo_box))
+
+        self.add_action("monitor", WidgetAction(widget=self.device_combo_box, adjust_size=False))
+
+        # 2) Dimension combo box
+        self.dim_combo_box = QComboBox(parent=self.target_widget)
+        self.dim_combo_box.addItems(["auto", "1d", "2d"])
+        self.dim_combo_box.setCurrentText("auto")
+        self.dim_combo_box.setToolTip("Monitor Dimension")
+        self.dim_combo_box.setFixedWidth(100)
+        self.dim_combo_box.setItemDelegate(NoCheckDelegate(self.dim_combo_box))
+
+        self.add_action("dim_combo", WidgetAction(widget=self.dim_combo_box, adjust_size=False))
+
+        self.device_combo_box.currentTextChanged.connect(self.connect_monitor)
+        self.dim_combo_box.currentTextChanged.connect(self.connect_monitor)
+
+        QTimer.singleShot(0, self._adjust_and_connect)
+
+    def _adjust_and_connect(self):
+        """
+        Adjust the size of the device combo box and populate it with preview signals.
+        Has to be done with QTimer.singleShot to ensure the UI is fully initialized, needed for testing.
+        """
+        self._populate_preview_signals()
+        self._reverse_device_items()
+        self.device_combo_box.setCurrentText("")  # set again default to empty string
+
+    def _populate_preview_signals(self) -> None:
+        """
+        Populate the device combo box with preview‑signal devices in the
+        format '<device>_<signal>' and store the tuple(device, signal) in
+        the item's userData for later use.
+        """
+        preview_signals = self.target_widget.client.device_manager.get_bec_signals("PreviewSignal")
+        for device, signal, signal_config in preview_signals:
+            label = signal_config.get("obj_name", f"{device}_{signal}")
+            self.device_combo_box.addItem(label, (device, signal, signal_config))
+
+    def _reverse_device_items(self) -> None:
+        """
+        Reverse the current order of items in the device combo box while
+        keeping their userData and restoring the previous selection.
+        """
+        current_text = self.device_combo_box.currentText()
+        items = [
+            (self.device_combo_box.itemText(i), self.device_combo_box.itemData(i))
+            for i in range(self.device_combo_box.count())
+        ]
+        self.device_combo_box.clear()
+        for text, data in reversed(items):
+            self.device_combo_box.addItem(text, data)
+        if current_text:
+            self.device_combo_box.setCurrentText(current_text)
+
+    @SafeSlot()
+    def connect_monitor(self, *args, **kwargs):
+        """
+        Connect the target widget to the selected monitor based on the current device and dimension.
+
+        If the selected device is a preview-signal device, it will use the tuple (device, signal) as the monitor.
+        """
+        dim = self.dim_combo_box.currentText()
+        data = self.device_combo_box.currentData()
+
+        if isinstance(data, tuple):
+            self.target_widget.image(monitor=data, monitor_type="auto")
+        else:
+            self.target_widget.image(monitor=self.device_combo_box.currentText(), monitor_type=dim)

{bec_widgets-2.12.2 → bec_widgets-2.12.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "bec_widgets"
-version = "2.12.2"
+version = "2.12.3"
 description = "BEC Widgets"
 requires-python = ">=3.10"
 classifiers = [
@@ -13,15 +13,15 @@ classifiers = [
     "Topic :: Scientific/Engineering",
 ]
 dependencies = [
-    "bec_ipython_client>=2.21.4, <=4.0", # needed for jupyter console
-    "bec_lib>=3.29, <=4.0",
+    "bec_ipython_client>=3.38, <=4.0", # needed for jupyter console
+    "bec_lib>=3.38, <=4.0",
     "bec_qthemes~=0.7, >=0.7",
-    "black~=25.0",                       # needed for bw-generate-cli
-    "isort~=5.13, >=5.13.2",             # needed for bw-generate-cli
+    "black~=25.0",                     # needed for bw-generate-cli
+    "isort~=5.13, >=5.13.2",           # needed for bw-generate-cli
     "pydantic~=2.0",
     "pyqtgraph~=0.13",
     "PySide6~=6.8.2",
-    "qtconsole~=5.5, >=5.5.1",           # needed for jupyter console
+    "qtconsole~=5.5, >=5.5.1",         # needed for jupyter console
     "qtpy~=2.4",
 ]
 

bec_widgets-2.12.2/bec_widgets/widgets/plots/image/toolbar_bundles/image_selection.py

@@ -1,60 +0,0 @@
-from bec_lib.device import ReadoutPriority
-from qtpy.QtCore import Qt
-from qtpy.QtWidgets import QComboBox, QStyledItemDelegate
-
-from bec_widgets.utils.error_popups import SafeSlot
-from bec_widgets.utils.toolbar import ToolbarBundle, WidgetAction
-from bec_widgets.widgets.control.device_input.base_classes.device_input_base import BECDeviceFilter
-from bec_widgets.widgets.control.device_input.device_combobox.device_combobox import DeviceComboBox
-
-
-class NoCheckDelegate(QStyledItemDelegate):
-    """To reduce space in combo boxes by removing the checkmark."""
-
-    def initStyleOption(self, option, index):
-        super().initStyleOption(option, index)
-        # Remove any check indicator
-        option.checkState = Qt.Unchecked
-
-
-class MonitorSelectionToolbarBundle(ToolbarBundle):
-    """
-    A bundle of actions for a toolbar that controls monitor selection on a plot.
-    """
-
-    def __init__(self, bundle_id="device_selection", target_widget=None, **kwargs):
-        super().__init__(bundle_id=bundle_id, actions=[], **kwargs)
-        self.target_widget = target_widget
-
-        # 1) Device combo box
-        self.device_combo_box = DeviceComboBox(
-            parent=self.target_widget,
-            device_filter=BECDeviceFilter.DEVICE,
-            readout_priority_filter=[ReadoutPriority.ASYNC],
-        )
-        self.device_combo_box.addItem("", None)
-        self.device_combo_box.setCurrentText("")
-        self.device_combo_box.setToolTip("Select Device")
-        self.device_combo_box.setFixedWidth(150)
-        self.device_combo_box.setItemDelegate(NoCheckDelegate(self.device_combo_box))
-
-        self.add_action("monitor", WidgetAction(widget=self.device_combo_box, adjust_size=False))
-
-        # 2) Dimension combo box
-        self.dim_combo_box = QComboBox(parent=self.target_widget)
-        self.dim_combo_box.addItems(["auto", "1d", "2d"])
-        self.dim_combo_box.setCurrentText("auto")
-        self.dim_combo_box.setToolTip("Monitor Dimension")
-        self.dim_combo_box.setFixedWidth(100)
-        self.dim_combo_box.setItemDelegate(NoCheckDelegate(self.dim_combo_box))
-
-        self.add_action("dim_combo", WidgetAction(widget=self.dim_combo_box, adjust_size=False))
-
-        # Connect slots, a device will be connected upon change of any combobox
-        self.device_combo_box.currentTextChanged.connect(lambda: self.connect_monitor())
-        self.dim_combo_box.currentTextChanged.connect(lambda: self.connect_monitor())
-
-    @SafeSlot()
-    def connect_monitor(self):
-        dim = self.dim_combo_box.currentText()
-        self.target_widget.image(monitor=self.device_combo_box.currentText(), monitor_type=dim)