bec-widgets 0.52.0__py3-none-any.whl → 0.53.0__py3-none-any.whl

bec_widgets/widgets/figure/figure.py

@@ -210,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.
@@ -262,12 +263,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
             )
         # User wants to add custom curve
         elif x is not None and y is not None and x_name is None and y_name is None:
-            waveform.add_curve_custom(
-                x=x,
-                y=y,
-                color=color,
-                label=label,
-            )
+            waveform.add_curve_custom(x=x, y=y, color=color, label=label)
 
         return waveform
 
@@ -289,6 +285,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.
@@ -352,12 +349,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         elif (
             x is not None and y is not None and x_name is None and y_name is None and z_name is None
         ):
-            waveform.add_curve_custom(
-                x=x,
-                y=y,
-                color=color,
-                label=label,
-            )
+            waveform.add_curve_custom(x=x, y=y, color=color, label=label)
         else:
             raise ValueError(
                 "Invalid input. Provide either device names (x_name, y_name) or custom data."
@@ -375,6 +367,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.
@@ -428,6 +421,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.
@@ -482,6 +476,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.
@@ -529,9 +524,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         widget_id = str(uuid.uuid4())
         if config is None:
             config = MotorMapConfig(
-                widget_class="BECMotorMap",
-                gui_id=widget_id,
-                parent_id=self.gui_id,
+                widget_class="BECMotorMap", gui_id=widget_id, parent_id=self.gui_id
             )
         motor_map = self.add_widget(
             widget_type="MotorMap",
@@ -558,6 +551,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.
@@ -620,6 +614,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.
@@ -638,6 +633,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.
         """
@@ -648,6 +644,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.
@@ -661,6 +658,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.
         """
@@ -678,6 +676,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
@@ -700,6 +699,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.

bec_widgets/widgets/monitor/config_dialog.py

@@ -113,10 +113,7 @@ CONFIG_SCAN_MODE = {
                 "sources": [
                     {
                         "type": "scan_segment",
-                        "signals": {
-                            "x": [{"name": "samy"}],
-                            "y": [{"name": "gauss_adc2"}],
-                        },
+                        "signals": {"x": [{"name": "samy"}], "y": [{"name": "gauss_adc2"}]},
                     }
                 ],
             },
@@ -172,12 +169,7 @@ CONFIG_SCAN_MODE = {
 class ConfigDialog(QWidget, Ui_Form):
     config_updated = pyqtSignal(dict)
 
-    def __init__(
-        self,
-        client=None,
-        default_config=None,
-        skip_validation: bool = False,
-    ):
+    def __init__(self, client=None, default_config=None, skip_validation: bool = False):
         super(ConfigDialog, self).__init__()
         self.setupUi(self)
 
@@ -386,15 +378,7 @@ class ConfigDialog(QWidget, Ui_Form):
             "plot_name": self.safe_text(ui.lineEdit_plot_title),
             "x_label": self.safe_text(ui.lineEdit_x_label),
             "y_label": self.safe_text(ui.lineEdit_y_label),
-            "sources": [
-                {
-                    "type": "scan_segment",
-                    "signals": {
-                        "x": x_signals,
-                        "y": y_signals,
-                    },
-                }
-            ],
+            "sources": [{"type": "scan_segment", "signals": {"x": x_signals, "y": y_signals}}],
         }
 
         return plot_data

bec_widgets/widgets/monitor/example_configs/config_device.yaml

@@ -0,0 +1,60 @@
+plot_settings:
+  background_color: "black"
+  num_columns: 2
+  colormap: "viridis"
+  scan_types: False
+
+plot_data:
+  - plot_name: "BPM4i plots vs samy"
+    x:
+      label: 'Motor Y'
+      signals:
+        - name: "samy"
+          entry: "samy"
+    y:
+      label: 'bpm4i'
+      signals:
+        - name: "bpm4i"
+          entry: "bpm4i"
+
+  - plot_name: "BPM4i plots vs samx"
+    x:
+      label: 'Motor X'
+      signals:
+        - name: "samx"
+          entry: "samx"
+    y:
+      label: 'bpm6b'
+      signals:
+        - name: "bpm6b"
+          entry: "bpm6b"
+        - name: "samy"
+          entry: "samy"
+
+  - plot_name: "Multiple Gaussian"
+    x:
+      label: 'Motor X'
+      signals:
+        - name: "samx"
+          entry: "samx"
+    y:
+      label: 'Gauss ADC'
+      signals:
+        - name: "gauss_adc1"
+          entry: "gauss_adc1"
+        - name: "gauss_adc2"
+          entry: "gauss_adc2"
+        - name: "gauss_adc3"
+          entry: "gauss_adc3"
+
+  - plot_name: "Linear Signals"
+    x:
+      label: 'Motor X'
+      signals:
+        - name: "samy"
+          entry: "samy"
+    y:
+      label: 'Motor Y'
+      signals:
+        - name: "samy"
+          entry: "samy"

bec_widgets/widgets/monitor/example_configs/config_scans.yaml

@@ -0,0 +1,92 @@
+plot_settings:
+  background_color: "black"
+  num_columns: 2
+  colormap: "plasma"
+  scan_types: True
+
+plot_data:
+  line_scan:
+
+    - plot_name: "BPM plot"
+      x:
+        label: 'Motor X'
+        signals:
+          - name: "samx"
+            entry: "samx"
+      y:
+        label: 'BPM'
+        signals:
+          - name: "gauss_bpm"
+            entry: "gauss_bpm"
+          - name: "gauss_adc1"
+            entry: "gauss_adc1"
+          - name: "gauss_adc2"
+            entry: "gauss_adc2"
+
+    - plot_name: "Multi"
+      x:
+        label: 'Motor X'
+        signals:
+          - name: "samx"
+            entry: "samx"
+      y:
+        label: 'Multi'
+        signals:
+          - name: "gauss_bpm"
+            entry: "gauss_bpm"
+          - name: "samx"
+            entry: "samx"
+
+  grid_scan:
+    - plot_name: "Grid plot 1"
+      x:
+        label: 'Motor X'
+        signals:
+          - name: "samx"
+            entry: "samx"
+      y:
+        label: 'BPM'
+        signals:
+          - name: "gauss_bpm"
+            entry: "gauss_bpm"
+          - name: "gauss_adc1"
+            entry: "gauss_adc1"
+
+    - plot_name: "Grid plot 2"
+      x:
+        label: 'Motor X'
+        signals:
+          - name: "samx"
+            entry: "samx"
+      y:
+        label: 'BPM'
+        signals:
+          - name: "gauss_bpm"
+            entry: "gauss_bpm"
+          - name: "gauss_adc1"
+            entry: "gauss_adc1"
+
+    - plot_name: "Grid plot 3"
+      x:
+        label: 'Motor Y'
+        signals:
+          - name: "samy"
+            entry: "samy"
+      y:
+        label: 'BPM'
+        signals:
+          - name: "gauss_bpm"
+            entry: "gauss_bpm"
+
+    - plot_name: "Grid plot 4"
+      x:
+        label: 'Motor Y'
+        signals:
+          - name: "samy"
+            entry: "samy"
+      y:
+        label: 'BPM'
+        signals:
+          - name: "gauss_adc3"
+            entry: "gauss_adc3"
+

bec_widgets/widgets/motor_map/motor_map.py

@@ -214,10 +214,7 @@ class MotorMap(pg.GraphicsLayoutWidget):
             endpoints.append(MessageEndpoints.device_readback(motor))
 
         # Connect all topics to a single slot
-        bec_dispatcher.connect_slot(
-            self.on_device_readback,
-            endpoints,
-        )
+        bec_dispatcher.connect_slot(self.on_device_readback, endpoints)
 
     def _add_limits_to_plot_data(self):
         """
@@ -491,11 +488,7 @@ class MotorMap(pg.GraphicsLayoutWidget):
 
                 # Update the scatter plot
                 self.curves_data[plot_name]["pos"].setData(
-                    x=motor_x_data,
-                    y=motor_y_data,
-                    brush=brushes,
-                    pen=None,
-                    size=self.scatter_size,
+                    x=motor_x_data, y=motor_y_data, brush=brushes, pen=None, size=self.scatter_size
                 )
 
                 # Get last know position for crosshair
@@ -595,11 +588,7 @@ if __name__ == "__main__":  # pragma: no cover
     client = BECDispatcher().client
     client.start()
     app = QApplication(sys.argv)
-    motor_map = MotorMap(
-        config=config,
-        gui_id=args.id,
-        skip_validation=True,
-    )
+    motor_map = MotorMap(config=config, gui_id=args.id, skip_validation=True)
     motor_map.show()
 
     sys.exit(app.exec())

bec_widgets/widgets/plots/image.py

@@ -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.
@@ -363,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.
 
@@ -381,6 +395,7 @@ class BECImageShow(BECPlotBase):
     def apply_config(self, config: dict | SubplotConfig):
         """
         Apply the configuration to the 1D waveform widget.
+
         Args:
             config(dict|SubplotConfig): Configuration settings.
             replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
@@ -416,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.
 
@@ -432,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.
@@ -473,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.
         """
@@ -574,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.
@@ -585,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.
@@ -594,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.
@@ -604,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.
@@ -614,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.
@@ -628,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.
@@ -648,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.
@@ -658,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.
@@ -668,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.
@@ -678,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.
@@ -687,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.
         """
@@ -698,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.
         """
@@ -716,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.
@@ -726,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.
         """
@@ -760,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.
@@ -778,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.
@@ -818,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.
         """
@@ -826,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.
 
@@ -837,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.
@@ -849,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.
 
@@ -860,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.
 
@@ -878,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.
 
@@ -914,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.