bec-widgets 1.4.1__py3-none-any.whl → 1.5.0__py3-none-any.whl

CHANGELOG.md

@@ -1,6 +1,24 @@
 # CHANGELOG
 
 
+## v1.5.0 (2024-11-12)
+
+### Bug Fixes
+
+- **crosshair**: Crosshair adapted for multi waveform widget
+  ([`0cd85ed`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0cd85ed9fa5b67a6ecce89985cd4f54b7bbe3a4b))
+
+### Documentation
+
+- **multi_waveform**: Docs added
+  ([`42d4f18`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/42d4f182f790a97687ca3b6d0e72866070a89767))
+
+### Features
+
+- **multi-waveform**: New widget added
+  ([`f3a39a6`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/f3a39a69e29d490b3023a508ced18028c4205772))
+
+
 ## v1.4.1 (2024-11-12)
 
 ### Bug Fixes
@@ -184,9 +202,6 @@ This property tells if expand should show a popup (by default), or if the widget
 - Emit 'device_selected' and 'scan_axis' from scan control widget
   ([`0b9b1a3`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/0b9b1a3c89a98505079f7d4078915b7bbfaa1e23))
 
-- New 'device_selected' signals to ScanControl, ScanGroupBox, DeviceLineEdit
-  ([`9801d27`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9801d2769eb0ee95c94ec0c011e1dac1407142ae))
-
 ### Refactoring
 
 - Redesign of scan selection and scan control boxes
@@ -194,16 +209,3 @@ This property tells if expand should show a popup (by default), or if the widget
 
 - Move add/remove bundle to scan group box
   ([`e3d0a7b`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/e3d0a7bbf9918dc16eb7227a178c310256ce570d))
-
-
-## v0.118.0 (2024-10-13)
-
-### Documentation
-
-- **sphinx-build**: Adjusted pyside verion
-  ([`b236951`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/b23695167ab969f754a058ffdccca2b40f00a008))
-
-### Features
-
-- **image**: Image widget can take data from monitor_1d endpoint
-  ([`9ef1d1c`](https://gitlab.psi.ch/bec/bec_widgets/-/commit/9ef1d1c9ac2178d9fa2e655942208f8abbdf5c1b))

PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: bec_widgets
-Version: 1.4.1
+Version: 1.5.0
 Summary: BEC Widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec_widgets/issues
 Project-URL: Homepage, https://gitlab.psi.ch/bec/bec_widgets

bec_widgets/cli/client.py

@@ -22,6 +22,7 @@ class Widgets(str, enum.Enum):
     BECFigure = "BECFigure"
     BECImageWidget = "BECImageWidget"
     BECMotorMapWidget = "BECMotorMapWidget"
+    BECMultiWaveformWidget = "BECMultiWaveformWidget"
     BECProgressBar = "BECProgressBar"
     BECQueue = "BECQueue"
     BECStatusBox = "BECStatusBox"
@@ -1574,6 +1575,436 @@ class BECMotorMapWidget(RPCBase):
         """
 
 
+class BECMultiWaveform(RPCBase):
+    @property
+    @rpc_call
+    def _rpc_id(self) -> "str":
+        """
+        Get the RPC ID of the widget.
+        """
+
+    @property
+    @rpc_call
+    def _config_dict(self) -> "dict":
+        """
+        Get the configuration of the widget.
+
+        Returns:
+            dict: The configuration of the widget.
+        """
+
+    @property
+    @rpc_call
+    def curves(self) -> collections.deque:
+        """
+        Get the curves of the plot widget as a deque.
+        Returns:
+            deque: Deque of curves.
+        """
+
+    @rpc_call
+    def set_monitor(self, monitor: str):
+        """
+        Set the monitor for the plot widget.
+        Args:
+            monitor (str): The monitor to set.
+        """
+
+    @rpc_call
+    def set_opacity(self, opacity: int):
+        """
+        Set the opacity of the curve on the plot.
+
+        Args:
+            opacity(int): The opacity of the curve. 0-100.
+        """
+
+    @rpc_call
+    def set_curve_limit(self, max_trace: int, flush_buffer: bool = False):
+        """
+        Set the maximum number of traces to display on the plot.
+
+        Args:
+            max_trace (int): The maximum number of traces to display.
+            flush_buffer (bool): Flush the buffer.
+        """
+
+    @rpc_call
+    def set_curve_highlight(self, index: int):
+        """
+        Set the curve highlight based on visible curves.
+
+        Args:
+            index (int): The index of the curve to highlight among visible curves.
+        """
+
+    @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(self, **kwargs) -> "None":
+        """
+        Set the properties of the plot widget.
+
+        Args:
+            **kwargs: Keyword arguments for the properties to be set.
+
+        Possible properties:
+            - title: str
+            - x_label: str
+            - y_label: str
+            - x_scale: Literal["linear", "log"]
+            - y_scale: Literal["linear", "log"]
+            - x_lim: tuple
+            - y_lim: tuple
+            - legend_label_size: int
+        """
+
+    @rpc_call
+    def set_title(self, title: "str", size: "int" = None):
+        """
+        Set the title of the plot widget.
+
+        Args:
+            title(str): Title of the plot widget.
+            size(int): Font size of the title.
+        """
+
+    @rpc_call
+    def set_x_label(self, label: "str", size: "int" = None):
+        """
+        Set the label of the x-axis.
+
+        Args:
+            label(str): Label of the x-axis.
+            size(int): Font size of the label.
+        """
+
+    @rpc_call
+    def set_y_label(self, label: "str", size: "int" = None):
+        """
+        Set the label of the y-axis.
+
+        Args:
+            label(str): Label of the y-axis.
+            size(int): Font size of the label.
+        """
+
+    @rpc_call
+    def set_x_scale(self, scale: "Literal['linear', 'log']" = "linear"):
+        """
+        Set the scale of the x-axis.
+
+        Args:
+            scale(Literal["linear", "log"]): Scale of the x-axis.
+        """
+
+    @rpc_call
+    def set_y_scale(self, scale: "Literal['linear', 'log']" = "linear"):
+        """
+        Set the scale of the y-axis.
+
+        Args:
+            scale(Literal["linear", "log"]): Scale of the y-axis.
+        """
+
+    @rpc_call
+    def set_x_lim(self, *args) -> "None":
+        """
+        Set the limits of the x-axis. This method can accept either two separate arguments
+        for the minimum and maximum x-axis values, or a single tuple containing both limits.
+
+        Usage:
+            set_x_lim(x_min, x_max)
+            set_x_lim((x_min, x_max))
+
+        Args:
+            *args: A variable number of arguments. Can be two integers (x_min and x_max)
+                   or a single tuple with two integers.
+        """
+
+    @rpc_call
+    def set_y_lim(self, *args) -> "None":
+        """
+        Set the limits of the y-axis. This method can accept either two separate arguments
+        for the minimum and maximum y-axis values, or a single tuple containing both limits.
+
+        Usage:
+            set_y_lim(y_min, y_max)
+            set_y_lim((y_min, y_max))
+
+        Args:
+            *args: A variable number of arguments. Can be two integers (y_min and y_max)
+                   or a single tuple with two integers.
+        """
+
+    @rpc_call
+    def set_grid(self, x: "bool" = False, y: "bool" = False):
+        """
+        Set the grid of the plot widget.
+
+        Args:
+            x(bool): Show grid on the x-axis.
+            y(bool): Show grid on the y-axis.
+        """
+
+    @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 enable_fps_monitor(self, enable: "bool" = True):
+        """
+        Enable the FPS monitor.
+
+        Args:
+            enable(bool): True to enable, False to disable.
+        """
+
+    @rpc_call
+    def lock_aspect_ratio(self, lock):
+        """
+        Lock aspect ratio.
+
+        Args:
+            lock(bool): True to lock, False to unlock.
+        """
+
+    @rpc_call
+    def get_all_data(self, output: Literal["dict", "pandas"] = "dict") -> dict:
+        """
+        Extract all curve data into a dictionary or a pandas DataFrame.
+
+        Args:
+            output (Literal["dict", "pandas"]): Format of the output data.
+
+        Returns:
+            dict | pd.DataFrame: Data of all curves in the specified format.
+        """
+
+    @rpc_call
+    def export(self):
+        """
+        Show the Export Dialog of the plot widget.
+        """
+
+    @rpc_call
+    def remove(self):
+        """
+        Remove the plot widget from the figure.
+        """
+
+
+class BECMultiWaveformWidget(RPCBase):
+    @property
+    @rpc_call
+    def curves(self) -> list[pyqtgraph.graphicsItems.PlotDataItem.PlotDataItem]:
+        """
+        Get the curves of the plot widget as a list
+        Returns:
+            list: List of curves.
+        """
+
+    @rpc_call
+    def set_monitor(self, monitor: str) -> None:
+        """
+        Set the monitor of the plot widget.
+
+        Args:
+            monitor(str): The monitor to set.
+        """
+
+    @rpc_call
+    def set_curve_highlight(self, index: int) -> None:
+        """
+        Set the curve highlight of the plot widget by index
+
+        Args:
+            index(int): The index of the curve to highlight.
+        """
+
+    @rpc_call
+    def set_opacity(self, opacity: int) -> None:
+        """
+        Set the opacity of the plot widget.
+
+        Args:
+            opacity(int): The opacity to set.
+        """
+
+    @rpc_call
+    def set_curve_limit(self, curve_limit: int) -> None:
+        """
+        Set the maximum number of traces to display on the plot widget.
+
+        Args:
+            curve_limit(int): The maximum number of traces to display.
+        """
+
+    @rpc_call
+    def set_buffer_flush(self, flush_buffer: bool) -> None:
+        """
+        Set the buffer flush property of the plot widget.
+
+        Args:
+            flush_buffer(bool): True to flush the buffer, False to not flush the buffer.
+        """
+
+    @rpc_call
+    def set_highlight_last_curve(self, enable: bool) -> None:
+        """
+        Enable or disable highlighting of the last curve.
+
+        Args:
+            enable(bool): True to enable highlighting of the last curve, False to disable.
+        """
+
+    @rpc_call
+    def set_colormap(self, colormap: str) -> None:
+        """
+        Set the colormap of the plot widget.
+
+        Args:
+            colormap(str): The colormap to set.
+        """
+
+    @rpc_call
+    def set(self, **kwargs):
+        """
+        Set the properties of the plot widget.
+
+        Args:
+            **kwargs: Keyword arguments for the properties to be set.
+
+        Possible properties:
+            - title: str
+            - x_label: str
+            - y_label: str
+            - x_scale: Literal["linear", "log"]
+            - y_scale: Literal["linear", "log"]
+            - x_lim: tuple
+            - y_lim: tuple
+            - legend_label_size: int
+        """
+
+    @rpc_call
+    def set_title(self, title: str):
+        """
+        Set the title of the plot widget.
+
+        Args:
+            title(str): The title to set.
+        """
+
+    @rpc_call
+    def set_x_label(self, x_label: str):
+        """
+        Set the x-axis label of the plot widget.
+
+        Args:
+            x_label(str): The x-axis label to set.
+        """
+
+    @rpc_call
+    def set_y_label(self, y_label: str):
+        """
+        Set the y-axis label of the plot widget.
+
+        Args:
+            y_label(str): The y-axis label to set.
+        """
+
+    @rpc_call
+    def set_x_scale(self, x_scale: Literal["linear", "log"]):
+        """
+        Set the x-axis scale of the plot widget.
+
+        Args:
+            x_scale(str): The x-axis scale to set.
+        """
+
+    @rpc_call
+    def set_y_scale(self, y_scale: Literal["linear", "log"]):
+        """
+        Set the y-axis scale of the plot widget.
+
+        Args:
+            y_scale(str): The y-axis scale to set.
+        """
+
+    @rpc_call
+    def set_x_lim(self, x_lim: tuple):
+        """
+        Set x-axis limits of the plot widget.
+
+        Args:
+            x_lim(tuple): The x-axis limits to set.
+        """
+
+    @rpc_call
+    def set_y_lim(self, y_lim: tuple):
+        """
+        Set y-axis limits of the plot widget.
+
+        Args:
+            y_lim(tuple): The y-axis limits to set.
+        """
+
+    @rpc_call
+    def set_grid(self, x_grid: bool, y_grid: bool):
+        """
+        Set the grid of the plot widget.
+
+        Args:
+            x_grid(bool): True to enable the x-grid, False to disable.
+            y_grid(bool): True to enable the y-grid, False to disable.
+        """
+
+    @rpc_call
+    def set_colormap(self, colormap: str) -> None:
+        """
+        Set the colormap of the plot widget.
+
+        Args:
+            colormap(str): The colormap to set.
+        """
+
+    @rpc_call
+    def enable_fps_monitor(self, enabled: bool):
+        """
+        Enable or disable the FPS monitor
+
+        Args:
+            enabled(bool): True to enable the FPS monitor, False to disable.
+        """
+
+    @rpc_call
+    def lock_aspect_ratio(self, lock: bool):
+        """
+        Lock the aspect ratio of the plot widget.
+
+        Args:
+            lock(bool): True to lock the aspect ratio, False to unlock.
+        """
+
+    @rpc_call
+    def export(self):
+        """
+        Export the plot widget.
+        """
+
+
 class BECPlotBase(RPCBase):
     @property
     @rpc_call

bec_widgets/cli/rpc_register.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from threading import Lock
 from weakref import WeakValueDictionary
 

bec_widgets/cli/rpc_wigdet_handler.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 from bec_widgets.utils import BECConnector
 
 

bec_widgets/examples/jupyter_console/jupyter_console_window.py

@@ -56,6 +56,7 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
                     # "cm": self.colormap,
                     "im": self.im,
                     "mm": self.mm,
+                    "mw": self.mw,
                 }
             )
 
@@ -167,9 +168,11 @@ class JupyterConsoleWindow(QWidget):  # pragma: no cover:
         self.im.image("waveform", "1d")
 
         self.d2 = self.dock.add_dock(name="dock_2", position="bottom")
-        self.wf = self.d2.add_widget("BECWaveformWidget", row=0, col=0)
-        self.wf.plot(x_name="samx", y_name="bpm3a")
-        self.wf.plot(x_name="samx", y_name="bpm4i", dap="GaussianModel")
+        self.wf = self.d2.add_widget("BECFigure", row=0, col=0)
+
+        self.mw = self.wf.multi_waveform(monitor="waveform")  # , config=config)
+        # self.wf.plot(x_name="samx", y_name="bpm3a")
+        # self.wf.plot(x_name="samx", y_name="bpm4i", dap="GaussianModel")
         # self.bar = self.d2.add_widget("RingProgressBar", row=0, col=1)
         # self.bar.set_diameter(200)
 
@@ -210,6 +213,7 @@ if __name__ == "__main__":  # pragma: no cover
 
     win = JupyterConsoleWindow()
     win.show()
+    win.resize(1200, 800)
 
     app.aboutToQuit.connect(win.close)
     sys.exit(app.exec_())