bec-widgets 0.44.5__py3-none-any.whl → 0.46.0__py3-none-any.whl

bec_widgets/cli/client.py

@@ -142,9 +142,12 @@ class BECWaveform1D(RPCBase):
         self,
         x_name: "str",
         y_name: "str",
+        z_name: "Optional[str]" = None,
         x_entry: "Optional[str]" = None,
         y_entry: "Optional[str]" = None,
+        z_entry: "Optional[str]" = None,
         color: "Optional[str]" = None,
+        color_map_z: "Optional[str]" = "plasma",
         label: "Optional[str]" = None,
         validate_bec: "bool" = True,
         **kwargs
@@ -156,7 +159,10 @@ class BECWaveform1D(RPCBase):
             x_entry(str): Entry of the x signal.
             y_name(str): Name of the y signal.
             y_entry(str): Entry of the y signal.
+            z_name(str): Name of the z signal.
+            z_entry(str): Entry of the z signal.
             color(str, optional): Color of the curve. Defaults to None.
+            color_map_z(str): The color map to use for the z-axis.
             label(str, optional): Label of the curve. Defaults to None.
             **kwargs: Additional keyword arguments for the curve configuration.
 
@@ -404,11 +410,14 @@ class BECFigure(RPCBase, BECFigureClientMixin):
         self,
         x_name: "str" = None,
         y_name: "str" = None,
+        z_name: "str" = None,
         x_entry: "str" = None,
         y_entry: "str" = None,
+        z_entry: "str" = None,
         x: "list | np.ndarray" = None,
         y: "list | np.ndarray" = None,
         color: "Optional[str]" = None,
+        color_map_z: "Optional[str]" = "plasma",
         label: "Optional[str]" = None,
         validate: "bool" = True,
         row: "int" = None,
@@ -450,22 +459,48 @@ class BECFigure(RPCBase, BECFigureClientMixin):
             row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
             col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
             config(dict): Additional configuration for the widget.
-            **axis_kwargs:
+            **axis_kwargs: Additional axis properties to set on the widget after creation.
 
         Returns:
             BECImageShow: The image widget.
         """
 
+    @rpc_call
+    def add_motor_map(
+        self,
+        motor_x: "str" = None,
+        motor_y: "str" = None,
+        row: "int" = None,
+        col: "int" = None,
+        config=None,
+        **axis_kwargs
+    ) -> "BECMotorMap":
+        """
+        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.
+            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
+            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
+            config(dict): Additional configuration for the widget.
+            **axis_kwargs:
+
+        Returns:
+            BECMotorMap: The motor map widget.
+        """
+
     @rpc_call
     def plot(
         self,
         x_name: "str" = None,
         y_name: "str" = None,
+        z_name: "str" = None,
         x_entry: "str" = None,
         y_entry: "str" = None,
+        z_entry: "str" = None,
         x: "list | np.ndarray" = None,
         y: "list | np.ndarray" = None,
         color: "Optional[str]" = None,
+        color_map_z: "Optional[str]" = "plasma",
         label: "Optional[str]" = None,
         validate: "bool" = True,
         **axis_kwargs
@@ -475,11 +510,14 @@ class BECFigure(RPCBase, BECFigureClientMixin):
         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.
+            z_name(str): The name of the device for the z-axis.
             x_entry(str): The name of the entry for the x-axis.
             y_entry(str): The name of the entry for the y-axis.
+            z_entry(str): The name of the entry for the z-axis.
             x(list | np.ndarray): Custom x data to plot.
             y(list | np.ndarray): Custom y data to plot.
             color(str): The color of the curve.
+            color_map_z(str): The color map to use for the z-axis.
             label(str): The label of the curve.
             validate(bool): If True, validate the device names and entries.
             **axis_kwargs: Additional axis properties to set on the widget after creation.
@@ -512,6 +550,21 @@ class BECFigure(RPCBase, BECFigureClientMixin):
             BECImageShow: The image widget.
         """
 
+    @rpc_call
+    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.
+            **axis_kwargs: Additional axis properties to set on the widget after creation.
+
+        Returns:
+            BECMotorMap: The motor map widget.
+        """
+
     @rpc_call
     def remove(
         self,
@@ -596,6 +649,14 @@ class BECCurve(RPCBase):
             symbol_color(str, optional): Color of the symbol. Defaults to None.
         """
 
+    @rpc_call
+    def set_colormap(self, colormap: "str"):
+        """
+        Set the colormap for the scatter plot z gradient.
+        Args:
+            colormap(str): Colormap for the scatter plot.
+        """
+
     @rpc_call
     def set_symbol(self, symbol: "str"):
         """
@@ -1091,3 +1152,64 @@ class BECImageItem(RPCBase):
         Returns:
             dict: The configuration of the plot widget.
         """
+
+
+class BECMotorMap(RPCBase):
+    @rpc_call
+    def change_motors(
+        self,
+        motor_x: "str",
+        motor_y: "str",
+        motor_x_entry: "str" = None,
+        motor_y_entry: "str" = None,
+        validate_bec: "bool" = True,
+    ) -> "None":
+        """
+        Change the active motors for the plot.
+        Args:
+            motor_x(str): Motor name for the X axis.
+            motor_y(str): Motor name for the Y axis.
+            motor_x_entry(str): Motor entry for the X axis.
+            motor_y_entry(str): Motor entry for the Y axis.
+            validate_bec(bool, optional): If True, validate the signal with BEC. Defaults to True.
+        """
+
+    @rpc_call
+    def set_max_points(self, max_points: "int") -> "None":
+        """
+        Set the maximum number of points to display.
+        Args:
+            max_points(int): Maximum number of points to display.
+        """
+
+    @rpc_call
+    def set_precision(self, precision: "int") -> "None":
+        """
+        Set the decimal precision of the motor position.
+        Args:
+            precision(int): Decimal precision of the motor position.
+        """
+
+    @rpc_call
+    def set_num_dim_points(self, num_dim_points: "int") -> "None":
+        """
+        Set the number of dim points for the motor map.
+        Args:
+            num_dim_points(int): Number of dim points.
+        """
+
+    @rpc_call
+    def set_background_value(self, background_value: "int") -> "None":
+        """
+        Set the background value of the motor map.
+        Args:
+            background_value(int): Background value of the motor map.
+        """
+
+    @rpc_call
+    def set_scatter_size(self, scatter_size: "int") -> "None":
+        """
+        Set the scatter size of the motor map plot.
+        Args:
+            scatter_size(int): Size of the scatter points.
+        """

bec_widgets/cli/generate_cli.py

@@ -109,20 +109,21 @@ if __name__ == "__main__":  # pragma: no cover
 
     from bec_widgets.utils import BECConnector
     from bec_widgets.widgets.figure import BECFigure
-    from bec_widgets.widgets.plots import BECImageShow, BECPlotBase, BECWaveform1D
+    from bec_widgets.widgets.plots import BECImageShow, BECMotorMap, BECPlotBase, BECWaveform
     from bec_widgets.widgets.plots.image import BECImageItem
-    from bec_widgets.widgets.plots.waveform1d import BECCurve
+    from bec_widgets.widgets.plots.waveform import BECCurve
 
     current_path = os.path.dirname(__file__)
     client_path = os.path.join(current_path, "client.py")
     clss = [
         BECPlotBase,
-        BECWaveform1D,
+        BECWaveform,
         BECFigure,
         BECCurve,
         BECImageShow,
         BECConnector,
         BECImageItem,
+        BECMotorMap,
     ]
     generator = ClientGenerator()
     generator.generate_client(clss)

bec_widgets/cli/server.py

@@ -6,11 +6,11 @@ from qtpy.QtCore import QTimer
 from bec_widgets.utils import BECDispatcher
 from bec_widgets.utils.bec_connector import BECConnector
 from bec_widgets.widgets.figure import BECFigure
-from bec_widgets.widgets.plots import BECCurve, BECImageShow, BECWaveform1D
+from bec_widgets.widgets.plots import BECCurve, BECImageShow, BECWaveform
 
 
 class BECWidgetsCLIServer:
-    WIDGETS = [BECWaveform1D, BECFigure, BECCurve, BECImageShow]
+    WIDGETS = [BECWaveform, BECFigure, BECCurve, BECImageShow]
 
     def __init__(self, gui_id: str = None, dispatcher: BECDispatcher = None) -> None:
         self.dispatcher = BECDispatcher() if dispatcher is None else dispatcher

bec_widgets/widgets/__init__.py

@@ -1,7 +1,6 @@
 from .editor import BECEditor
 from .figure import BECFigure, FigureConfig
 from .monitor import BECMonitor
-from .monitor_scatter_2D import BECMonitor2DScatter
 from .motor_control import (
     MotorControlAbsolute,
     MotorControlRelative,
@@ -10,5 +9,5 @@ from .motor_control import (
     MotorThread,
 )
 from .motor_map import MotorMap
-from .plots import BECCurve, BECPlotBase, BECWaveform1D
+from .plots import BECCurve, BECMotorMap, BECWaveform
 from .scan_control import ScanControl

bec_widgets/widgets/figure/figure.py

@@ -17,12 +17,14 @@ from qtpy.QtWidgets import QApplication, QMainWindow, QVBoxLayout, QWidget
 from bec_widgets.utils import BECConnector, BECDispatcher, ConnectionConfig
 from bec_widgets.widgets.plots import (
     BECImageShow,
+    BECMotorMap,
     BECPlotBase,
-    BECWaveform1D,
+    BECWaveform,
     Waveform1DConfig,
     WidgetConfig,
 )
 from bec_widgets.widgets.plots.image import ImageConfig
+from bec_widgets.widgets.plots.motor_map import MotorMapConfig
 
 
 class FigureConfig(ConnectionConfig):
@@ -42,8 +44,9 @@ class WidgetHandler:
     def __init__(self):
         self.widget_factory = {
             "PlotBase": (BECPlotBase, WidgetConfig),
-            "Waveform1D": (BECWaveform1D, Waveform1DConfig),
+            "Waveform1D": (BECWaveform, Waveform1DConfig),
             "ImShow": (BECImageShow, ImageConfig),
+            "MotorMap": (BECMotorMap, MotorMapConfig),
         }
 
     def create_widget(
@@ -98,8 +101,10 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         "widgets",
         "add_plot",
         "add_image",
+        "add_motor_map",
         "plot",
         "image",
+        "motor_map",
         "remove",
         "change_layout",
         "change_theme",
@@ -159,18 +164,21 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         self,
         x_name: str = None,
         y_name: str = None,
+        z_name: str = None,
         x_entry: str = None,
         y_entry: str = None,
+        z_entry: str = None,
         x: list | np.ndarray = None,
         y: list | np.ndarray = None,
         color: Optional[str] = None,
+        color_map_z: Optional[str] = "plasma",
         label: Optional[str] = None,
         validate: bool = True,
         row: int = None,
         col: int = None,
         config=None,
         **axis_kwargs,
-    ) -> BECWaveform1D:
+    ) -> BECWaveform:
         """
         Add a Waveform1D plot to the figure at the specified position.
         Args:
@@ -192,8 +200,8 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
 
         # TODO remove repetition from .plot method
 
-        # User wants to add scan curve
-        if x_name is not None and y_name is not None and x is None and y is None:
+        # User wants to add scan curve -> 1D Waveform
+        if x_name is not None and y_name is not None and z_name is None and x is None and y is None:
             waveform.add_curve_scan(
                 x_name=x_name,
                 y_name=y_name,
@@ -203,7 +211,27 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
                 color=color,
                 label=label,
             )
-            # User wants to add custom curve
+        # User wants to add scan curve -> 2D Waveform Scatter
+        if (
+            x_name is not None
+            and y_name is not None
+            and z_name is not None
+            and x is None
+            and y is None
+        ):
+            waveform.add_curve_scan(
+                x_name=x_name,
+                y_name=y_name,
+                z_name=z_name,
+                x_entry=x_entry,
+                y_entry=y_entry,
+                z_entry=z_entry,
+                color=color,
+                color_map=color_map_z,
+                label=label,
+                validate=validate,
+            )
+        # 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,
@@ -218,52 +246,81 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
         self,
         x_name: str = None,
         y_name: str = None,
+        z_name: str = None,
         x_entry: str = None,
         y_entry: str = None,
+        z_entry: str = None,
         x: list | np.ndarray = None,
         y: list | np.ndarray = None,
         color: Optional[str] = None,
+        color_map_z: Optional[str] = "plasma",
         label: Optional[str] = None,
         validate: bool = True,
         **axis_kwargs,
-    ) -> BECWaveform1D:
+    ) -> 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.
+            z_name(str): The name of the device for the z-axis.
             x_entry(str): The name of the entry for the x-axis.
             y_entry(str): The name of the entry for the y-axis.
+            z_entry(str): The name of the entry for the z-axis.
             x(list | np.ndarray): Custom x data to plot.
             y(list | np.ndarray): Custom y data to plot.
             color(str): The color of the curve.
+            color_map_z(str): The color map to use for the z-axis.
             label(str): The label of the curve.
             validate(bool): If True, validate the device names and entries.
             **axis_kwargs: Additional axis properties to set on the widget after creation.
 
         Returns:
-            BECWaveform1D: The waveform plot widget.
+            BECWaveform: The waveform plot widget.
         """
-        waveform = self._find_first_widget_by_class(BECWaveform1D, can_fail=True)
+        waveform = self._find_first_widget_by_class(BECWaveform, can_fail=True)
         if waveform is not None:
             if axis_kwargs:
                 waveform.set(**axis_kwargs)
         else:
             waveform = self.add_plot(**axis_kwargs)
 
-        # User wants to add scan curve
-        if x_name is not None and y_name is not None and x is None and y is None:
+        # User wants to add scan curve -> 1D Waveform
+        if x_name is not None and y_name is not None and z_name is None and x is None and y is None:
             waveform.add_curve_scan(
                 x_name=x_name,
                 y_name=y_name,
                 x_entry=x_entry,
                 y_entry=y_entry,
+                color=color,
+                color_map_z="plasma",
+                label=label,
                 validate=validate,
+            )
+        # User wants to add scan curve -> 2D Waveform Scatter
+        elif (
+            x_name is not None
+            and y_name is not None
+            and z_name is not None
+            and x is None
+            and y is None
+        ):
+            waveform.add_curve_scan(
+                x_name=x_name,
+                y_name=y_name,
+                z_name=z_name,
+                x_entry=x_entry,
+                y_entry=y_entry,
+                z_entry=z_entry,
                 color=color,
+                color_map=color_map_z,
                 label=label,
+                validate=validate,
             )
         # 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:
+        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,
@@ -347,7 +404,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
             row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
             col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
             config(dict): Additional configuration for the widget.
-            **axis_kwargs:
+            **axis_kwargs: Additional axis properties to set on the widget after creation.
 
         Returns:
             BECImageShow: The image widget.
@@ -389,6 +446,72 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
 
         return image
 
+    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.
+            **axis_kwargs: Additional axis properties to set on the widget after creation.
+
+        Returns:
+            BECMotorMap: The motor map widget.
+        """
+        motor_map = self._find_first_widget_by_class(BECMotorMap, can_fail=True)
+        if motor_map is not None:
+            if axis_kwargs:
+                motor_map.set(**axis_kwargs)
+        else:
+            motor_map = self.add_motor_map(**axis_kwargs)
+
+        if motor_x is not None and motor_y is not None:
+            motor_map.change_motors(motor_x, motor_y)
+
+        return motor_map
+
+    def add_motor_map(
+        self,
+        motor_x: str = None,
+        motor_y: str = None,
+        row: int = None,
+        col: int = None,
+        config=None,
+        **axis_kwargs,
+    ) -> BECMotorMap:
+        """
+
+        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.
+            row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
+            col(int): The column coordinate of the widget in the figure. If not provided, the next empty column will be used.
+            config(dict): Additional configuration for the widget.
+            **axis_kwargs:
+
+        Returns:
+            BECMotorMap: The motor map widget.
+        """
+        widget_id = self._generate_unique_widget_id()
+        if config is None:
+            config = MotorMapConfig(
+                widget_class="BECMotorMap",
+                gui_id=widget_id,
+                parent_id=self.gui_id,
+            )
+        motor_map = self.add_widget(
+            widget_type="MotorMap",
+            widget_id=widget_id,
+            row=row,
+            col=col,
+            config=config,
+            **axis_kwargs,
+        )
+
+        if motor_x is not None and motor_y is not None:
+            motor_map.change_motors(motor_x, motor_y)
+
+        return motor_map
+
     def add_widget(
         self,
         widget_type: Literal["PlotBase", "Waveform1D", "ImShow"] = "PlotBase",
@@ -746,7 +869,8 @@ class DebugWindow(QWidget):  # pragma: no cover:
         self.console.set_default_style("linux")
 
     def _init_figure(self):
-        self.figure.add_widget(widget_type="Waveform1D", row=0, col=0, title="Widget 1")
+        # self.figure.add_widget(widget_type="Waveform1D", row=0, col=0, title="Widget 1")
+        self.figure.plot("samx", "bpm4d")
         self.figure.add_widget(widget_type="Waveform1D", row=0, col=1, title="Widget 2")
         self.figure.add_image(
             title="Image", row=1, col=0, color_map="viridis", color_bar="simple", vrange=(0, 100)
@@ -759,14 +883,16 @@ class DebugWindow(QWidget):  # pragma: no cover:
         self.w4 = self.figure[1, 1]
 
         # curves for w1
-        self.w1.add_curve_scan("samx", "bpm4i", pen_style="dash")
-        self.w1.add_curve_custom(
-            x=[1, 2, 3, 4, 5],
-            y=[1, 2, 3, 4, 5],
-            label="curve-custom",
-            color="blue",
-            pen_style="dashdot",
-        )
+        self.w1.add_curve_scan("samx", "samy", "bpm4i", pen_style="dash")
+        self.w1.add_curve_scan("samx", "samy", "bpm3a", pen_style="dash")
+
+        # self.w1.add_curve_custom(
+        #     x=[1, 2, 3, 4, 5],
+        #     y=[1, 2, 3, 4, 5],
+        #     label="curve-custom",
+        #     color="blue",
+        #     pen_style="dashdot",
+        # )
         self.c1 = self.w1.get_config()
 
         # curves for w2

bec_widgets/widgets/plots/__init__.py

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