From 8fee13a67bef3ed6ed6de9d47438f04687f548d8 Mon Sep 17 00:00:00 2001 From: appel_c Date: Mon, 17 Jul 2023 19:02:52 +0200 Subject: [PATCH 1/8] feat: added ctrl_c from grum --- bec_widgets/ctrl_c.py | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 bec_widgets/ctrl_c.py diff --git a/bec_widgets/ctrl_c.py b/bec_widgets/ctrl_c.py new file mode 100644 index 00000000..d3e7fe47 --- /dev/null +++ b/bec_widgets/ctrl_c.py @@ -0,0 +1,38 @@ +import signal +import socket +from PyQt5.QtNetwork import QAbstractSocket + + +def setup(app): + app.signalwatchdog = SignalWatchdog() # need to store to keep socket pair alive + signal.signal(signal.SIGINT, make_quit_handler(app)) + + +def make_quit_handler(app): + def handler(*args): + print() # make ^C appear on its own line + app.quit() + + return handler + + +class SignalWatchdog(QAbstractSocket): + def __init__(self): + """ + Propagates system signals from Python to QEventLoop + adapted from https://stackoverflow.com/a/65802260/655404 + """ + super().__init__(QAbstractSocket.SctpSocket, None) + + self.writer, self.reader = writer, reader = socket.socketpair() + writer.setblocking(False) + + fd_writer = writer.fileno() + fd_reader = reader.fileno() + + signal.set_wakeup_fd(fd_writer) # Python hook + self.setSocketDescriptor(fd_reader) # Qt hook + + self.readyRead.connect( + lambda: None + ) # dummy function call that lets the Python interpreter run From 989a3f080839b98f1e1c2118600cddf449120124 Mon Sep 17 00:00:00 2001 From: appel_c Date: Mon, 17 Jul 2023 19:03:20 +0200 Subject: [PATCH 2/8] feat: added lineplot widget --- bec_widgets/line_plot.py | 138 +++++++++++++++++++++++++++++++++++++++ bec_widgets/line_plot.ui | 68 +++++++++++++++++++ 2 files changed, 206 insertions(+) create mode 100644 bec_widgets/line_plot.py create mode 100644 bec_widgets/line_plot.ui diff --git a/bec_widgets/line_plot.py b/bec_widgets/line_plot.py new file mode 100644 index 00000000..b7e9d795 --- /dev/null +++ b/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_() diff --git a/bec_widgets/line_plot.ui b/bec_widgets/line_plot.ui new file mode 100644 index 00000000..f38d7fb7 --- /dev/null +++ b/bec_widgets/line_plot.ui @@ -0,0 +1,68 @@ + + + layout + + + + 0 + 0 + 800 + 600 + + + + Form + + + false + + + background-color: rgb(255, 255, 255); +border-color: rgb(166, 166, 166); + + + + + + + + + Qt::Horizontal + + + QSizePolicy::Fixed + + + + 10 + 10 + + + + + + + + + 0 + 0 + + + + TextLabel + + + + + + + + PlotWidget + QWidget +
pyqtgraph
+ 1 + + + + + From 10e29064455f50bc3b66c55b4361575957db1489 Mon Sep 17 00:00:00 2001 From: appel_c Date: Tue, 18 Jul 2023 12:39:41 +0200 Subject: [PATCH 3/8] feat: add functionality for plotting multiple signals --- bec_widgets/line_plot.py | 91 +++++++++++++++++++++++++++++----------- 1 file changed, 67 insertions(+), 24 deletions(-) diff --git a/bec_widgets/line_plot.py b/bec_widgets/line_plot.py index b7e9d795..a8101ea2 100644 --- a/bec_widgets/line_plot.py +++ b/bec_widgets/line_plot.py @@ -4,7 +4,6 @@ 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 @@ -13,7 +12,7 @@ import os class BasicPlot(QtWidgets.QWidget): update_signal = pyqtSignal() - def __init__(self, name="", y_value="gauss_bpm"): + def __init__(self, name="", y_value_list=["gauss_bpm"]): super(BasicPlot, self).__init__() # Set style for pyqtgraph plots pg.setConfigOption("background", "w") @@ -27,20 +26,39 @@ class BasicPlot(QtWidgets.QWidget): self.label_left = "" self.scan_motors = [] - self.y_value = y_value + self.y_value_list = y_value_list self.plotter_data_x = [] self.plotter_data_y = [] + self.curves = [] + self.pens = [] + self.plotter_scan_id = None + # TODO to be moved to utils function plotstyles = { "symbol": "o", "symbolSize": 12, } + color_list = ["#384c6b", "#e28a2b", "#5E3023", "#e41a1c", "#984e83", "#4daf4a"] # 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) + for ii in range(len(self.y_value_list)): + if ii < len(color_list): + pen = mkPen(color=color_list[ii], width=2, style=QtCore.Qt.DashLine) + else: + pen = mkPen( + color=list(np.random.choice(range(255), size=3)), + width=2, + style=QtCore.Qt.DashLine, + ) + curve = pg.ScatterPlotItem(**plotstyles, pen=pen, skipFiniteCheck=True) + self.plot.addItem(curve) + self.curves.append(curve) + self.pens.append(pen) + + # self.plot.plot(**plotstyles) + # 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) @@ -55,7 +73,7 @@ class BasicPlot(QtWidgets.QWidget): 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()}}}") + # self.mouse_box_data.setStyleSheet(f"QLabel {{color : rgba{self.pens[0].color().getRgb()}}}") def mouse_moved(self, event): pos = event[0] @@ -63,15 +81,28 @@ class BasicPlot(QtWidgets.QWidget): 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" - ) + self.mouse_box_data.setText("Mouse cursor") + for ii, y_value in enumerate(self.y_value_list): + closest_point = self.closest_x_y_value( + mousePoint.x(), self.plotter_data_x, self.plotter_data_y[ii] + ) + self.mouse_box_data.setText( + "".join( + [ + self.mouse_box_data.text(), + "\n", + f"", # rgba{self.pens[ii].color().getRgb() + f"{y_value}", + "\n", + f"X_data: {closest_point[0]:.{self.precision}f}", + "\n", + f"Y_data: {closest_point[1]:.{self.precision}f}

", + ] + ) + # f"Mouse cursor\n" + # \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) @@ -83,7 +114,8 @@ class BasicPlot(QtWidgets.QWidget): 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) + for ii in range(len(self.y_value_list)): + self.curves[ii].setData(self.plotter_data_x, self.plotter_data_y[ii]) def __call__(self, data: dict, metadata: dict, **kwds: Any) -> None: """Update function that is called during the scan callback. To avoid @@ -105,13 +137,16 @@ class BasicPlot(QtWidgets.QWidget): self.precision = client.device_manager.devices[scan_motors[0]]._info["describe"][ scan_motors[0] ]["precision"] + # TODO + # self.precision = client.device_manager.devices[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) + for ii, y_value in enumerate(self.y_value_list): + y = data["data"][y_value][y_value]["value"] + self.plotter_data_y[ii].append(y) + self.label_bottom = scan_motors[0] + self.label_left = f"{', '.join(self.y_value_list)}" + if len(self.plotter_data_x) <= 1: return self.update_signal.emit() @@ -119,20 +154,28 @@ class BasicPlot(QtWidgets.QWidget): def _reset_plot_data(self): self.plotter_data_x = [] self.plotter_data_y = [] - self.plot_data.setData([], []) + for ii in range(len(self.y_value_list)): + self.curves[ii].setData([], []) + self.plotter_data_y.append([]) self.mouse_box_data.setText("Mouse cursor") # Crashes the Thread if __name__ == "__main__": - print("main") + import argparse from bec_lib import BECClient from bec_widgets import ctrl_c + parser = argparse.ArgumentParser() + parser.add_argument( + "--signals", help="specify recorded signals", nargs="+", default=["gauss_bpm"] + ) + value = parser.parse_args() + print(f"Plotting signals for: {', '.join(value.signals)}") client = BECClient() client.start() app = QtWidgets.QApplication([]) ctrl_c.setup(app) - plot = BasicPlot() + plot = BasicPlot(y_value_list=value.signals) plot.show() client.callbacks.register("scan_segment", plot, sync=False) app.exec_() From 3e1708bf48bc15a25c0d01242fff28d6db868e02 Mon Sep 17 00:00:00 2001 From: appel_c Date: Tue, 18 Jul 2023 14:16:25 +0200 Subject: [PATCH 4/8] feat: add auto-computed color_list from colormaps --- bec_widgets/line_plot.py | 64 ++++++++++++++++++++++++++++++++++------ 1 file changed, 55 insertions(+), 9 deletions(-) diff --git a/bec_widgets/line_plot.py b/bec_widgets/line_plot.py index a8101ea2..3ea01d5b 100644 --- a/bec_widgets/line_plot.py +++ b/bec_widgets/line_plot.py @@ -2,7 +2,7 @@ from typing import Any import numpy as np import pyqtgraph as pg -from pyqtgraph import mkPen, mkBrush +from pyqtgraph import mkPen, mkBrush, mkColor from pyqtgraph.Qt import QtCore, QtWidgets, uic from pyqtgraph.Qt.QtCore import pyqtSignal @@ -31,31 +31,37 @@ class BasicPlot(QtWidgets.QWidget): self.plotter_data_y = [] self.curves = [] self.pens = [] + self.brushs = [] self.plotter_scan_id = None # TODO to be moved to utils function plotstyles = { "symbol": "o", - "symbolSize": 12, + "symbolSize": 10, } color_list = ["#384c6b", "#e28a2b", "#5E3023", "#e41a1c", "#984e83", "#4daf4a"] + color_list = BasicPlot.golden_angle_color(colormap="viridis", num=len(self.y_value_list)) # setup plots self.plot = self.plot_window.getPlotItem() for ii in range(len(self.y_value_list)): if ii < len(color_list): pen = mkPen(color=color_list[ii], width=2, style=QtCore.Qt.DashLine) + brush = mkBrush(color=color_list[ii]) else: + color = list(np.random.choice(range(255), size=3)) pen = mkPen( - color=list(np.random.choice(range(255), size=3)), + color=color, width=2, style=QtCore.Qt.DashLine, ) - curve = pg.ScatterPlotItem(**plotstyles, pen=pen, skipFiniteCheck=True) + brush = mkBrush(color=color) + curve = pg.PlotDataItem(**plotstyles, symbolBrush=brush, pen=pen, skipFiniteCheck=True) self.plot.addItem(curve) self.curves.append(curve) self.pens.append(pen) + self.brushs.append(brush) # self.plot.plot(**plotstyles) # self.plot_data = self.plot.plot([], [], **plotstyles, pen=self.pen, title=name) @@ -86,17 +92,22 @@ class BasicPlot(QtWidgets.QWidget): closest_point = self.closest_x_y_value( mousePoint.x(), self.plotter_data_x, self.plotter_data_y[ii] ) + # TODO fix text wobble in plot, see plot when it crosses 0 + x_data = f"{closest_point[0]:.{self.precision}f}" + y_data = f"{closest_point[1]:.{self.precision}f}" + string_cap = 10 self.mouse_box_data.setText( "".join( [ self.mouse_box_data.text(), "\n", - f"", # rgba{self.pens[ii].color().getRgb() + # TODO fix different fonts for mouse cursor! + # f"", # rgba{self.pens[ii].color().getRgb() f"{y_value}", "\n", - f"X_data: {closest_point[0]:.{self.precision}f}", + f"X_data: {x_data:>string_cap}", "\n", - f"Y_data: {closest_point[1]:.{self.precision}f}

", + f"Y_data: {y_data:>string_cap}", ] ) # f"Mouse cursor\n" @@ -137,7 +148,7 @@ class BasicPlot(QtWidgets.QWidget): self.precision = client.device_manager.devices[scan_motors[0]]._info["describe"][ scan_motors[0] ]["precision"] - # TODO + # TODO after update of bec_lib, this will be new way to access data # self.precision = client.device_manager.devices[scan_motors[0]].precision x = data["data"][scan_motors[0]][scan_motors[0]]["value"] self.plotter_data_x.append(x) @@ -159,6 +170,38 @@ class BasicPlot(QtWidgets.QWidget): self.plotter_data_y.append([]) self.mouse_box_data.setText("Mouse cursor") # Crashes the Thread + @staticmethod + def golden_ratio(num: int): + # get the first num golden angles + phi = 2 * np.pi * ((1 + np.sqrt(5)) / 2) + angles = [] + for ii in range(num): + x = np.cos(ii * phi) + y = np.sin(ii * phi) + angle = np.arctan2(y, x) + angles.append(angle) + return angles + + @staticmethod + def golden_angle_color(colormap: str, num: int): + cmap = pg.colormap.get(colormap) + cmap_colors = cmap.color + if num > len(cmap_colors): + raise ValueError( + f"Number of colors requested ({num}) is greater than the number of colors in the colormap ({len(cmap_colors)})" + ) + angles = BasicPlot.golden_ratio(len(cmap_colors)) + color_selection = np.round(np.interp(angles, (-np.pi, np.pi), (0, len(cmap_colors)))) + colors = [ + mkColor(tuple((cmap_colors[int(ii)] * 255).astype(int))) for ii in color_selection[:num] + ] + return colors + + @staticmethod + def rgb_to_hex(rgb: np.ndarray) -> str: + rgb = rgb.reshape(3) + return "#{:02X}{:02X}{:02X}".format(*rgb) + if __name__ == "__main__": import argparse @@ -167,7 +210,10 @@ if __name__ == "__main__": parser = argparse.ArgumentParser() parser.add_argument( - "--signals", help="specify recorded signals", nargs="+", default=["gauss_bpm"] + "--signals", + help="specify recorded signals", + nargs="+", + default=["gauss_bpm", "bpm4i", "bpm5i", "bpm6i"], ) value = parser.parse_args() print(f"Plotting signals for: {', '.join(value.signals)}") From a460f3c0bd7b9e106a758bc330f361868407b1e3 Mon Sep 17 00:00:00 2001 From: appel_c Date: Tue, 18 Jul 2023 16:51:48 +0200 Subject: [PATCH 5/8] fix: documentation and bugfix for mouse_moved --- bec_widgets/line_plot.py | 77 ++++++++++++++++++++++++++++++---------- 1 file changed, 58 insertions(+), 19 deletions(-) diff --git a/bec_widgets/line_plot.py b/bec_widgets/line_plot.py index 3ea01d5b..3d327227 100644 --- a/bec_widgets/line_plot.py +++ b/bec_widgets/line_plot.py @@ -12,7 +12,15 @@ import os class BasicPlot(QtWidgets.QWidget): update_signal = pyqtSignal() - def __init__(self, name="", y_value_list=["gauss_bpm"]): + def __init__(self, name="", y_value_list=["gauss_bpm"]) -> None: + """ + Basic plot widget for displaying scan data. + + Args: + name (str, optional): Name of the plot. Defaults to "". + y_value_list (list, optional): List of signals to be plotted. Defaults to ["gauss_bpm"]. + """ + super(BasicPlot, self).__init__() # Set style for pyqtgraph plots pg.setConfigOption("background", "w") @@ -41,7 +49,7 @@ class BasicPlot(QtWidgets.QWidget): "symbolSize": 10, } color_list = ["#384c6b", "#e28a2b", "#5E3023", "#e41a1c", "#984e83", "#4daf4a"] - color_list = BasicPlot.golden_angle_color(colormap="viridis", num=len(self.y_value_list)) + color_list = BasicPlot.golden_angle_color(colormap="CET-R2", num=len(self.y_value_list)) # setup plots self.plot = self.plot_window.getPlotItem() @@ -63,8 +71,6 @@ class BasicPlot(QtWidgets.QWidget): self.pens.append(pen) self.brushs.append(brush) - # self.plot.plot(**plotstyles) - # 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) @@ -78,10 +84,20 @@ class BasicPlot(QtWidgets.QWidget): self.proxy_update = pg.SignalProxy(self.update_signal, rateLimit=25, slot=self.update) def add_text_items(self): + """Add text items to the plot""" + self.mouse_box_data.setText("Mouse cursor") + # TODO Via StyleSheet, one may set the color of the full QLabel # self.mouse_box_data.setStyleSheet(f"QLabel {{color : rgba{self.pens[0].color().getRgb()}}}") - def mouse_moved(self, event): + def mouse_moved(self, event: tuple) -> None: + """ + Update the mouse box with the current mouse position and the corresponding data. + + Args: + event (tuple): Mouse event containing the position of the mouse cursor. + The position is stored in first entry as horizontal, vertical pixel. + """ pos = event[0] if self.plot.sceneBoundingRect().contains(pos): mousePoint = self.plot.vb.mapSceneToView(pos) @@ -105,22 +121,31 @@ class BasicPlot(QtWidgets.QWidget): # f"", # rgba{self.pens[ii].color().getRgb() f"{y_value}", "\n", - f"X_data: {x_data:>string_cap}", + f"X_data: {x_data:>{string_cap}}", "\n", - f"Y_data: {y_data:>string_cap}", + f"Y_data: {y_data:>{string_cap}}", ] ) - # f"Mouse cursor\n" - # \n" - # f"Y_data: {closest_point[1]:.{self.precision}f}\n" ) - def closest_x_y_value(self, input_value, list_x, list_y): + def closest_x_y_value(self, input_value, list_x, list_y) -> tuple: + """ + Find the closest x and y value to the input value. + + Args: + input_value (float): Input value + list_x (list): List of x values + list_y (list): List of y values + + Returns: + tuple: Closest x and y value + """ arr = np.asarray(list_x) i = (np.abs(arr - input_value)).argmin() return list_x[i], list_y[i] def update(self): + """Update the plot with the new data.""" if len(self.plotter_data_x) <= 1: return self.plot.setLabel("bottom", self.label_bottom) @@ -163,6 +188,7 @@ class BasicPlot(QtWidgets.QWidget): self.update_signal.emit() def _reset_plot_data(self): + """Reset the plot data.""" self.plotter_data_x = [] self.plotter_data_y = [] for ii in range(len(self.y_value_list)): @@ -171,8 +197,12 @@ class BasicPlot(QtWidgets.QWidget): self.mouse_box_data.setText("Mouse cursor") # Crashes the Thread @staticmethod - def golden_ratio(num: int): - # get the first num golden angles + def golden_ratio(num: int) -> list: + """Calculate the golden ratio for a given number of angles. + + Args: + num (int): Number of angles + """ phi = 2 * np.pi * ((1 + np.sqrt(5)) / 2) angles = [] for ii in range(num): @@ -183,7 +213,21 @@ class BasicPlot(QtWidgets.QWidget): return angles @staticmethod - def golden_angle_color(colormap: str, num: int): + def golden_angle_color(colormap: str, num: int) -> list: + """ + Extract num colors for from the specified colormap following golden angle distribution. + + Args: + colormap (str): Name of the colormap + num (int): Number of requested colors + + Returns: + list: List of colors with length + + Raises: + ValueError: If the number of requested colors is greater than the number of colors in the colormap. + """ + cmap = pg.colormap.get(colormap) cmap_colors = cmap.color if num > len(cmap_colors): @@ -197,11 +241,6 @@ class BasicPlot(QtWidgets.QWidget): ] return colors - @staticmethod - def rgb_to_hex(rgb: np.ndarray) -> str: - rgb = rgb.reshape(3) - return "#{:02X}{:02X}{:02X}".format(*rgb) - if __name__ == "__main__": import argparse From 48075e4fe3187f6ac8d0b61f94f8df73b8fd6daf Mon Sep 17 00:00:00 2001 From: appel_c Date: Tue, 18 Jul 2023 21:52:59 +0200 Subject: [PATCH 6/8] fix: add warning for non-existing signalz --- bec_widgets/line_plot.py | 89 ++++++++++++++++++++++------------------ 1 file changed, 48 insertions(+), 41 deletions(-) diff --git a/bec_widgets/line_plot.py b/bec_widgets/line_plot.py index 3d327227..71e2976f 100644 --- a/bec_widgets/line_plot.py +++ b/bec_widgets/line_plot.py @@ -1,4 +1,5 @@ from typing import Any +import warnings import numpy as np import pyqtgraph as pg @@ -6,6 +7,7 @@ from pyqtgraph import mkPen, mkBrush, mkColor from pyqtgraph.Qt import QtCore, QtWidgets, uic from pyqtgraph.Qt.QtCore import pyqtSignal +from bec_lib import BECClient import os @@ -54,17 +56,8 @@ class BasicPlot(QtWidgets.QWidget): # setup plots self.plot = self.plot_window.getPlotItem() for ii in range(len(self.y_value_list)): - if ii < len(color_list): - pen = mkPen(color=color_list[ii], width=2, style=QtCore.Qt.DashLine) - brush = mkBrush(color=color_list[ii]) - else: - color = list(np.random.choice(range(255), size=3)) - pen = mkPen( - color=color, - width=2, - style=QtCore.Qt.DashLine, - ) - brush = mkBrush(color=color) + pen = mkPen(color=color_list[ii], width=2, style=QtCore.Qt.DashLine) + brush = mkBrush(color=color_list[ii]) curve = pg.PlotDataItem(**plotstyles, symbolBrush=brush, pen=pen, skipFiniteCheck=True) self.plot.addItem(curve) self.curves.append(curve) @@ -99,34 +92,37 @@ class BasicPlot(QtWidgets.QWidget): The position is stored in first entry as horizontal, vertical pixel. """ 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: - self.mouse_box_data.setText("Mouse cursor") - for ii, y_value in enumerate(self.y_value_list): - closest_point = self.closest_x_y_value( - mousePoint.x(), self.plotter_data_x, self.plotter_data_y[ii] - ) - # TODO fix text wobble in plot, see plot when it crosses 0 - x_data = f"{closest_point[0]:.{self.precision}f}" - y_data = f"{closest_point[1]:.{self.precision}f}" - string_cap = 10 - self.mouse_box_data.setText( - "".join( - [ - self.mouse_box_data.text(), - "\n", - # TODO fix different fonts for mouse cursor! - # f"", # rgba{self.pens[ii].color().getRgb() - f"{y_value}", - "\n", - f"X_data: {x_data:>{string_cap}}", - "\n", - f"Y_data: {y_data:>{string_cap}}", - ] - ) - ) + if not self.plot.sceneBoundingRect().contains(pos): + return + mousePoint = self.plot.vb.mapSceneToView(pos) + self.crosshair_v.setPos(mousePoint.x()) + if not self.plotter_data_x: + return + self.mouse_box_data.setText("Mouse cursor") + + for ii, y_value in enumerate(self.y_value_list): + closest_point = self.closest_x_y_value( + mousePoint.x(), self.plotter_data_x, self.plotter_data_y[ii] + ) + # TODO fix text wobble in plot, see plot when it crosses 0 + x_data = f"{closest_point[0]:.{self.precision}f}" + y_data = f"{closest_point[1]:.{self.precision}f}" + string_cap = 10 + self.mouse_box_data.setText( + "".join( + [ + self.mouse_box_data.text(), + "\n", + # TODO fix different fonts for mouse cursor! + # f"", # rgba{self.pens[ii].color().getRgb() + f"{y_value}", + "\n", + f"X_data: {x_data:>{string_cap}}", + "\n", + f"Y_data: {y_data:>{string_cap}}", + ] + ) + ) def closest_x_y_value(self, input_value, list_x, list_y) -> tuple: """ @@ -170,6 +166,18 @@ class BasicPlot(QtWidgets.QWidget): self.scan_motors = scan_motors = metadata.get("scan_report_devices") client = BECClient() + remove_y_value_index = [ + index + for index, y_value in enumerate(self.y_value_list) + if y_value not in client.device_manager.devices.keys() + ] + if remove_y_value_index: + for ii in sorted(remove_y_value_index, reverse=True): + # TODO Use bec warning message??? to be discussed with Klaus + warnings.warn( + f"Warning: no matching signal for {self.y_value_list[ii]} found in list of devices. Removing from plot." + ) + self.y_value_list.pop(ii) self.precision = client.device_manager.devices[scan_motors[0]]._info["describe"][ scan_motors[0] ]["precision"] @@ -244,7 +252,6 @@ class BasicPlot(QtWidgets.QWidget): if __name__ == "__main__": import argparse - from bec_lib import BECClient from bec_widgets import ctrl_c parser = argparse.ArgumentParser() @@ -252,7 +259,7 @@ if __name__ == "__main__": "--signals", help="specify recorded signals", nargs="+", - default=["gauss_bpm", "bpm4i", "bpm5i", "bpm6i"], + default=["gauss_bpm", "bpm4i", "bpm5i", "bpm6i", "xert"], ) value = parser.parse_args() print(f"Plotting signals for: {', '.join(value.signals)}") From d37fbf5c4f0f413e5b295566027293be3b10b6af Mon Sep 17 00:00:00 2001 From: appel_c Date: Tue, 18 Jul 2023 21:54:01 +0200 Subject: [PATCH 7/8] test: add test for line_plot --- tests/test_line_plot.py | 146 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 146 insertions(+) create mode 100644 tests/test_line_plot.py diff --git a/tests/test_line_plot.py b/tests/test_line_plot.py new file mode 100644 index 00000000..53aebb5e --- /dev/null +++ b/tests/test_line_plot.py @@ -0,0 +1,146 @@ +from pytestqt import qtbot +from unittest import mock +from bec_widgets import line_plot +import numpy as np + + +def test_line_plot_emits_no_signal(qtbot): + """Test LinePlot emits no signal when only one data entry is present.""" + + y_value_list = ["y1", "y2"] + plot = line_plot.BasicPlot(y_value_list=y_value_list) + data = { + "data": { + "x": {"x": {"value": 1}}, + "y1": {"y1": {"value": 1}}, + "y2": {"y2": {"value": 3}}, + } + } + metadata = {"scanID": "test", "scan_number": 1, "scan_report_devices": ["x"]} + with mock.patch("bec_widgets.line_plot.BECClient") as mock_client: + with mock.patch.object(plot, "update_signal") as mock_update_signal: + plot(data=data, metadata=metadata) + mock_update_signal.emit.assert_not_called() + + +def test_line_plot_emits_signal(qtbot): + """Test LinePlot emits signal.""" + + y_value_list = ["y1", "y2"] + plot = line_plot.BasicPlot(y_value_list=y_value_list) + data = { + "data": { + "x": {"x": {"value": 1}}, + "y1": {"y1": {"value": 1}}, + "y2": {"y2": {"value": 3}}, + } + } + plotter_data_y = [[1, 1], [3, 3]] + metadata = {"scanID": "test", "scan_number": 1, "scan_report_devices": ["x"]} + with mock.patch("bec_widgets.line_plot.BECClient") as mock_client: + # mock_client.device_manager.devices.keys.return_value = ["y1"] + with mock.patch.object(plot, "update_signal") as mock_update_signal: + mock_update_signal.emit() + plot(data=data, metadata=metadata) + plot(data=data, metadata=metadata) + mock_update_signal.emit.assert_called() + # TODO allow mock_client to create return values for device_manager_devices + # assert plot.plotter_data_y == plotter_data_y + + +def test_line_plot_raise_warning_wrong_signal_request(qtbot): + """Test LinePlot raises warning and skips signal when entry not present in data.""" + + y_value_list = ["y1", "y22"] + plot = line_plot.BasicPlot(y_value_list=y_value_list) + data = { + "data": { + "x": {"x": {"value": [1, 2, 3, 4, 5]}}, + "y1": {"y1": {"value": [1, 2, 3, 4, 5]}}, + "y2": {"y2": {"value": [1, 2, 3, 4, 5]}}, + } + } + metadata = {"scanID": "test", "scan_number": 1, "scan_report_devices": ["x"]} + with mock.patch("bec_widgets.line_plot.BECClient") as mock_client: + # TODO fix mock_client + mock_client.device_manager.devices.keys.return_value = ["y1"] + # = {"y1": [1, 2]} + with mock.patch.object(plot, "update_signal") as mock_update_signal: + mock_update_signal.emit() + plot(data=data, metadata=metadata) + assert all(plot.y_value_list == ["y1"]) + + +def test_line_plot_update(qtbot): + """Test LinePlot update.""" + + y_value_list = ["y1", "y2"] + plot = line_plot.BasicPlot(y_value_list=y_value_list) + plot.label_bottom = "x" + plot.label_left = f"{', '.join(y_value_list)}" + plot.plotter_data_x = [1, 2, 3, 4, 5] + plot.plotter_data_y = [[1, 2, 3, 4, 5], [3, 4, 5, 6, 7]] + plot.update() + + assert all(plot.curves[0].getData()[0] == np.array([1, 2, 3, 4, 5])) + assert all(plot.curves[0].getData()[1] == np.array([1, 2, 3, 4, 5])) + assert all(plot.curves[1].getData()[1] == np.array([3, 4, 5, 6, 7])) + + +# TODO Outputting the wrong data, e.g. motor is not in list of devices +def test_line_plot_update(qtbot): + """Test LinePlot update.""" + + y_value_list = ["y1", "y2"] + plot = line_plot.BasicPlot(y_value_list=y_value_list) + plot.label_bottom = "x" + plot.label_left = f"{', '.join(y_value_list)}" + plot.plotter_data_x = [1, 2, 3, 4, 5] + plot.plotter_data_y = [[1, 2, 3, 4, 5], [3, 4, 5, 6, 7]] + plot.update() + + assert all(plot.curves[0].getData()[0] == np.array([1, 2, 3, 4, 5])) + assert all(plot.curves[0].getData()[1] == np.array([1, 2, 3, 4, 5])) + assert all(plot.curves[1].getData()[1] == np.array([3, 4, 5, 6, 7])) + + +def test_line_plot_mouse_moved(qtbot): + """Test LinePlot mouse_moved.""" + + y_value_list = ["y1", "y2"] + plot = line_plot.BasicPlot(y_value_list=y_value_list) + plot.plotter_data_x = [1, 2, 3, 4, 5] + plot.plotter_data_y = [[1, 2, 3, 4, 5], [3, 4, 5, 6, 7]] + plot.precision = 3 + string_cap = 10 + x_data = f"{3:.{plot.precision}f}" + y_data = f"{3:.{plot.precision}f}" + output_string = "".join( + [ + "Mouse cursor", + "\n", + f"{y_value_list[0]}", + "\n", + f"X_data: {x_data:>{string_cap}}", + "\n", + f"Y_data: {y_data:>{string_cap}}", + ] + ) + x_data = f"{3:.{plot.precision}f}" + y_data = f"{5:.{plot.precision}f}" + output_string = "".join( + [ + output_string, + "\n", + f"{y_value_list[1]}", + "\n", + f"X_data: {x_data:>{string_cap}}", + "\n", + f"Y_data: {y_data:>{string_cap}}", + ] + ) + with mock.patch.object(plot, "plot") as mock_plot: + mock_plot.sceneBoundingRect.contains.return_value = True + mock_plot.vb.mapSceneToView((20, 10)).x.return_value = 2.8 + plot.mouse_moved((20, 10)) + assert plot.mouse_box_data.text() == output_string From 9883caa1b3c114e5d0e50014b8f1546bdd59b350 Mon Sep 17 00:00:00 2001 From: Klaus Wakonig Date: Wed, 19 Jul 2023 10:06:21 +0200 Subject: [PATCH 8/8] test: fixed client mock --- bec_widgets/line_plot.py | 12 ++++++------ tests/test_line_plot.py | 12 ++++++++---- 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/bec_widgets/line_plot.py b/bec_widgets/line_plot.py index 71e2976f..33b310a0 100644 --- a/bec_widgets/line_plot.py +++ b/bec_widgets/line_plot.py @@ -1,14 +1,13 @@ -from typing import Any +import os import warnings +from typing import Any import numpy as np import pyqtgraph as pg -from pyqtgraph import mkPen, mkBrush, mkColor - +from bec_lib import BECClient +from pyqtgraph import mkBrush, mkColor, mkPen from pyqtgraph.Qt import QtCore, QtWidgets, uic from pyqtgraph.Qt.QtCore import pyqtSignal -from bec_lib import BECClient -import os class BasicPlot(QtWidgets.QWidget): @@ -169,7 +168,7 @@ class BasicPlot(QtWidgets.QWidget): remove_y_value_index = [ index for index, y_value in enumerate(self.y_value_list) - if y_value not in client.device_manager.devices.keys() + if y_value not in client.device_manager.devices ] if remove_y_value_index: for ii in sorted(remove_y_value_index, reverse=True): @@ -252,6 +251,7 @@ class BasicPlot(QtWidgets.QWidget): if __name__ == "__main__": import argparse + from bec_widgets import ctrl_c parser = argparse.ArgumentParser() diff --git a/tests/test_line_plot.py b/tests/test_line_plot.py index 53aebb5e..41506dac 100644 --- a/tests/test_line_plot.py +++ b/tests/test_line_plot.py @@ -1,7 +1,9 @@ -from pytestqt import qtbot from unittest import mock -from bec_widgets import line_plot + import numpy as np +from pytestqt import qtbot + +from bec_widgets import line_plot def test_line_plot_emits_no_signal(qtbot): @@ -63,12 +65,14 @@ def test_line_plot_raise_warning_wrong_signal_request(qtbot): metadata = {"scanID": "test", "scan_number": 1, "scan_report_devices": ["x"]} with mock.patch("bec_widgets.line_plot.BECClient") as mock_client: # TODO fix mock_client - mock_client.device_manager.devices.keys.return_value = ["y1"] + mock_dict = {"y1": [1, 2]} + mock_client().device_manager.devices.__contains__.side_effect = mock_dict.__contains__ + # = {"y1": [1, 2]} with mock.patch.object(plot, "update_signal") as mock_update_signal: mock_update_signal.emit() plot(data=data, metadata=metadata) - assert all(plot.y_value_list == ["y1"]) + assert plot.y_value_list == ["y1"] def test_line_plot_update(qtbot):