bec-widgets 0.44.4__py3-none-any.whl → 0.45.0__py3-none-any.whl

bec_widgets/widgets/__init__.py

@@ -1,15 +1,14 @@
-from .monitor import BECMonitor, ConfigDialog
-from .motor_map import MotorMap
-from .scan_control import ScanControl
-from .toolbar import ModularToolBar
 from .editor import BECEditor
+from .figure import BECFigure, FigureConfig
+from .monitor import BECMonitor
 from .monitor_scatter_2D import BECMonitor2DScatter
 from .motor_control import (
-    MotorControlRelative,
     MotorControlAbsolute,
+    MotorControlRelative,
     MotorControlSelection,
-    MotorThread,
     MotorCoordinateTable,
+    MotorThread,
 )
-from .figure import FigureConfig, BECFigure
-from .plots import BECWaveform1D, BECCurve, BECPlotBase
+from .motor_map import MotorMap
+from .plots import BECCurve, BECMotorMap, BECWaveform1D
+from .scan_control import ScanControl

bec_widgets/widgets/editor/editor.py

@@ -3,24 +3,16 @@ import subprocess
 import qdarktheme
 from jedi import Script
 from jedi.api import Completion
+from qtconsole.manager import QtKernelManager
+from qtconsole.rich_jupyter_widget import RichJupyterWidget
 
 # pylint: disable=no-name-in-module
-from qtpy.Qsci import QsciScintilla, QsciLexerPython, QsciAPIs
-from qtpy.QtCore import Qt
-from qtpy.QtCore import Signal, QThread
+from qtpy.Qsci import QsciAPIs, QsciLexerPython, QsciScintilla
+from qtpy.QtCore import Qt, QThread, Signal
 from qtpy.QtGui import QColor, QFont
-from qtpy.QtWidgets import (
-    QApplication,
-    QFileDialog,
-    QTextEdit,
-    QVBoxLayout,
-    QWidget,
-)
-from qtpy.QtWidgets import QSplitter
-from qtconsole.manager import QtKernelManager
-from qtconsole.rich_jupyter_widget import RichJupyterWidget
+from qtpy.QtWidgets import QApplication, QFileDialog, QSplitter, QTextEdit, QVBoxLayout, QWidget
 
-from bec_widgets.widgets import ModularToolBar
+from bec_widgets.widgets.toolbar import ModularToolBar
 
 
 class AutoCompleter(QThread):

bec_widgets/widgets/figure/__init__.py

@@ -1 +1 @@
-from .figure import FigureConfig, BECFigure
+from .figure import BECFigure, FigureConfig

bec_widgets/widgets/figure/figure.py

@@ -11,19 +11,20 @@ import pyqtgraph as pg
 import qdarktheme
 from pydantic import Field
 from pyqtgraph.Qt import uic
-from qtpy.QtWidgets import QApplication, QWidget
-from qtpy.QtWidgets import QVBoxLayout, QMainWindow
 from qtpy.QtCore import Signal as pyqtSignal
+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,
     Waveform1DConfig,
     WidgetConfig,
-    BECImageShow,
 )
 from bec_widgets.widgets.plots.image import ImageConfig
+from bec_widgets.widgets.plots.motor_map import MotorMapConfig
 
 
 class FigureConfig(ConnectionConfig):
@@ -45,6 +46,7 @@ class WidgetHandler:
             "PlotBase": (BECPlotBase, WidgetConfig),
             "Waveform1D": (BECWaveform1D, Waveform1DConfig),
             "ImShow": (BECImageShow, ImageConfig),
+            "MotorMap": (BECMotorMap, MotorMapConfig),
         }
 
     def create_widget(
@@ -99,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",
@@ -348,7 +352,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.
@@ -390,6 +394,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",

bec_widgets/widgets/monitor/__init__.py

@@ -1,2 +1 @@
 from .monitor import BECMonitor
-from .config_dialog import ConfigDialog

bec_widgets/widgets/monitor/config_dialog.py

@@ -1,23 +1,22 @@
 import os
 
+from pydantic import ValidationError
 from qtpy import uic
 from qtpy.QtCore import Signal as pyqtSignal
 from qtpy.QtWidgets import (
     QApplication,
-    QWidget,
-    QVBoxLayout,
+    QLineEdit,
+    QMessageBox,
     QTableWidget,
-    QTabWidget,
     QTableWidgetItem,
-    QLineEdit,
+    QTabWidget,
+    QVBoxLayout,
+    QWidget,
 )
 
+from bec_widgets.utils.bec_dispatcher import BECDispatcher
 from bec_widgets.utils.yaml_dialog import load_yaml, save_yaml
 from bec_widgets.validation import MonitorConfigValidator
-from pydantic import ValidationError
-from qtpy.QtWidgets import QApplication, QMessageBox
-from bec_widgets.utils.bec_dispatcher import BECDispatcher
-
 
 current_path = os.path.dirname(__file__)
 Ui_Form, BaseClass = uic.loadUiType(os.path.join(current_path, "config_dialog.ui"))

bec_widgets/widgets/monitor/monitor.py

@@ -11,8 +11,9 @@ from qtpy.QtCore import Slot as pyqtSlot
 from qtpy.QtWidgets import QApplication, QMessageBox
 
 from bec_widgets.utils import Colors, Crosshair, yaml_dialog
-from bec_widgets.validation import MonitorConfigValidator
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
+from bec_widgets.validation import MonitorConfigValidator
+from bec_widgets.widgets.monitor.config_dialog import ConfigDialog
 
 # just for demonstration purposes if script run directly
 CONFIG_SCAN_MODE = {
@@ -59,10 +60,7 @@ CONFIG_SCAN_MODE = {
                 "sources": [
                     {
                         "type": "scan_segment",
-                        "signals": {
-                            "x": [{"name": "samy"}],
-                            "y": [{"name": "bpm4i"}],
-                        },
+                        "signals": {"x": [{"name": "samy"}], "y": [{"name": "bpm4i"}]},
                     }
                 ],
             },
@@ -137,7 +135,7 @@ CONFIG_WRONG = {
                 },
                 {
                     "type": "history",
-                    "scanID": "<scanID>",
+                    "scan_id": "<scan_id>",
                     "signals": {
                         "x": [{"name": "samy"}],
                         "y": [{"name": "bpm4i", "entry": "bpm4i"}],
@@ -170,11 +168,8 @@ CONFIG_WRONG = {
                 {
                     "signals": {
                         "x": [{"name": "samx", "entry": "samx"}],
-                        "y": [
-                            {"name": "samx"},
-                            {"name": "samy", "entry": "samx"},
-                        ],
-                    },
+                        "y": [{"name": "samx"}, {"name": "samy", "entry": "samx"}],
+                    }
                 }
             ],
         },
@@ -315,7 +310,7 @@ class BECMonitor(pg.GraphicsLayoutWidget):
         self.plots = None
         self.curves_data = None
         self.grid_coordinates = None
-        self.scanID = None
+        self.scan_id = None
 
         # TODO make colors accessible to users
         self.user_colors = {}  # key: (plot_name, y_name, y_entry), value: color
@@ -352,7 +347,7 @@ class BECMonitor(pg.GraphicsLayoutWidget):
         # Initialize the UI
         self._init_ui(self.plot_settings["num_columns"])
 
-        if self.scanID is not None:
+        if self.scan_id is not None:
             self.replot_last_scan()
 
     def _init_database(self, plot_data_config: dict, source_type_to_init=None) -> dict:
@@ -602,7 +597,6 @@ class BECMonitor(pg.GraphicsLayoutWidget):
 
     def show_config_dialog(self):
         """Show the configuration dialog."""
-        from bec_widgets.widgets import ConfigDialog
 
         dialog = ConfigDialog(
             client=self.client, default_config=self.config, skip_validation=self.skip_validation
@@ -729,11 +723,11 @@ class BECMonitor(pg.GraphicsLayoutWidget):
             msg (dict): Message received with scan data.
             metadata (dict): Metadata of the scan.
         """
-        current_scanID = msg.get("scanID", None)
-        if current_scanID is None:
+        current_scan_id = msg.get("scan_id", None)
+        if current_scan_id is None:
             return
 
-        if current_scanID != self.scanID:
+        if current_scan_id != self.scan_id:
             if self.scan_types is False:
                 self.plot_data = self.plot_data_config
             elif self.scan_types is True:
@@ -753,10 +747,10 @@ class BECMonitor(pg.GraphicsLayoutWidget):
                 # Init UI
                 self._init_ui(self.plot_settings["num_columns"])
 
-            self.scanID = current_scanID
-            self.scan_data = self.queue.scan_storage.find_scan_by_ID(self.scanID)
+            self.scan_id = current_scan_id
+            self.scan_data = self.queue.scan_storage.find_scan_by_ID(self.scan_id)
             if not self.scan_data:
-                print(f"No data found for scanID: {self.scanID}")  # TODO better error
+                print(f"No data found for scan_id: {self.scan_id}")  # TODO better error
                 return
             self.flush(source_type_to_flush="scan_segment")
 
@@ -766,7 +760,7 @@ class BECMonitor(pg.GraphicsLayoutWidget):
 
     def scan_segment_update(self):
         """
-        Update the database with data from scan storage based on the provided scanID.
+        Update the database with data from scan storage based on the provided scan_id.
         """
         scan_data = self.scan_data.data
         for device_name, device_entries in self.database.get("scan_segment", {}).items():
@@ -840,11 +834,7 @@ if __name__ == "__main__":  # pragma: no cover
     client = BECDispatcher().client
     client.start()
     app = QApplication(sys.argv)
-    monitor = BECMonitor(
-        config=config,
-        gui_id=args.id,
-        skip_validation=False,
-    )
+    monitor = BECMonitor(config=config, gui_id=args.id, skip_validation=False)
     monitor.show()
     # just to test redis data
     # redis_data = {

bec_widgets/widgets/monitor_scatter_2D/monitor_scatter_2D.py

@@ -4,20 +4,16 @@ from collections import defaultdict
 
 import numpy as np
 import pyqtgraph as pg
+from bec_lib import MessageEndpoints
 from qtpy.QtCore import Signal as pyqtSignal
 from qtpy.QtCore import Slot as pyqtSlot
-from qtpy.QtWidgets import QApplication
-from qtpy.QtWidgets import QVBoxLayout, QWidget
+from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
 
-from bec_lib import MessageEndpoints
 from bec_widgets.utils import yaml_dialog
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
 
 CONFIG_DEFAULT = {
-    "plot_settings": {
-        "colormap": "CET-L4",
-        "num_columns": 1,
-    },
+    "plot_settings": {"colormap": "CET-L4", "num_columns": 1},
     "waveform2D": [
         {
             "plot_name": "Waveform 2D Scatter (1)",
@@ -97,7 +93,7 @@ class BECMonitor2DScatter(QWidget):
         self.plots = None
         self.curves_data = None
         self.grid_coordinates = None
-        self.scanID = None
+        self.scan_id = None
 
         # Connect the update signal to the update plot method
         self.proxy_update_plot = pg.SignalProxy(
@@ -275,15 +271,15 @@ class BECMonitor2DScatter(QWidget):
         """
 
         # TODO check if this is correct
-        current_scanID = msg.get("scanID", None)
-        if current_scanID is None:
+        current_scan_id = msg.get("scan_id", None)
+        if current_scan_id is None:
             return
 
-        if current_scanID != self.scanID:
-            self.scanID = current_scanID
-            self.scan_data = self.queue.scan_storage.find_scan_by_ID(self.scanID)
+        if current_scan_id != self.scan_id:
+            self.scan_id = current_scan_id
+            self.scan_data = self.queue.scan_storage.find_scan_by_ID(self.scan_id)
             if not self.scan_data:
-                print(f"No data found for scanID: {self.scanID}")  # TODO better error
+                print(f"No data found for scan_id: {self.scan_id}")  # TODO better error
                 return
             self.flush()
 
@@ -373,10 +369,6 @@ if __name__ == "__main__":  # pragma: no cover
     client = BECDispatcher().client
     client.start()
     app = QApplication(sys.argv)
-    monitor = BECMonitor2DScatter(
-        config=config,
-        gui_id=args.id,
-        skip_validation=True,
-    )
+    monitor = BECMonitor2DScatter(config=config, gui_id=args.id, skip_validation=True)
     monitor.show()
     sys.exit(app.exec())

bec_widgets/widgets/motor_control/__init__.py

@@ -1,7 +1,7 @@
 from .motor_control import (
-    MotorControlRelative,
     MotorControlAbsolute,
+    MotorControlRelative,
     MotorControlSelection,
-    MotorThread,
     MotorCoordinateTable,
+    MotorThread,
 )

bec_widgets/widgets/motor_control/motor_control.py

@@ -2,25 +2,26 @@
 import os
 from enum import Enum
 
+from bec_lib.alarm_handler import AlarmBase
+from bec_lib.device import Positioner
 from qtpy import uic
-from qtpy.QtCore import QThread, Slot as pyqtSlot
-from qtpy.QtCore import Signal as pyqtSignal, Qt
-from qtpy.QtGui import QKeySequence, QDoubleValidator
-from qtpy.QtWidgets import QMessageBox
+from qtpy.QtCore import Qt, QThread
+from qtpy.QtCore import Signal as pyqtSignal
+from qtpy.QtCore import Slot as pyqtSlot
+from qtpy.QtGui import QDoubleValidator, QKeySequence
 from qtpy.QtWidgets import (
+    QCheckBox,
     QComboBox,
-    QWidget,
     QDoubleSpinBox,
+    QLineEdit,
+    QMessageBox,
+    QPushButton,
     QShortcut,
     QTableWidget,
-    QPushButton,
     QTableWidgetItem,
-    QCheckBox,
-    QLineEdit,
+    QWidget,
 )
 
-from bec_lib.alarm_handler import AlarmBase
-from bec_lib.device import Positioner
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
 
 CONFIG_DEFAULT = {

bec_widgets/widgets/motor_map/motor_map.py

@@ -7,14 +7,13 @@ from typing import Any, Union
 import numpy as np
 import pyqtgraph as pg
 from bec_lib import MessageEndpoints
-from qtpy import QtCore
-from qtpy import QtGui
+from qtpy import QtCore, QtGui
 from qtpy.QtCore import Signal as pyqtSignal
 from qtpy.QtCore import Slot as pyqtSlot
 from qtpy.QtWidgets import QApplication
 
-from bec_widgets.utils.yaml_dialog import load_yaml
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
+from bec_widgets.utils.yaml_dialog import load_yaml
 
 CONFIG_DEFAULT = {
     "plot_settings": {

bec_widgets/widgets/plots/__init__.py

@@ -1,3 +1,4 @@
-from .plot_base import AxisConfig, WidgetConfig, BECPlotBase
-from .waveform1d import Waveform1DConfig, BECWaveform1D, BECCurve
-from .image import BECImageShow, ImageItemConfig, BECImageItem
+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

bec_widgets/widgets/plots/image.py

@@ -1,19 +1,20 @@
 from __future__ import annotations
 
 from collections import defaultdict
-from typing import Literal, Optional, Any
+from typing import Any, Literal, Optional
 
 import numpy as np
 import pyqtgraph as pg
-from pydantic import Field, BaseModel, ValidationError
-from qtpy.QtCore import QThread, QObject
+from bec_lib import MessageEndpoints
+from pydantic import BaseModel, Field, ValidationError
+from qtpy.QtCore import QObject, QThread
 from qtpy.QtCore import Signal as pyqtSignal
 from qtpy.QtCore import Slot as pyqtSlot
 from qtpy.QtWidgets import QWidget
 
-from bec_lib import MessageEndpoints
-from bec_widgets.utils import ConnectionConfig, BECConnector
-from bec_widgets.widgets.plots import BECPlotBase, WidgetConfig
+from bec_widgets.utils import BECConnector, ConnectionConfig
+
+from .plot_base import BECPlotBase, WidgetConfig
 
 
 class ProcessingConfig(BaseModel):