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

bec_widgets/cli/client.py

@@ -1,8 +1,9 @@
 # This file was automatically generated by generate_cli.py
 
-from bec_widgets.cli.client_utils import rpc_call, RPCBase, BECFigureClientMixin
 from typing import Literal, Optional, overload
 
+from bec_widgets.cli.client_utils import BECFigureClientMixin, RPCBase, rpc_call
+
 
 class BECPlotBase(RPCBase):
     @rpc_call
@@ -194,12 +195,12 @@ class BECWaveform1D(RPCBase):
         """
 
     @rpc_call
-    def scan_history(self, scan_index: "int" = None, scanID: "str" = None):
+    def scan_history(self, scan_index: "int" = None, scan_id: "str" = None):
         """
         Update the scan curves with the data from the scan storage.
-        Provide only one of scanID or scan_index.
+        Provide only one of scan_id or scan_index.
         Args:
-            scanID(str, optional): ScanID of the scan to be updated. Defaults to None.
+            scan_id(str, optional): ScanID of the scan to be updated. Defaults to None.
             scan_index(int, optional): Index of the scan to be updated. Defaults to None.
         """
 
@@ -449,12 +450,35 @@ 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,
@@ -511,6 +535,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,
@@ -1090,3 +1129,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/client_utils.py

@@ -8,12 +8,12 @@ import uuid
 from functools import wraps
 from typing import TYPE_CHECKING
 
-from qtpy.QtCore import QCoreApplication
-
-import bec_widgets.cli.client as client
 from bec_lib import MessageEndpoints, messages
 from bec_lib.connector import MessageObject
 from bec_lib.device import DeviceBase
+from qtpy.QtCore import QCoreApplication
+
+import bec_widgets.cli.client as client
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
 
 if TYPE_CHECKING:
@@ -59,7 +59,7 @@ def update_script(figure: BECFigure, msg):
     """
     info = msg.info
     status = msg.status
-    scan_id = msg.scanID
+    scan_id = msg.scan_id
     scan_number = info.get("scan_number", 0)
     scan_name = info.get("scan_name", "Unknown")
     scan_report_devices = info.get("scan_report_devices", [])

bec_widgets/cli/generate_cli.py

@@ -1,9 +1,10 @@
 # pylint: disable=missing-module-docstring
 from __future__ import annotations
+
 import inspect
-import black
 import sys
 
+import black
 
 if sys.version_info >= (3, 11):
     from typing import get_overloads
@@ -106,11 +107,11 @@ class {class_name}(RPCBase):"""
 if __name__ == "__main__":  # pragma: no cover
     import os
 
+    from bec_widgets.utils import BECConnector
     from bec_widgets.widgets.figure import BECFigure
-    from bec_widgets.widgets.plots import BECPlotBase, BECWaveform1D, BECImageShow
-    from bec_widgets.widgets.plots.waveform1d import BECCurve
+    from bec_widgets.widgets.plots import BECImageShow, BECMotorMap, BECPlotBase, BECWaveform1D
     from bec_widgets.widgets.plots.image import BECImageItem
-    from bec_widgets.utils import BECConnector
+    from bec_widgets.widgets.plots.waveform1d import BECCurve
 
     current_path = os.path.dirname(__file__)
     client_path = os.path.join(current_path, "client.py")
@@ -122,6 +123,7 @@ if __name__ == "__main__":  # pragma: no cover
         BECImageShow,
         BECConnector,
         BECImageItem,
+        BECMotorMap,
     ]
     generator = ClientGenerator()
     generator.generate_client(clss)

bec_widgets/cli/server.py

@@ -1,8 +1,8 @@
 import inspect
 
+from bec_lib import MessageEndpoints, messages
 from qtpy.QtCore import QTimer
 
-from bec_lib import MessageEndpoints, messages
 from bec_widgets.utils import BECDispatcher
 from bec_widgets.utils.bec_connector import BECConnector
 from bec_widgets.widgets.figure import BECFigure
@@ -115,8 +115,7 @@ if __name__ == "__main__":  # pragma: no cover
     import argparse
     import sys
 
-    from qtpy.QtWidgets import QApplication
-    from qtpy.QtWidgets import QMainWindow
+    from qtpy.QtWidgets import QApplication, QMainWindow
 
     app = QApplication(sys.argv)
     app.setApplicationName("BEC Figure")

bec_widgets/examples/__init__.py

@@ -2,8 +2,8 @@ from .motor_movement import (
     MotorControlApp,
     MotorControlMap,
     MotorControlPanel,
-    MotorControlPanelRelative,
     MotorControlPanelAbsolute,
+    MotorControlPanelRelative,
     MotorCoordinateTable,
     MotorThread,
 )

bec_widgets/examples/eiger_plot/eiger_plot.py

@@ -6,20 +6,11 @@ import h5py
 import numpy as np
 import pyqtgraph as pg
 import zmq
+from pyqtgraph.Qt import uic
 from qtpy.QtCore import Signal as pyqtSignal
 from qtpy.QtCore import Slot as pyqtSlot
 from qtpy.QtGui import QKeySequence
-from qtpy.QtWidgets import (
-    QWidget,
-    QFileDialog,
-    QShortcut,
-    QDialog,
-    QVBoxLayout,
-    QLabel,
-    QFrame,
-)
-from pyqtgraph.Qt import uic
-
+from qtpy.QtWidgets import QDialog, QFileDialog, QFrame, QLabel, QShortcut, QVBoxLayout, QWidget
 
 # from scipy.stats import multivariate_normal
 
@@ -307,6 +298,7 @@ class EigerPlot(QWidget):
 
 if __name__ == "__main__":
     import sys
+
     from qtpy.QtWidgets import QApplication
 
     app = QApplication(sys.argv)

bec_widgets/examples/mca_readout/mca_plot.py

@@ -1,19 +1,15 @@
 # import simulation_progress as SP
 import numpy as np
 import pyqtgraph as pg
-from qtpy.QtCore import Signal as pyqtSignal, Slot as pyqtSlot
-from qtpy.QtWidgets import (
-    QApplication,
-    QVBoxLayout,
-    QWidget,
-)
-
 from bec_lib import MessageEndpoints, messages
+from qtpy.QtCore import Signal as pyqtSignal
+from qtpy.QtCore import Slot as pyqtSlot
+from qtpy.QtWidgets import QApplication, QVBoxLayout, QWidget
 
 
 class StreamApp(QWidget):
     update_signal = pyqtSignal()
-    new_scanID = pyqtSignal(str)
+    new_scan_id = pyqtSignal(str)
 
     def __init__(self, device, sub_device):
         super().__init__()
@@ -23,7 +19,7 @@ class StreamApp(QWidget):
         self.setWindowTitle("MCA readout")
 
         self.data = None
-        self.scanID = None
+        self.scan_id = None
         self.stream_consumer = None
 
         self.device = device
@@ -33,7 +29,7 @@ class StreamApp(QWidget):
 
         # self.start_device_consumer(self.device)  # for simulation
 
-        self.new_scanID.connect(self.create_new_stream_consumer)
+        self.new_scan_id.connect(self.create_new_stream_consumer)
         self.update_signal.connect(self.plot_new)
 
     def init_ui(self):
@@ -64,17 +60,17 @@ class StreamApp(QWidget):
         # self.glw.addItem(self.hist)
 
     @pyqtSlot(str)
-    def create_new_stream_consumer(self, scanID: str):
-        print(f"Creating new stream consumer for scanID: {scanID}")
+    def create_new_stream_consumer(self, scan_id: str):
+        print(f"Creating new stream consumer for scan_id: {scan_id}")
 
-        self.connect_stream_consumer(scanID, self.device)
+        self.connect_stream_consumer(scan_id, self.device)
 
-    def connect_stream_consumer(self, scanID, device):
+    def connect_stream_consumer(self, scan_id, device):
         if self.stream_consumer is not None:
             self.stream_consumer.shutdown()
 
         self.stream_consumer = connector.stream_consumer(
-            topics=MessageEndpoints.device_async_readback(scanID=scanID, device=device),
+            topics=MessageEndpoints.device_async_readback(scan_id=scan_id, device=device),
             cb=self._streamer_cb,
             parent=self,
         )
@@ -125,24 +121,25 @@ class StreamApp(QWidget):
 
         msgDEV = msg.value
 
-        current_scanID = msgDEV.content["scanID"]
+        current_scan_id = msgDEV.content["scan_id"]
 
-        if parent.scanID is None:
-            parent.scanID = current_scanID
-            parent.new_scanID.emit(current_scanID)
-            print(f"New scanID: {current_scanID}")
+        if parent.scan_id is None:
+            parent.scan_id = current_scan_id
+            parent.new_scan_id.emit(current_scan_id)
+            print(f"New scan_id: {current_scan_id}")
 
-        if current_scanID != parent.scanID:
-            parent.scanID = current_scanID
+        if current_scan_id != parent.scan_id:
+            parent.scan_id = current_scan_id
             # parent.data = None
             # parent.imageItem.clear()
-            parent.new_scanID.emit(current_scanID)
+            parent.new_scan_id.emit(current_scan_id)
 
-            print(f"New scanID: {current_scanID}")
+            print(f"New scan_id: {current_scan_id}")
 
 
 if __name__ == "__main__":
     import argparse
+
     from bec_lib import RedisConnector
 
     parser = argparse.ArgumentParser(description="Stream App.")

bec_widgets/examples/mca_readout/mca_sim.py

@@ -1,31 +1,26 @@
-from bec_lib import messages, MessageEndpoints, RedisConnector
 import time
 
+from bec_lib import MessageEndpoints, RedisConnector, messages
+
 connector = RedisConnector("localhost:6379")
 producer = connector.producer()
 metadata = {}
 
-scanID = "ScanID1"
+scan_id = "ScanID1"
 
 metadata.update(
-    {
-        "scanID": scanID,  # this will be different for each scan
-        "async_update": "append",
-    }
+    {"scan_id": scan_id, "async_update": "append"}  # this will be different for each scan
 )
 for ii in range(20):
     data = {"mca1": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10], "mca2": [10, 9, 8, 7, 6, 5, 4, 3, 2, 1]}
-    msg = messages.DeviceMessage(
-        signals=data,
-        metadata=metadata,
-    ).dumps()
+    msg = messages.DeviceMessage(signals=data, metadata=metadata).dumps()
 
     # producer.send(topic=MessageEndpoints.device_status(device="mca"), msg=msg)
 
     producer.xadd(
         topic=MessageEndpoints.device_async_readback(
-            scanID=scanID, device="mca"
-        ),  # scanID will be different for each scan
+            scan_id=scan_id, device="mca"
+        ),  # scan_id will be different for each scan
         msg={"data": msg},  # TODO should be msg_dict
         expire=1800,
     )

bec_widgets/examples/motor_movement/__init__.py

@@ -2,8 +2,8 @@ from .motor_control_compilations import (
     MotorControlApp,
     MotorControlMap,
     MotorControlPanel,
-    MotorControlPanelRelative,
     MotorControlPanelAbsolute,
+    MotorControlPanelRelative,
     MotorCoordinateTable,
     MotorThread,
 )

bec_widgets/examples/motor_movement/motor_control_compilations.py

@@ -1,22 +1,17 @@
 # pylint: disable = no-name-in-module,missing-class-docstring, missing-module-docstring
 
 import qdarktheme
-from qtpy.QtWidgets import QApplication
-from qtpy.QtWidgets import QVBoxLayout
-from qtpy.QtWidgets import (
-    QWidget,
-    QSplitter,
-)
 from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QApplication, QSplitter, QVBoxLayout, QWidget
 
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
 from bec_widgets.widgets import (
     MotorControlAbsolute,
     MotorControlRelative,
     MotorControlSelection,
-    MotorThread,
-    MotorMap,
     MotorCoordinateTable,
+    MotorMap,
+    MotorThread,
 )
 
 CONFIG_DEFAULT = {

bec_widgets/examples/motor_movement/motor_controller.ui

@@ -883,7 +883,7 @@
          </column>
          <column>
           <property name="text">
-           <string>scanID</string>
+           <string>scan_id</string>
           </property>
          </column>
          <column>

bec_widgets/examples/motor_movement/motor_example.py

@@ -5,29 +5,28 @@ from functools import partial
 
 import numpy as np
 import pyqtgraph as pg
+from bec_lib import MessageEndpoints, messages
+from pyqtgraph.Qt import QtCore, QtWidgets, uic
 from qtpy import QtGui
-from qtpy.QtCore import QThread, Slot as pyqtSlot
-from qtpy.QtCore import Signal as pyqtSignal, Qt
-from qtpy.QtGui import QDoubleValidator
-from qtpy.QtGui import QKeySequence
+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 (
     QApplication,
-    QWidget,
-    QFileDialog,
     QDialog,
-    QVBoxLayout,
+    QFileDialog,
+    QFrame,
     QLabel,
+    QMessageBox,
     QPushButton,
-    QFrame,
+    QShortcut,
+    QVBoxLayout,
+    QWidget,
 )
-from qtpy.QtWidgets import QMessageBox
-from qtpy.QtWidgets import QShortcut
-from pyqtgraph.Qt import QtWidgets, uic, QtCore
 
-from bec_lib import MessageEndpoints, messages
 from bec_widgets.utils import DoubleValidationDelegate
 
-
 # TODO - General features
 #  - put motor status (moving, stopped, etc)
 #  - add mouse interactions with the plot -> click to select coordinates, double click to move?
@@ -1306,9 +1305,9 @@ class MotorControl(QThread):
 
 
 if __name__ == "__main__":
-    import yaml
     import argparse
 
+    import yaml
     from bec_lib import BECClient, ServiceConfig
 
     parser = argparse.ArgumentParser(description="Motor App")

bec_widgets/examples/stream_plot/stream_plot.py

@@ -5,14 +5,15 @@ import time
 import numpy as np
 import pyqtgraph
 import pyqtgraph as pg
-from bec_lib import messages, MessageEndpoints
+from bec_lib import MessageEndpoints, messages
 from bec_lib.redis_connector import RedisConnector
-from qtpy.QtCore import Slot as pyqtSlot
-from qtpy.QtWidgets import QTableWidgetItem
 from pyqtgraph import mkBrush, mkPen
 from pyqtgraph.Qt import QtCore, QtWidgets, uic
 from pyqtgraph.Qt.QtCore import pyqtSignal
-from bec_widgets.utils import Crosshair, Colors
+from qtpy.QtCore import Slot as pyqtSlot
+from qtpy.QtWidgets import QTableWidgetItem
+
+from bec_widgets.utils import Colors, Crosshair
 from bec_widgets.utils.bec_dispatcher import BECDispatcher
 
 

bec_widgets/utils/__init__.py

@@ -1,8 +1,8 @@
-from .crosshair import Crosshair
-from .colors import Colors
-from .validator_delegate import DoubleValidationDelegate
-from .bec_table import BECTable
 from .bec_connector import BECConnector, ConnectionConfig
 from .bec_dispatcher import BECDispatcher
-from .rpc_decorator import rpc_public, register_rpc_methods
+from .bec_table import BECTable
+from .colors import Colors
+from .crosshair import Crosshair
 from .entry_validator import EntryValidator
+from .rpc_decorator import register_rpc_methods, rpc_public
+from .validator_delegate import DoubleValidationDelegate

bec_widgets/utils/bec_connector.py

@@ -2,7 +2,7 @@
 from __future__ import annotations
 
 import time
-from typing import Type, Optional
+from typing import Optional, Type
 
 from pydantic import BaseModel, Field, field_validator
 from qtpy.QtCore import Slot as pyqtSlot

bec_widgets/utils/bec_dispatcher.py

@@ -8,11 +8,10 @@ from typing import Union
 
 import redis
 from bec_lib import BECClient, ServiceConfig
+from bec_lib.endpoints import EndpointInfo
 from qtpy.QtCore import QObject
 from qtpy.QtCore import Signal as pyqtSignal
 
-from bec_lib.endpoints import EndpointInfo
-
 # Adding a new pyqt signal requires a class factory, as they must be part of the class definition
 # and cannot be dynamically added as class attributes after the class has been defined.
 _signal_class_factory = (

bec_widgets/utils/bec_table.py

@@ -1,5 +1,5 @@
-from qtpy.QtWidgets import QTableWidget
 from qtpy.QtCore import Qt
+from qtpy.QtWidgets import QTableWidget
 
 
 class BECTable(QTableWidget):

bec_widgets/utils/crosshair.py

@@ -2,7 +2,8 @@ import numpy as np
 import pyqtgraph as pg
 
 # from qtpy.QtCore import QObject, pyqtSignal
-from qtpy.QtCore import QObject, Signal as pyqtSignal
+from qtpy.QtCore import QObject
+from qtpy.QtCore import Signal as pyqtSignal
 
 
 class Crosshair(QObject):

bec_widgets/utils/validator_delegate.py

@@ -2,7 +2,7 @@
 # from qtpy.QtWidgets import QStyledItemDelegate, QLineEdit
 
 from qtpy.QtGui import QDoubleValidator
-from qtpy.QtWidgets import QStyledItemDelegate, QLineEdit
+from qtpy.QtWidgets import QLineEdit, QStyledItemDelegate
 
 
 class DoubleValidationDelegate(QStyledItemDelegate):

bec_widgets/utils/widget_io.py

@@ -3,16 +3,16 @@ from abc import ABC, abstractmethod
 
 from qtpy.QtWidgets import (
     QApplication,
-    QWidget,
-    QLineEdit,
+    QCheckBox,
     QComboBox,
-    QTableWidget,
-    QSpinBox,
     QDoubleSpinBox,
+    QLabel,
+    QLineEdit,
+    QSpinBox,
+    QTableWidget,
     QTableWidgetItem,
     QVBoxLayout,
-    QCheckBox,
-    QLabel,
+    QWidget,
 )
 
 

bec_widgets/utils/yaml_dialog.py

@@ -1,6 +1,7 @@
 # pylint: disable=no-name-in-module
 
 from typing import Union
+
 import yaml
 from qtpy.QtWidgets import QFileDialog
 

bec_widgets/validation/monitor_config_validator.py

@@ -1,6 +1,6 @@
-from typing import Optional, Union, Literal
+from typing import Literal, Optional, Union
 
-from pydantic import BaseModel, Field, field_validator, model_validator, ValidationError
+from pydantic import BaseModel, Field, ValidationError, field_validator, model_validator
 from pydantic_core import PydanticCustomError
 
 
@@ -92,12 +92,12 @@ class SourceHistoryValidator(BaseModel):
     """History source validator
     Attributes:
         type (str): type of source - history
-        scanID (str): Scan ID for history source.
+        scan_id (str): Scan ID for history source.
         signals (list): Signal for the source.
     """
 
     type: Literal["history"]
-    scanID: str  # TODO can be validated if it is a valid scanID
+    scan_id: str  # TODO can be validated if it is a valid scan_id
     signals: AxisSignal
 
 
@@ -131,12 +131,12 @@ class Source(BaseModel):  # TODO decide if it should stay for general Source val
     General source validation, includes all Optional arguments of all other sources.
     Attributes:
         type (list): type of source (scan_segment, history)
-        scanID (Optional[str]): Scan ID for history source.
+        scan_id (Optional[str]): Scan ID for history source.
         signals (Optional[AxisSignal]): Signal for the source.
     """
 
     type: Literal["scan_segment", "history", "redis"]
-    scanID: Optional[str] = None
+    scan_id: Optional[str] = None
     signals: Optional[dict] = None