feat: added lineplot widget

bec_widgets/line_plot.py

@@ -0,0 +1,138 @@
+from typing import Any
+
+import numpy as np
+import pyqtgraph as pg
+from pyqtgraph import mkPen, mkBrush
+
+# from PyQt5.QtWidgets import QWidget
+from pyqtgraph.Qt import QtCore, QtWidgets, uic
+from pyqtgraph.Qt.QtCore import pyqtSignal
+import os
+
+
+class BasicPlot(QtWidgets.QWidget):
+    update_signal = pyqtSignal()
+
+    def __init__(self, name="", y_value="gauss_bpm"):
+        super(BasicPlot, self).__init__()
+        # Set style for pyqtgraph plots
+        pg.setConfigOption("background", "w")
+        pg.setConfigOption("foreground", "k")
+        current_path = os.path.dirname(__file__)
+        uic.loadUi(os.path.join(current_path, "line_plot.ui"), self)
+
+        self._idle_time = 100
+        self.title = ""
+        self.label_bottom = ""
+        self.label_left = ""
+
+        self.scan_motors = []
+        self.y_value = y_value
+        self.plotter_data_x = []
+        self.plotter_data_y = []
+        self.plotter_scan_id = None
+
+        plotstyles = {
+            "symbol": "o",
+            "symbolSize": 12,
+        }
+
+        # setup plots
+        self.plot = self.plot_window.getPlotItem()
+        self.pen = mkPen(color=(56, 76, 107), width=2, style=QtCore.Qt.DashLine)
+        self.plot_data = self.plot.plot([], [], **plotstyles, pen=self.pen, title=name)
+        self.crosshair_v = pg.InfiniteLine(angle=90, movable=False)
+        self.plot.addItem(self.crosshair_v, ignoreBounds=True)
+
+        # Add textItems
+        self.add_text_items()
+
+        # Manage signals
+        self.proxy = pg.SignalProxy(
+            self.plot.scene().sigMouseMoved, rateLimit=60, slot=self.mouse_moved
+        )
+        self.proxy_update = pg.SignalProxy(self.update_signal, rateLimit=25, slot=self.update)
+
+    def add_text_items(self):
+        self.mouse_box_data.setText("Mouse cursor")
+        self.mouse_box_data.setStyleSheet(f"QLabel {{color : rgba{self.pen.color().getRgb()}}}")
+
+    def mouse_moved(self, event):
+        pos = event[0]
+        if self.plot.sceneBoundingRect().contains(pos):
+            mousePoint = self.plot.vb.mapSceneToView(pos)
+            self.crosshair_v.setPos(mousePoint.x())
+            if self.plotter_data_x:
+                closest_point = self.closest_x_y_value(
+                    mousePoint.x(), self.plotter_data_x, self.plotter_data_y
+                )
+
+                self.mouse_box_data.setText(
+                    f"Mouse cursor\n"
+                    f"X_data: {closest_point[0]:.{self.precision}f}\n"
+                    f"Y_data: {closest_point[1]:.{self.precision}f}\n"
+                )
+
+    def closest_x_y_value(self, input_value, list_x, list_y):
+        arr = np.asarray(list_x)
+        i = (np.abs(arr - input_value)).argmin()
+        return list_x[i], list_y[i]
+
+    def update(self):
+        if len(self.plotter_data_x) <= 1:
+            return
+        self.plot.setLabel("bottom", self.label_bottom)
+        self.plot.setLabel("left", self.label_left)
+        self.plot_data.setData(self.plotter_data_x, self.plotter_data_y)
+
+    def __call__(self, data: dict, metadata: dict, **kwds: Any) -> None:
+        """Update function that is called during the scan callback. To avoid
+        too many renderings, the GUI is only processing events every <_idle_time> ms.
+
+        Args:
+            data (dict): Dictionary containing a new scan segment
+            metadata (dict): Scan metadata
+
+        """
+        if metadata["scanID"] != self.plotter_scan_id:
+            self.plotter_scan_id = metadata["scanID"]
+            self._reset_plot_data()
+
+        self.title = f"Scan {metadata['scan_number']}"
+
+        self.scan_motors = scan_motors = metadata.get("scan_report_devices")
+        client = BECClient()
+        self.precision = client.device_manager.devices[scan_motors[0]]._info["describe"][
+            scan_motors[0]
+        ]["precision"]
+        x = data["data"][scan_motors[0]][scan_motors[0]]["value"]
+        y = data["data"][self.y_value][self.y_value]["value"]
+        self.label_bottom = scan_motors[0]
+        self.label_left = self.y_value
+
+        self.plotter_data_x.append(x)
+        self.plotter_data_y.append(y)
+        if len(self.plotter_data_x) <= 1:
+            return
+        self.update_signal.emit()
+
+    def _reset_plot_data(self):
+        self.plotter_data_x = []
+        self.plotter_data_y = []
+        self.plot_data.setData([], [])
+        self.mouse_box_data.setText("Mouse cursor")  # Crashes the Thread
+
+
+if __name__ == "__main__":
+    print("main")
+    from bec_lib import BECClient
+    from bec_widgets import ctrl_c
+
+    client = BECClient()
+    client.start()
+    app = QtWidgets.QApplication([])
+    ctrl_c.setup(app)
+    plot = BasicPlot()
+    plot.show()
+    client.callbacks.register("scan_segment", plot, sync=False)
+    app.exec_()

bec_widgets/line_plot.ui

@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>layout</class>
+ <widget class="QWidget" name="layout">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>800</width>
+    <height>600</height>
+   </rect>
+  </property>
+  <property name="windowTitle">
+   <string>Form</string>
+  </property>
+  <property name="autoFillBackground">
+   <bool>false</bool>
+  </property>
+  <property name="styleSheet">
+   <string notr="true">background-color: rgb(255, 255, 255);
+border-color: rgb(166, 166, 166);</string>
+  </property>
+  <layout class="QHBoxLayout" name="layout_2">
+   <item>
+    <widget class="PlotWidget" name="plot_window" native="true"/>
+   </item>
+   <item>
+    <spacer name="Spacer">
+     <property name="orientation">
+      <enum>Qt::Horizontal</enum>
+     </property>
+     <property name="sizeType">
+      <enum>QSizePolicy::Fixed</enum>
+     </property>
+     <property name="sizeHint" stdset="0">
+      <size>
+       <width>10</width>
+       <height>10</height>
+      </size>
+     </property>
+    </spacer>
+   </item>
+   <item>
+    <widget class="QLabel" name="mouse_box_data">
+     <property name="sizePolicy">
+      <sizepolicy hsizetype="Fixed" vsizetype="Preferred">
+       <horstretch>0</horstretch>
+       <verstretch>0</verstretch>
+      </sizepolicy>
+     </property>
+     <property name="text">
+      <string>TextLabel</string>
+     </property>
+    </widget>
+   </item>
+  </layout>
+ </widget>
+ <customwidgets>
+  <customwidget>
+   <class>PlotWidget</class>
+   <extends>QWidget</extends>
+   <header>pyqtgraph</header>
+   <container>1</container>
+  </customwidget>
+ </customwidgets>
+ <resources/>
+ <connections/>
+</ui>