bec-widgets 0.89.0__py3-none-any.whl → 0.90.0__py3-none-any.whl

bec_widgets/widgets/figure/plots/axis_settings.ui

@@ -26,42 +26,28 @@
             <string>Form</string>
         </property>
         <layout class="QGridLayout" name="gridLayout">
-            <item row="0" column="0" colspan="3">
-                <layout class="QHBoxLayout" name="horizontalLayout">
-                    <item>
-                        <widget class="QLabel" name="plot_title_label">
-                            <property name="text">
-                                <string>Plot Title</string>
-                            </property>
-                        </widget>
-                    </item>
-                    <item>
-                        <widget class="QLineEdit" name="plot_title"/>
-                    </item>
-                </layout>
-            </item>
-            <item row="1" column="0" colspan="3">
-                <widget class="Line" name="line_H">
-                    <property name="orientation">
-                        <enum>Qt::Orientation::Horizontal</enum>
-                    </property>
-                </widget>
-            </item>
-            <item row="2" column="0">
-                <widget class="QGroupBox" name="x_axis_box">
+            <item row="1" column="1">
+                <widget class="QGroupBox" name="y_axis_box">
                     <property name="title">
-                        <string>X Axis</string>
+                        <string>Y Axis</string>
                     </property>
-                    <layout class="QGridLayout" name="gridLayout_4">
-                        <item row="3" column="0">
-                            <widget class="QLabel" name="x_scale_label">
-                                <property name="text">
-                                    <string>Scale</string>
-                                </property>
+                    <layout class="QGridLayout" name="gridLayout_5">
+                        <item row="3" column="2">
+                            <widget class="QComboBox" name="y_scale">
+                                <item>
+                                    <property name="text">
+                                        <string>linear</string>
+                                    </property>
+                                </item>
+                                <item>
+                                    <property name="text">
+                                        <string>log</string>
+                                    </property>
+                                </item>
                             </widget>
                         </item>
-                        <item row="1" column="2">
-                            <widget class="QDoubleSpinBox" name="x_min">
+                        <item row="2" column="2">
+                            <widget class="QDoubleSpinBox" name="y_max">
                                 <property name="alignment">
                                     <set>Qt::AlignmentFlag::AlignCenter</set>
                                 </property>
@@ -74,14 +60,14 @@
                             </widget>
                         </item>
                         <item row="1" column="0" colspan="2">
-                            <widget class="QLabel" name="x_min_label">
+                            <widget class="QLabel" name="y_min_label">
                                 <property name="text">
                                     <string>Min</string>
                                 </property>
                             </widget>
                         </item>
-                        <item row="2" column="2">
-                            <widget class="QDoubleSpinBox" name="x_max">
+                        <item row="1" column="2">
+                            <widget class="QDoubleSpinBox" name="y_min">
                                 <property name="alignment">
                                     <set>Qt::AlignmentFlag::AlignCenter</set>
                                 </property>
@@ -93,46 +79,39 @@
                                 </property>
                             </widget>
                         </item>
-                        <item row="3" column="2">
-                            <widget class="QComboBox" name="x_scale">
-                                <item>
-                                    <property name="text">
-                                        <string>linear</string>
-                                    </property>
-                                </item>
-                                <item>
-                                    <property name="text">
-                                        <string>log</string>
-                                    </property>
-                                </item>
-                            </widget>
+                        <item row="0" column="2">
+                            <widget class="QLineEdit" name="y_label"/>
                         </item>
-                        <item row="2" column="0">
-                            <widget class="QLabel" name="x_max_label">
+                        <item row="3" column="0">
+                            <widget class="QLabel" name="y_scale_label">
                                 <property name="text">
-                                    <string>Max</string>
+                                    <string>Scale</string>
                                 </property>
                             </widget>
                         </item>
-                        <item row="0" column="2">
-                            <widget class="QLineEdit" name="x_label"/>
-                        </item>
                         <item row="0" column="0">
-                            <widget class="QLabel" name="x_label_label">
+                            <widget class="QLabel" name="y_label_label">
                                 <property name="text">
                                     <string>Label</string>
                                 </property>
                             </widget>
                         </item>
+                        <item row="2" column="0">
+                            <widget class="QLabel" name="y_max_label">
+                                <property name="text">
+                                    <string>Max</string>
+                                </property>
+                            </widget>
+                        </item>
                         <item row="4" column="2">
-                            <widget class="QCheckBox" name="x_grid">
+                            <widget class="QCheckBox" name="y_grid">
                                 <property name="text">
                                     <string/>
                                 </property>
                             </widget>
                         </item>
                         <item row="4" column="0">
-                            <widget class="QLabel" name="x_grid_label">
+                            <widget class="QLabel" name="y_grid_label">
                                 <property name="text">
                                     <string>Grid</string>
                                 </property>
@@ -141,35 +120,21 @@
                     </layout>
                 </widget>
             </item>
-            <item row="2" column="1">
-                <widget class="Line" name="line_V">
-                    <property name="orientation">
-                        <enum>Qt::Orientation::Vertical</enum>
-                    </property>
-                </widget>
-            </item>
-            <item row="2" column="2">
-                <widget class="QGroupBox" name="y_axis_box">
+            <item row="1" column="0">
+                <widget class="QGroupBox" name="x_axis_box">
                     <property name="title">
-                        <string>Y Axis</string>
+                        <string>X Axis</string>
                     </property>
-                    <layout class="QGridLayout" name="gridLayout_5">
-                        <item row="3" column="2">
-                            <widget class="QComboBox" name="y_scale">
-                                <item>
-                                    <property name="text">
-                                        <string>linear</string>
-                                    </property>
-                                </item>
-                                <item>
-                                    <property name="text">
-                                        <string>log</string>
-                                    </property>
-                                </item>
+                    <layout class="QGridLayout" name="gridLayout_4">
+                        <item row="3" column="0">
+                            <widget class="QLabel" name="x_scale_label">
+                                <property name="text">
+                                    <string>Scale</string>
+                                </property>
                             </widget>
                         </item>
-                        <item row="2" column="2">
-                            <widget class="QDoubleSpinBox" name="y_max">
+                        <item row="1" column="2">
+                            <widget class="QDoubleSpinBox" name="x_min">
                                 <property name="alignment">
                                     <set>Qt::AlignmentFlag::AlignCenter</set>
                                 </property>
@@ -182,14 +147,14 @@
                             </widget>
                         </item>
                         <item row="1" column="0" colspan="2">
-                            <widget class="QLabel" name="y_min_label">
+                            <widget class="QLabel" name="x_min_label">
                                 <property name="text">
                                     <string>Min</string>
                                 </property>
                             </widget>
                         </item>
-                        <item row="1" column="2">
-                            <widget class="QDoubleSpinBox" name="y_min">
+                        <item row="2" column="2">
+                            <widget class="QDoubleSpinBox" name="x_max">
                                 <property name="alignment">
                                     <set>Qt::AlignmentFlag::AlignCenter</set>
                                 </property>
@@ -201,39 +166,46 @@
                                 </property>
                             </widget>
                         </item>
-                        <item row="0" column="2">
-                            <widget class="QLineEdit" name="y_label"/>
+                        <item row="3" column="2">
+                            <widget class="QComboBox" name="x_scale">
+                                <item>
+                                    <property name="text">
+                                        <string>linear</string>
+                                    </property>
+                                </item>
+                                <item>
+                                    <property name="text">
+                                        <string>log</string>
+                                    </property>
+                                </item>
+                            </widget>
                         </item>
-                        <item row="3" column="0">
-                            <widget class="QLabel" name="y_scale_label">
+                        <item row="2" column="0">
+                            <widget class="QLabel" name="x_max_label">
                                 <property name="text">
-                                    <string>Scale</string>
+                                    <string>Max</string>
                                 </property>
                             </widget>
                         </item>
+                        <item row="0" column="2">
+                            <widget class="QLineEdit" name="x_label"/>
+                        </item>
                         <item row="0" column="0">
-                            <widget class="QLabel" name="y_label_label">
+                            <widget class="QLabel" name="x_label_label">
                                 <property name="text">
                                     <string>Label</string>
                                 </property>
                             </widget>
                         </item>
-                        <item row="2" column="0">
-                            <widget class="QLabel" name="y_max_label">
-                                <property name="text">
-                                    <string>Max</string>
-                                </property>
-                            </widget>
-                        </item>
                         <item row="4" column="2">
-                            <widget class="QCheckBox" name="y_grid">
+                            <widget class="QCheckBox" name="x_grid">
                                 <property name="text">
                                     <string/>
                                 </property>
                             </widget>
                         </item>
                         <item row="4" column="0">
-                            <widget class="QLabel" name="y_grid_label">
+                            <widget class="QLabel" name="x_grid_label">
                                 <property name="text">
                                     <string>Grid</string>
                                 </property>
@@ -242,6 +214,20 @@
                     </layout>
                 </widget>
             </item>
+            <item row="0" column="0" colspan="2">
+                <layout class="QHBoxLayout" name="horizontalLayout">
+                    <item>
+                        <widget class="QLabel" name="plot_title_label">
+                            <property name="text">
+                                <string>Plot Title</string>
+                            </property>
+                        </widget>
+                    </item>
+                    <item>
+                        <widget class="QLineEdit" name="plot_title"/>
+                    </item>
+                </layout>
+            </item>
         </layout>
     </widget>
     <resources/>

bec_widgets/widgets/figure/plots/image/image.py

@@ -32,7 +32,7 @@ class BECImageShow(BECPlotBase):
         "_rpc_id",
         "_config_dict",
         "add_image_by_config",
-        "add_monitor_image",
+        "image",
         "add_custom_image",
         "set_vrange",
         "set_color_map",
@@ -67,6 +67,7 @@ class BECImageShow(BECPlotBase):
         config: Optional[ImageConfig] = None,
         client=None,
         gui_id: Optional[str] = None,
+        single_image: bool = True,
     ):
         if config is None:
             config = ImageConfig(widget_class=self.__class__.__name__)
@@ -74,6 +75,7 @@ class BECImageShow(BECPlotBase):
             parent=parent, parent_figure=parent_figure, config=config, client=client, gui_id=gui_id
         )
         # Get bec shortcuts dev, scans, queue, scan_storage, dap
+        self.single_image = single_image
         self.get_bec_shortcuts()
         self.entry_validator = EntryValidator(self.dev)
         self._images = defaultdict(dict)
@@ -221,7 +223,7 @@ class BECImageShow(BECPlotBase):
         """
         return self._images
 
-    def add_monitor_image(
+    def image(
         self,
         monitor: str,
         color_map: Optional[str] = "magma",
@@ -232,6 +234,19 @@ class BECImageShow(BECPlotBase):
         # post_processing: Optional[PostProcessingConfig] = None,
         **kwargs,
     ) -> BECImageItem:
+        """
+        Add an image to the figure. Always access the first image widget in the figure.
+
+        Args:
+            monitor(str): The name of the monitor to display.
+            color_bar(Literal["simple","full"]): The type of color bar to display.
+            color_map(str): The color map to use for the image.
+            data(np.ndarray): Custom data to display.
+            vrange(tuple[float, float]): The range of values to display.
+
+        Returns:
+            BECImageItem: The image item.
+        """
         image_source = "device_monitor"
 
         image_exits = self._check_image_id(monitor, self._images)
@@ -496,6 +511,7 @@ class BECImageShow(BECPlotBase):
         data = msg["data"]
         device = msg["device"]
         image = self._images["device_monitor"][device]
+        image.raw_data = data
         self.process_image(device, image, data)
 
     @pyqtSlot(str, np.ndarray)
@@ -528,7 +544,7 @@ class BECImageShow(BECPlotBase):
         """
         for source, images in self._images.items():
             for image_id, image in images.items():
-                data = image.get_data()
+                data = image.raw_data
                 self.process_image(image_id, image, data)
 
     def _connect_device_monitor(self, monitor: str):
@@ -562,6 +578,8 @@ class BECImageShow(BECPlotBase):
         config.parent_id = self.gui_id
         image = BECImageItem(config=config, parent_image=self)
         self.plot_item.addItem(image)
+        if self.single_image is True and len(self.images) > 0:
+            self.remove_image(0)
         self._images[source][name] = image
         if source == "device_monitor":
             self._connect_device_monitor(config.monitor)
@@ -589,6 +607,70 @@ class BECImageShow(BECPlotBase):
                     return True
         return False
 
+    def remove_image(self, *identifiers):
+        """
+        Remove an image from the plot widget.
+
+        Args:
+            *identifiers: Identifier of the image to be removed. Can be either an integer (index) or a string (image_id).
+        """
+        for identifier in identifiers:
+            if isinstance(identifier, int):
+                self._remove_image_by_order(identifier)
+            elif isinstance(identifier, str):
+                self._remove_image_by_id(identifier)
+            else:
+                raise ValueError(
+                    "Each identifier must be either an integer (index) or a string (image_id)."
+                )
+
+    def _remove_image_by_id(self, image_id):
+        for source, images in self._images.items():
+            if image_id in images:
+                self._disconnect_monitor(image_id)
+                image = images.pop(image_id)
+                self.removeItem(image.color_bar)
+                self.plot_item.removeItem(image)
+                del self.config.images[image_id]
+                if image in self.images:
+                    self.images.remove(image)
+                return
+        raise KeyError(f"Image with ID '{image_id}' not found.")
+
+    def _remove_image_by_order(self, N):
+        """
+        Remove an image by its order from the plot widget.
+
+        Args:
+            N(int): Order of the image to be removed.
+        """
+        if N < len(self.images):
+            image = self.images[N]
+            image_id = image.config.monitor
+            self._disconnect_monitor(image_id)
+            self.removeItem(image.color_bar)
+            self.plot_item.removeItem(image)
+            del self.config.images[image_id]
+            for source, images in self._images.items():
+                if image_id in images:
+                    del images[image_id]
+                    break
+        else:
+            raise IndexError(f"Image order {N} out of range.")
+
+    def _disconnect_monitor(self, image_id):
+        """
+        Disconnect the monitor from the device.
+
+        Args:
+            image_id(str): The ID of the monitor.
+        """
+        image = self.find_image_by_monitor(image_id)
+        if image:
+            self.bec_dispatcher.disconnect_slot(
+                self.on_image_update, MessageEndpoints.device_monitor(image.config.monitor)
+            )
+
     def cleanup(self):
         """
         Clean up the widget.

bec_widgets/widgets/figure/plots/image/image_item.py

@@ -71,6 +71,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
 
         self.parent_image = parent_image
         self.colorbar_bar = None
+        self._raw_data = None
 
         self._add_color_bar(
             self.config.color_bar, self.config.vrange
@@ -80,6 +81,14 @@ class BECImageItem(BECConnector, pg.ImageItem):
             self.set(**kwargs)
         self.connected = False
 
+    @property
+    def raw_data(self) -> np.ndarray:
+        return self._raw_data
+
+    @raw_data.setter
+    def raw_data(self, data: np.ndarray):
+        self._raw_data = data
+
     def apply_config(self):
         """
         Apply current configuration.
@@ -315,3 +324,8 @@ class BECImageItem(BECConnector, pg.ImageItem):
             self.config.color_bar = "full"
         else:
             raise ValueError("style should be 'simple' or 'full'")
+
+    def remove(self):
+        """Remove the curve from the plot."""
+        self.parent_image.remove_image(self.config.monitor)
+        self.rpc_register.remove_rpc(self)

bec_widgets/widgets/image/bec_image_widget.pyproject

@@ -0,0 +1 @@
+{'files': ['image_widget.py']}

bec_widgets/widgets/image/bec_image_widget_plugin.py

@@ -0,0 +1,59 @@
+# Copyright (C) 2022 The Qt Company Ltd.
+# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause
+import os
+
+from qtpy.QtDesigner import QDesignerCustomWidgetInterface
+from qtpy.QtGui import QIcon
+
+import bec_widgets
+from bec_widgets.widgets.image.image_widget import BECImageWidget
+
+DOM_XML = """
+<ui language='c++'>
+    <widget class='BECImageWidget' name='bec_image_widget'>
+    </widget>
+</ui>
+"""
+
+MODULE_PATH = os.path.dirname(bec_widgets.__file__)
+
+
+class BECImageWidgetPlugin(QDesignerCustomWidgetInterface):  # pragma: no cover
+    def __init__(self):
+        super().__init__()
+        self._form_editor = None
+
+    def createWidget(self, parent):
+        t = BECImageWidget(parent)
+        return t
+
+    def domXml(self):
+        return DOM_XML
+
+    def group(self):
+        return "BEC Plots"
+
+    def icon(self):
+        icon_path = os.path.join(MODULE_PATH, "assets", "designer_icons", "image.png")
+        return QIcon(icon_path)
+
+    def includeFile(self):
+        return "bec_image_widget"
+
+    def initialize(self, form_editor):
+        self._form_editor = form_editor
+
+    def isContainer(self):
+        return False
+
+    def isInitialized(self):
+        return self._form_editor is not None
+
+    def name(self):
+        return "BECImageWidget"
+
+    def toolTip(self):
+        return "BECImageWidget"
+
+    def whatsThis(self):
+        return self.toolTip()