bec-widgets 0.51.0__py3-none-any.whl → 0.52.1__py3-none-any.whl

bec_widgets/widgets/figure/figure.py

@@ -1,27 +1,25 @@
 # pylint: disable = no-name-in-module,missing-module-docstring
 from __future__ import annotations
 
-import itertools
-import os
+import uuid
 from collections import defaultdict
-from typing import Literal, Optional, Type
+from typing import Literal, Optional
 
 import numpy as np
 import pyqtgraph as pg
 import qdarktheme
 from pydantic import Field
-from pyqtgraph.Qt import uic
 from qtpy.QtCore import Signal as pyqtSignal
-from qtpy.QtWidgets import QApplication, QMainWindow, QVBoxLayout, QWidget
+from qtpy.QtWidgets import QWidget
 
-from bec_widgets.utils import BECConnector, BECDispatcher, ConnectionConfig, WidgetContainerUtils
+from bec_widgets.utils import BECConnector, ConnectionConfig, WidgetContainerUtils
 from bec_widgets.widgets.plots import (
     BECImageShow,
     BECMotorMap,
     BECPlotBase,
     BECWaveform,
+    SubplotConfig,
     Waveform1DConfig,
-    WidgetConfig,
 )
 from bec_widgets.widgets.plots.image import ImageConfig
 from bec_widgets.widgets.plots.motor_map import MotorMapConfig
@@ -33,7 +31,7 @@ class FigureConfig(ConnectionConfig):
     theme: Literal["dark", "light"] = Field("dark", description="The theme of the figure widget.")
     num_cols: int = Field(1, description="The number of columns in the figure widget.")
     num_rows: int = Field(1, description="The number of rows in the figure widget.")
-    widgets: dict[str, WidgetConfig] = Field(
+    widgets: dict[str, SubplotConfig] = Field(
         {}, description="The list of widgets to be added to the figure widget."
     )
 
@@ -43,7 +41,7 @@ class WidgetHandler:
 
     def __init__(self):
         self.widget_factory = {
-            "PlotBase": (BECPlotBase, WidgetConfig),
+            "PlotBase": (BECPlotBase, SubplotConfig),
             "Waveform1D": (BECWaveform, Waveform1DConfig),
             "ImShow": (BECImageShow, ImageConfig),
             "MotorMap": (BECMotorMap, MotorMapConfig),
@@ -166,14 +164,29 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
 
     @widget_list.setter
     def widget_list(self, value: list[BECPlotBase]):
+        """
+        Access all widget in BECFigure as a list
+        Returns:
+            list[BECPlotBase]: List of all widgets in the figure.
+        """
         self._axes = value
 
     @property
     def widgets(self) -> dict:
+        """
+        All widgets within the figure with gui ids as keys.
+        Returns:
+            dict: All widgets within the figure.
+        """
         return self._widgets
 
     @widgets.setter
     def widgets(self, value: dict):
+        """
+        All widgets within the figure with gui ids as keys.
+        Returns:
+            dict: All widgets within the figure.
+        """
         self._widgets = value
 
     def add_plot(
@@ -197,6 +210,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECWaveform:
         """
         Add a Waveform1D plot to the figure at the specified position.
+
         Args:
             widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
             row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
@@ -204,7 +218,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
             config(dict): Additional configuration for the widget.
             **axis_kwargs(dict): Additional axis properties to set on the widget after creation.
         """
-        widget_id = WidgetContainerUtils.generate_unique_widget_id(self._widgets)
+        widget_id = str(uuid.uuid4())
         waveform = self.add_widget(
             widget_type="Waveform1D",
             widget_id=widget_id,
@@ -276,6 +290,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECWaveform:
         """
         Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
+
         Args:
             x_name(str): The name of the device for the x-axis.
             y_name(str): The name of the device for the y-axis.
@@ -362,6 +377,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECImageShow:
         """
         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.
@@ -415,6 +431,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECImageShow:
         """
         Add an image to the figure at the specified position.
+
         Args:
             monitor(str): The name of the monitor to display.
             color_bar(Literal["simple","full"]): The type of color bar to display.
@@ -430,7 +447,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
             BECImageShow: The image widget.
         """
 
-        widget_id = WidgetContainerUtils.generate_unique_widget_id(self._widgets)
+        widget_id = str(uuid.uuid4())
         if config is None:
             config = ImageConfig(
                 widget_class="BECImageShow",
@@ -469,6 +486,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def motor_map(self, motor_x: str = None, motor_y: str = None, **axis_kwargs) -> BECMotorMap:
         """
         Add a motor map to the figure. Always access the first motor map widget in the figure.
+
         Args:
             motor_x(str): The name of the motor for the X axis.
             motor_y(str): The name of the motor for the Y axis.
@@ -513,7 +531,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         Returns:
             BECMotorMap: The motor map widget.
         """
-        widget_id = WidgetContainerUtils.generate_unique_widget_id(self._widgets)
+        widget_id = str(uuid.uuid4())
         if config is None:
             config = MotorMapConfig(
                 widget_class="BECMotorMap",
@@ -545,6 +563,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> BECPlotBase:
         """
         Add a widget to the figure at the specified position.
+
         Args:
             widget_type(Literal["PlotBase","Waveform1D"]): The type of the widget to add.
             widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
@@ -554,7 +573,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
             **axis_kwargs(dict): Additional axis properties to set on the widget after creation.
         """
         if not widget_id:
-            widget_id = WidgetContainerUtils.generate_unique_widget_id(self._widgets)
+            widget_id = str(uuid.uuid4())
         if widget_id in self._widgets:
             raise ValueError(f"Widget with ID '{widget_id}' already exists.")
 
@@ -607,6 +626,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     ) -> None:
         """
         Remove a widget from the figure. Can be removed by its unique identifier or by its coordinates.
+
         Args:
             row(int): The row coordinate of the widget to remove.
             col(int): The column coordinate of the widget to remove.
@@ -625,6 +645,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def change_theme(self, theme: Literal["dark", "light"]) -> None:
         """
         Change the theme of the figure widget.
+
         Args:
             theme(Literal["dark","light"]): The theme to set for the figure widget.
         """
@@ -635,6 +656,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def _remove_by_coordinates(self, row: int, col: int) -> None:
         """
         Remove a widget from the figure by its coordinates.
+
         Args:
             row(int): The row coordinate of the widget to remove.
             col(int): The column coordinate of the widget to remove.
@@ -648,6 +670,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def _remove_by_id(self, widget_id: str) -> None:
         """
         Remove a widget from the figure by its unique identifier.
+
         Args:
             widget_id(str): The unique identifier of the widget to remove.
         """
@@ -665,6 +688,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def axes(self, row: int, col: int) -> BECPlotBase:
         """
         Get widget by its coordinates in the figure.
+
         Args:
             row(int): the row coordinate
             col(int): the column coordinate
@@ -687,6 +711,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
     def _change_grid(self, widget_id: str, row: int, col: int):
         """
         Change the grid to reflect the new position of the widget.
+
         Args:
             widget_id(str): The unique identifier of the widget.
             row(int): The new row coordinate of the widget in the figure.
@@ -767,12 +792,16 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
 
     def clear_all(self):
         """Clear all widgets from the figure and reset to default state"""
-        for widget in self._widgets.values():
-            widget.cleanup()
-        self.clear()
+        for widget in list(self._widgets.values()):
+            widget.remove()
+        # self.clear()
         self._widgets = defaultdict(dict)
         self.grid = []
         theme = self.config.theme
         self.config = FigureConfig(
             widget_class=self.__class__.__name__, gui_id=self.gui_id, theme=theme
         )
+
+    def cleanup(self):
+        self.clear_all()
+        super().cleanup()

bec_widgets/widgets/plots/__init__.py

@@ -1,4 +1,4 @@
 from .image import BECImageItem, BECImageShow, ImageItemConfig
 from .motor_map import BECMotorMap, MotorMapConfig
-from .plot_base import AxisConfig, BECPlotBase, WidgetConfig
+from .plot_base import AxisConfig, BECPlotBase, SubplotConfig
 from .waveform import BECCurve, BECWaveform, Waveform1DConfig

bec_widgets/widgets/plots/image.py

@@ -14,7 +14,7 @@ from qtpy.QtWidgets import QWidget
 
 from bec_widgets.utils import BECConnector, ConnectionConfig, EntryValidator
 
-from .plot_base import BECPlotBase, WidgetConfig
+from .plot_base import BECPlotBase, SubplotConfig
 
 
 class ProcessingConfig(BaseModel):
@@ -50,7 +50,7 @@ class ImageItemConfig(ConnectionConfig):
     )
 
 
-class ImageConfig(WidgetConfig):
+class ImageConfig(SubplotConfig):
     images: dict[str, ImageItemConfig] = Field(
         {},
         description="The configuration of the images. The key is the name of the image (source).",
@@ -112,8 +112,10 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set(self, **kwargs):
         """
         Set the properties of the image.
+
         Args:
             **kwargs: Keyword arguments for the properties to be set.
+
         Possible properties:
             - downsample
             - color_map
@@ -145,6 +147,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_fft(self, enable: bool = False):
         """
         Set the FFT of the image.
+
         Args:
             enable(bool): Whether to perform FFT on the monitor data.
         """
@@ -153,6 +156,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_log(self, enable: bool = False):
         """
         Set the log of the image.
+
         Args:
             enable(bool): Whether to perform log on the monitor data.
         """
@@ -163,6 +167,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_rotation(self, deg_90: int = 0):
         """
         Set the rotation of the image.
+
         Args:
             deg_90(int): The rotation angle of the monitor data before displaying.
         """
@@ -171,6 +176,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_transpose(self, enable: bool = False):
         """
         Set the transpose of the image.
+
         Args:
             enable(bool): Whether to transpose the image.
         """
@@ -179,6 +185,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_opacity(self, opacity: float = 1.0):
         """
         Set the opacity of the image.
+
         Args:
             opacity(float): The opacity of the image.
         """
@@ -188,6 +195,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_autorange(self, autorange: bool = False):
         """
         Set the autorange of the color bar.
+
         Args:
             autorange(bool): Whether to autorange the color bar.
         """
@@ -198,6 +206,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_color_map(self, cmap: str = "magma"):
         """
         Set the color map of the image.
+
         Args:
             cmap(str): The color map of the image.
         """
@@ -212,6 +221,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_auto_downsample(self, auto: bool = True):
         """
         Set the auto downsample of the image.
+
         Args:
             auto(bool): Whether to downsample the image.
         """
@@ -221,6 +231,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_monitor(self, monitor: str):
         """
         Set the monitor of the image.
+
         Args:
             monitor(str): The name of the monitor.
         """
@@ -229,6 +240,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     def set_vrange(self, vmin: float = None, vmax: float = None, vrange: tuple[int, int] = None):
         """
         Set the range of the color bar.
+
         Args:
             vmin(float): Minimum value of the color bar.
             vmax(float): Maximum value of the color bar.
@@ -258,6 +270,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
     ):
         """
         Add color bar to the layout.
+
         Args:
             style(Literal["simple,full"]): The style of the color bar.
             vrange(tuple[int,int]): The range of the color bar.
@@ -288,10 +301,6 @@ class BECImageItem(BECConnector, pg.ImageItem):
         else:
             raise ValueError("style should be 'simple' or 'full'")
 
-    def cleanup(self):
-        """Clean up widget."""
-        self.rpc_register.remove_rpc(self)
-
 
 class BECImageShow(BECPlotBase):
     USER_ACCESS = [
@@ -367,6 +376,7 @@ class BECImageShow(BECPlotBase):
     def find_image_by_monitor(self, item_id: str) -> BECImageItem:
         """
         Find the widget by its gui_id.
+
         Args:
             item_id(str): The gui_id of the widget.
 
@@ -382,11 +392,12 @@ class BECImageShow(BECPlotBase):
                     if result is not None:
                         return result
 
-    def apply_config(self, config: dict | WidgetConfig):
+    def apply_config(self, config: dict | SubplotConfig):
         """
         Apply the configuration to the 1D waveform widget.
+
         Args:
-            config(dict|WidgetConfig): Configuration settings.
+            config(dict|SubplotConfig): Configuration settings.
             replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
         """
         if isinstance(config, dict):
@@ -420,6 +431,7 @@ class BECImageShow(BECPlotBase):
     def add_image_by_config(self, config: ImageItemConfig | dict) -> BECImageItem:
         """
         Add an image to the widget by configuration.
+
         Args:
             config(ImageItemConfig|dict): The configuration of the image.
 
@@ -436,6 +448,7 @@ class BECImageShow(BECPlotBase):
     def get_image_config(self, image_id, dict_output: bool = True) -> ImageItemConfig | dict:
         """
         Get the configuration of the image.
+
         Args:
             image_id(str): The ID of the image.
             dict_output(bool): Whether to return the configuration as a dictionary. Defaults to True.
@@ -477,6 +490,7 @@ class BECImageShow(BECPlotBase):
     def get_image_dict(self) -> dict[str, dict[str, BECImageItem]]:
         """
         Get all images.
+
         Returns:
             dict[str, dict[str, BECImageItem]]: The dictionary of images.
         """
@@ -578,6 +592,7 @@ class BECImageShow(BECPlotBase):
         """
         Set the range of the color bar.
         If name is not specified, then set vrange for all images.
+
         Args:
             vmin(float): Minimum value of the color bar.
             vmax(float): Maximum value of the color bar.
@@ -589,6 +604,7 @@ class BECImageShow(BECPlotBase):
         """
         Set the color map of the image.
         If name is not specified, then set color map for all images.
+
         Args:
             cmap(str): The color map of the image.
             name(str): The name of the image. If None, apply to all images.
@@ -598,6 +614,7 @@ class BECImageShow(BECPlotBase):
     def set_autorange(self, enable: bool = False, name: str = None):
         """
         Set the autoscale of the image.
+
         Args:
             enable(bool): Whether to autoscale the color bar.
             name(str): The name of the image. If None, apply to all images.
@@ -608,6 +625,7 @@ class BECImageShow(BECPlotBase):
         """
         Set the monitor of the image.
         If name is not specified, then set monitor for all images.
+
         Args:
             monitor(str): The name of the monitor.
             name(str): The name of the image. If None, apply to all images.
@@ -618,6 +636,7 @@ class BECImageShow(BECPlotBase):
         """
         Set the post processing of the image.
         If name is not specified, then set post processing for all images.
+
         Args:
             name(str): The name of the image. If None, apply to all images.
             **kwargs: Keyword arguments for the properties to be set.
@@ -632,6 +651,7 @@ class BECImageShow(BECPlotBase):
     def set_image_properties(self, name: str = None, **kwargs):
         """
         Set the properties of the image.
+
         Args:
             name(str): The name of the image. If None, apply to all images.
             **kwargs: Keyword arguments for the properties to be set.
@@ -652,6 +672,7 @@ class BECImageShow(BECPlotBase):
         """
         Set the FFT of the image.
         If name is not specified, then set FFT for all images.
+
         Args:
             enable(bool): Whether to perform FFT on the monitor data.
             name(str): The name of the image. If None, apply to all images.
@@ -662,6 +683,7 @@ class BECImageShow(BECPlotBase):
         """
         Set the log of the image.
         If name is not specified, then set log for all images.
+
         Args:
             enable(bool): Whether to perform log on the monitor data.
             name(str): The name of the image. If None, apply to all images.
@@ -672,6 +694,7 @@ class BECImageShow(BECPlotBase):
         """
         Set the rotation of the image.
         If name is not specified, then set rotation for all images.
+
         Args:
             deg_90(int): The rotation angle of the monitor data before displaying.
             name(str): The name of the image. If None, apply to all images.
@@ -682,6 +705,7 @@ class BECImageShow(BECPlotBase):
         """
         Set the transpose of the image.
         If name is not specified, then set transpose for all images.
+
         Args:
             enable(bool): Whether to transpose the monitor data before displaying.
             name(str): The name of the image. If None, apply to all images.
@@ -691,6 +715,7 @@ class BECImageShow(BECPlotBase):
     def toggle_threading(self, use_threading: bool):
         """
         Toggle threading for the widgets postprocessing and updating.
+
         Args:
             use_threading(bool): Whether to use threading.
         """
@@ -702,6 +727,7 @@ class BECImageShow(BECPlotBase):
     def on_image_update(self, msg: dict):
         """
         Update the image of the device monitor from bec.
+
         Args:
             msg(dict): The message from bec.
         """
@@ -720,6 +746,7 @@ class BECImageShow(BECPlotBase):
     def update_image(self, device: str, data: np.ndarray):
         """
         Update the image of the device monitor.
+
         Args:
             device(str): The name of the device.
             data(np.ndarray): The data to be updated.
@@ -730,6 +757,7 @@ class BECImageShow(BECPlotBase):
     def _connect_device_monitor(self, monitor: str):
         """
         Connect to the device monitor.
+
         Args:
             monitor(str): The name of the monitor.
         """
@@ -764,6 +792,7 @@ class BECImageShow(BECPlotBase):
     def _check_image_id(self, val: Any, dict_to_check: dict) -> bool:
         """
         Check if val is in the values of the dict_to_check or in the values of the nested dictionaries.
+
         Args:
             val(Any): Value to check.
             dict_to_check(dict): Dictionary to check.
@@ -782,6 +811,7 @@ class BECImageShow(BECPlotBase):
     def _validate_monitor(self, monitor: str, validate_bec: bool = True):
         """
         Validate the monitor name.
+
         Args:
             monitor(str): The name of the monitor.
             validate_bec(bool): Whether to validate the monitor name with BEC.
@@ -806,7 +836,7 @@ class BECImageShow(BECPlotBase):
         for image in self.images:
             image.cleanup()
 
-        self.rpc_register.remove_rpc(self)
+        super().cleanup()
 
 
 class ImageProcessor:
@@ -822,6 +852,7 @@ class ImageProcessor:
     def set_config(self, config: ProcessingConfig):
         """
         Set the configuration of the processor.
+
         Args:
             config(ProcessingConfig): The configuration of the processor.
         """
@@ -830,6 +861,7 @@ class ImageProcessor:
     def FFT(self, data: np.ndarray) -> np.ndarray:
         """
         Perform FFT on the data.
+
         Args:
             data(np.ndarray): The data to be processed.
 
@@ -841,6 +873,7 @@ class ImageProcessor:
     def rotation(self, data: np.ndarray, rotate_90: int) -> np.ndarray:
         """
         Rotate the data by 90 degrees n times.
+
         Args:
             data(np.ndarray): The data to be processed.
             rotate_90(int): The number of 90 degree rotations.
@@ -853,6 +886,7 @@ class ImageProcessor:
     def transpose(self, data: np.ndarray) -> np.ndarray:
         """
         Transpose the data.
+
         Args:
             data(np.ndarray): The data to be processed.
 
@@ -864,6 +898,7 @@ class ImageProcessor:
     def log(self, data: np.ndarray) -> np.ndarray:
         """
         Perform log on the data.
+
         Args:
             data(np.ndarray): The data to be processed.
 
@@ -882,6 +917,7 @@ class ImageProcessor:
     def process_image(self, data: np.ndarray) -> np.ndarray:
         """
         Process the data according to the configuration.
+
         Args:
             data(np.ndarray): The data to be processed.
 
@@ -918,6 +954,7 @@ class ProcessorWorker(QObject):
     def process_image(self, device: str, image: np.ndarray):
         """
         Process the image data.
+
         Args:
             device(str): The name of the device.
             image(np.ndarray): The image data.