bec-widgets 0.51.0__py3-none-any.whl → 0.52.1__py3-none-any.whl

bec_widgets/widgets/plots/motor_map.py

@@ -13,11 +13,11 @@ from qtpy.QtCore import Slot as pyqtSlot
 from qtpy.QtWidgets import QWidget
 
 from bec_widgets.utils import EntryValidator
-from bec_widgets.widgets.plots.plot_base import BECPlotBase, WidgetConfig
+from bec_widgets.widgets.plots.plot_base import BECPlotBase, SubplotConfig
 from bec_widgets.widgets.plots.waveform import Signal, SignalData
 
 
-class MotorMapConfig(WidgetConfig):
+class MotorMapConfig(SubplotConfig):
     signals: Optional[Signal] = Field(None, description="Signals of the motor map")
     color_map: Optional[str] = Field(
         "Greys", description="Color scheme of the motor position gradient."
@@ -102,6 +102,7 @@ class BECMotorMap(BECPlotBase):
     ) -> 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.
@@ -145,6 +146,7 @@ class BECMotorMap(BECPlotBase):
     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.
         """
@@ -153,6 +155,7 @@ class BECMotorMap(BECPlotBase):
     def set_precision(self, precision: int) -> None:
         """
         Set the decimal precision of the motor position.
+
         Args:
             precision(int): Decimal precision of the motor position.
         """
@@ -161,6 +164,7 @@ class BECMotorMap(BECPlotBase):
     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.
         """
@@ -169,6 +173,7 @@ class BECMotorMap(BECPlotBase):
     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.
         """
@@ -177,6 +182,7 @@ class BECMotorMap(BECPlotBase):
     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.
         """
@@ -247,6 +253,7 @@ class BECMotorMap(BECPlotBase):
     def _add_coordinantes_crosshair(self, x: float, y: float) -> None:
         """
         Add crosshair to the plot to highlight the current position.
+
         Args:
             x(float): X coordinate.
             y(float): Y coordinate.
@@ -274,6 +281,7 @@ class BECMotorMap(BECPlotBase):
     def _make_limit_map(self, limits_x: list, limits_y: list) -> pg.ImageItem:
         """
         Create a limit map for the motor map plot.
+
         Args:
             limits_x(list): Motor limits for the x axis.
             limits_y(list): Motor limits for the y axis.
@@ -303,10 +311,12 @@ class BECMotorMap(BECPlotBase):
     def _get_motor_init_position(self, name: str, entry: str, precision: int) -> float:
         """
         Get the motor initial position from the config.
+
         Args:
             name(str): Motor name.
             entry(str): Motor entry.
             precision(int): Decimal precision of the motor position.
+
         Returns:
             float: Motor initial position.
         """
@@ -323,12 +333,14 @@ class BECMotorMap(BECPlotBase):
     ) -> tuple[str, str]:
         """
         Validate the signal name and entry.
+
         Args:
             x_name(str): Name of the x signal.
             y_name(str): Name of the y signal.
             x_entry(str|None): Entry of the x signal.
             y_entry(str|None): Entry of the y signal.
             validate_bec(bool, optional): If True, validate the signal with BEC. Defaults to True.
+
         Returns:
             tuple[str,str]: Validated x and y entries.
         """
@@ -343,6 +355,7 @@ class BECMotorMap(BECPlotBase):
     def _get_motor_limit(self, motor: str) -> Union[list | None]:  # TODO check if works correctly
         """
         Get the motor limit from the config.
+
         Args:
             motor(str): Motor name.
 
@@ -404,6 +417,7 @@ class BECMotorMap(BECPlotBase):
     def on_device_readback(self, msg: dict) -> None:
         """
         Update the motor map plot with the new motor position.
+
         Args:
             msg(dict): Message from the device readback.
         """
@@ -425,4 +439,4 @@ class BECMotorMap(BECPlotBase):
     def cleanup(self):
         """Cleanup the widget."""
         self._disconnect_current_motors()
-        self.rpc_register.remove_rpc(self)
+        super().cleanup()

bec_widgets/widgets/plots/plot_base.py

@@ -22,7 +22,7 @@ class AxisConfig(BaseModel):
     y_grid: bool = Field(False, description="Show grid on the y-axis.")
 
 
-class WidgetConfig(ConnectionConfig):
+class SubplotConfig(ConnectionConfig):
     parent_id: Optional[str] = Field(None, description="The parent figure of the plot.")
 
     # Coordinates in the figure
@@ -56,12 +56,12 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
         self,
         parent: Optional[QWidget] = None,  # TODO decide if needed for this class
         parent_figure=None,
-        config: Optional[WidgetConfig] = None,
+        config: Optional[SubplotConfig] = None,
         client=None,
         gui_id: Optional[str] = None,
     ):
         if config is None:
-            config = WidgetConfig(widget_class=self.__class__.__name__)
+            config = SubplotConfig(widget_class=self.__class__.__name__)
         super().__init__(client=client, config=config, gui_id=gui_id)
         pg.GraphicsLayout.__init__(self, parent)
 
@@ -73,8 +73,10 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     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
@@ -117,6 +119,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     def set_title(self, title: str):
         """
         Set the title of the plot widget.
+
         Args:
             title(str): Title of the plot widget.
         """
@@ -126,6 +129,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     def set_x_label(self, label: str):
         """
         Set the label of the x-axis.
+
         Args:
             label(str): Label of the x-axis.
         """
@@ -135,6 +139,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     def set_y_label(self, label: str):
         """
         Set the label of the y-axis.
+
         Args:
             label(str): Label of the y-axis.
         """
@@ -144,6 +149,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     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.
         """
@@ -153,6 +159,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     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.
         """
@@ -208,6 +215,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     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.
@@ -223,6 +231,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     def lock_aspect_ratio(self, lock):
         """
         Lock aspect ratio.
+
         Args:
             lock(bool): True to lock, False to unlock.
         """
@@ -231,6 +240,7 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
     def plot(self, data_x: list | np.ndarray, data_y: list | np.ndarray, **kwargs):
         """
         Plot custom data on the plot widget. These data are not saved in config.
+
         Args:
             data_x(list|np.ndarray): x-axis data
             data_y(list|np.ndarray): y-axis data
@@ -248,3 +258,4 @@ class BECPlotBase(BECConnector, pg.GraphicsLayout):
 
     def cleanup(self):
         """Cleanup the plot widget."""
+        super().cleanup()

bec_widgets/widgets/plots/waveform.py

@@ -15,7 +15,7 @@ from qtpy.QtCore import Slot as pyqtSlot
 from qtpy.QtWidgets import QWidget
 
 from bec_widgets.utils import BECConnector, Colors, ConnectionConfig, EntryValidator
-from bec_widgets.widgets.plots.plot_base import BECPlotBase, WidgetConfig
+from bec_widgets.widgets.plots.plot_base import BECPlotBase, SubplotConfig
 
 
 class SignalData(BaseModel):
@@ -53,7 +53,7 @@ class CurveConfig(ConnectionConfig):
     colormap: Optional[str] = Field("plasma", description="The colormap of the curves z gradient.")
 
 
-class Waveform1DConfig(WidgetConfig):
+class Waveform1DConfig(SubplotConfig):
     color_palette: Literal["plasma", "viridis", "inferno", "magma"] = Field(
         "plasma", description="The color palette of the figure widget."
     )  # TODO can be extended to all colormaps from current pyqtgraph session
@@ -129,8 +129,10 @@ class BECCurve(BECConnector, pg.PlotDataItem):
     def set(self, **kwargs):
         """
         Set the properties of the curve.
+
         Args:
             **kwargs: Keyword arguments for the properties to be set.
+
         Possible properties:
             - color: str
             - symbol: str
@@ -159,6 +161,7 @@ class BECCurve(BECConnector, pg.PlotDataItem):
     def set_color(self, color: str, symbol_color: Optional[str] = None):
         """
         Change the color of the curve.
+
         Args:
             color(str): Color of the curve.
             symbol_color(str, optional): Color of the symbol. Defaults to None.
@@ -170,6 +173,7 @@ class BECCurve(BECConnector, pg.PlotDataItem):
     def set_symbol(self, symbol: str):
         """
         Change the symbol of the curve.
+
         Args:
             symbol(str): Symbol of the curve.
         """
@@ -179,6 +183,7 @@ class BECCurve(BECConnector, pg.PlotDataItem):
     def set_symbol_color(self, symbol_color: str):
         """
         Change the symbol color of the curve.
+
         Args:
             symbol_color(str): Color of the symbol.
         """
@@ -188,6 +193,7 @@ class BECCurve(BECConnector, pg.PlotDataItem):
     def set_symbol_size(self, symbol_size: int):
         """
         Change the symbol size of the curve.
+
         Args:
             symbol_size(int): Size of the symbol.
         """
@@ -197,6 +203,7 @@ class BECCurve(BECConnector, pg.PlotDataItem):
     def set_pen_width(self, pen_width: int):
         """
         Change the pen width of the curve.
+
         Args:
             pen_width(int): Width of the pen.
         """
@@ -206,6 +213,7 @@ class BECCurve(BECConnector, pg.PlotDataItem):
     def set_pen_style(self, pen_style: Literal["solid", "dash", "dot", "dashdot"]):
         """
         Change the pen style of the curve.
+
         Args:
             pen_style(Literal["solid", "dash", "dot", "dashdot"]): Style of the pen.
         """
@@ -215,6 +223,7 @@ class BECCurve(BECConnector, pg.PlotDataItem):
     def set_colormap(self, colormap: str):
         """
         Set the colormap for the scatter plot z gradient.
+
         Args:
             colormap(str): Colormap for the scatter plot.
         """
@@ -229,14 +238,10 @@ class BECCurve(BECConnector, pg.PlotDataItem):
         x_data, y_data = self.getData()
         return x_data, y_data
 
-    def cleanup(self):
-        """Cleanup the curve."""
-        self.rpc_register.remove_rpc(self)
-
     def remove(self):
         """Remove the curve from the plot."""
-        self.cleanup()
         self.parent_item.removeItem(self)
+        self.cleanup()
 
 
 class BECWaveform(BECPlotBase):
@@ -300,11 +305,12 @@ class BECWaveform(BECPlotBase):
         self.add_legend()
         self.apply_config(self.config)
 
-    def apply_config(self, config: dict | WidgetConfig, replot_last_scan: bool = False):
+    def apply_config(self, config: dict | SubplotConfig, replot_last_scan: bool = False):
         """
         Apply the configuration to the 1D waveform widget.
+
         Args:
-            config(dict|WidgetConfig): Configuration settings.
+            config(dict|SubplotConfig): Configuration settings.
             replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
         """
         if isinstance(config, dict):
@@ -343,8 +349,10 @@ class BECWaveform(BECPlotBase):
     def add_curve_by_config(self, curve_config: CurveConfig | dict) -> BECCurve:
         """
         Add a curve to the plot widget by its configuration.
+
         Args:
             curve_config(CurveConfig|dict): Configuration of the curve to be added.
+
         Returns:
             BECCurve: The curve object.
         """
@@ -358,8 +366,10 @@ class BECWaveform(BECPlotBase):
     def get_curve_config(self, curve_id: str, dict_output: bool = True) -> CurveConfig | dict:
         """
         Get the configuration of a curve by its ID.
+
         Args:
             curve_id(str): ID of the curve.
+
         Returns:
             CurveConfig|dict: Configuration of the curve.
         """
@@ -386,8 +396,10 @@ class BECWaveform(BECPlotBase):
     def get_curve(self, identifier) -> BECCurve:
         """
         Get the curve by its index or ID.
+
         Args:
             identifier(int|str): Identifier of the curve. Can be either an integer (index) or a string (curve_id).
+
         Returns:
             BECCurve: The curve object.
         """
@@ -411,6 +423,7 @@ class BECWaveform(BECPlotBase):
     ) -> BECCurve:
         """
         Add a custom data curve to the plot widget.
+
         Args:
             x(list|np.ndarray): X data of the curve.
             y(list|np.ndarray): Y data of the curve.
@@ -461,11 +474,13 @@ class BECWaveform(BECPlotBase):
     ) -> BECCurve:
         """
         Add a curve object to the plot widget.
+
         Args:
             name(str): ID of the curve.
             source(str): Source of the curve.
             config(CurveConfig): Configuration of the curve.
             data(tuple[list|np.ndarray,list|np.ndarray], optional): Data (x,y) to be plotted. Defaults to None.
+
         Returns:
             BECCurve: The curve object.
         """
@@ -493,6 +508,7 @@ class BECWaveform(BECPlotBase):
     ) -> BECCurve:
         """
         Add a curve to the plot widget from the scan segment.
+
         Args:
             x_name(str): Name of the x signal.
             x_entry(str): Entry of the x signal.
@@ -563,6 +579,7 @@ class BECWaveform(BECPlotBase):
     ) -> tuple[str, str, str | None]:
         """
         Validate the signal name and entry.
+
         Args:
             x_name(str): Name of the x signal.
             y_name(str): Name of the y signal.
@@ -571,6 +588,7 @@ class BECWaveform(BECPlotBase):
             y_entry(str|None): Entry of the y signal.
             z_entry(str|None): Entry of the z signal.
             validate_bec(bool, optional): If True, validate the signal with BEC. Defaults to True.
+
         Returns:
             tuple[str,str,str|None]: Validated x, y, z entries.
         """
@@ -588,6 +606,7 @@ class BECWaveform(BECPlotBase):
     def _check_curve_id(self, val: Any, dict_to_check: dict) -> bool:
         """
         Check if val is in the values of the dict_to_check or in the values of the nested dictionaries.
+
         Args:
             val(Any): Value to check.
             dict_to_check(dict): Dictionary to check.
@@ -606,6 +625,7 @@ class BECWaveform(BECPlotBase):
     def remove_curve(self, *identifiers):
         """
         Remove a curve from the plot widget.
+
         Args:
             *identifiers: Identifier of the curve to be removed. Can be either an integer (index) or a string (curve_id).
         """
@@ -622,6 +642,7 @@ class BECWaveform(BECPlotBase):
     def _remove_curve_by_id(self, curve_id):
         """
         Remove a curve by its ID from the plot widget.
+
         Args:
             curve_id(str): ID of the curve to be removed.
         """
@@ -638,6 +659,7 @@ class BECWaveform(BECPlotBase):
     def _remove_curve_by_order(self, N):
         """
         Remove a curve by its order from the plot widget.
+
         Args:
             N(int): Order of the curve to be removed.
         """
@@ -683,6 +705,7 @@ class BECWaveform(BECPlotBase):
     def _update_scan_curves(self, data: ScanData):
         """
         Update the scan curves with the data from the scan segment.
+
         Args:
             data(ScanData): Data from the scan segment.
         """
@@ -717,6 +740,7 @@ class BECWaveform(BECPlotBase):
     def _make_z_gradient(self, data_z: list | np.ndarray, colormap: str) -> list | None:
         """
         Make a gradient color for the z values.
+
         Args:
             data_z(list|np.ndarray): Z values.
             colormap(str): Colormap for the gradient color.
@@ -739,6 +763,7 @@ class BECWaveform(BECPlotBase):
         """
         Update the scan curves with the data from the scan storage.
         Provide only one of scan_id or scan_index.
+
         Args:
             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.
@@ -758,8 +783,10 @@ class BECWaveform(BECPlotBase):
     def get_all_data(self, output: Literal["dict", "pandas"] = "dict") -> dict | pd.DataFrame:
         """
         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.
         """
@@ -799,4 +826,4 @@ class BECWaveform(BECPlotBase):
         self.bec_dispatcher.disconnect_slot(self.on_scan_segment, MessageEndpoints.scan_segment())
         for curve in self.curves:
             curve.cleanup()
-        self.rpc_register.remove_rpc(self)
+        super().cleanup()

bec_widgets/widgets/scan_control/scan_control.py

@@ -109,6 +109,7 @@ class ScanControl(QWidget):
     def add_horizontal_separator(self, layout) -> None:
         """
         Adds a horizontal separator to the given layout
+
         Args:
             layout: Layout to add the separator to
         """
@@ -142,6 +143,7 @@ class ScanControl(QWidget):
     def add_labels_to_layout(self, labels: list, grid_layout: QGridLayout) -> None:
         """
         Adds labels to the given grid layout as a separate row.
+
         Args:
             labels (list): List of label names to add.
             grid_layout (QGridLayout): The grid layout to which labels will be added.
@@ -157,6 +159,7 @@ class ScanControl(QWidget):
     ) -> None:  # TODO could be moved to BECTable
         """
         Adds labels to the given table widget as a header row.
+
         Args:
             labels(list): List of label names to add.
             table(QTableWidget): The table widget to which labels will be added.
@@ -166,7 +169,8 @@ class ScanControl(QWidget):
 
     def generate_args_input_fields(self, scan_info: dict) -> None:
         """
-        Generates input fields for args
+        Generates input fields for args.
+
         Args:
             scan_info(dict): Scan signature dictionary from BEC.
         """
@@ -188,6 +192,7 @@ class ScanControl(QWidget):
     def generate_kwargs_input_fields(self, scan_info: dict) -> None:
         """
         Generates input fields for kwargs
+
         Args:
             scan_info(dict): Scan signature dictionary from BEC.
         """
@@ -213,12 +218,13 @@ class ScanControl(QWidget):
     def generate_widgets_from_signature(self, items: list, signature: dict = None) -> list:
         """
         Generates widgets from the given list of items.
+
         Args:
             items(list): List of items to create widgets for.
             signature(dict, optional): Scan signature dictionary from BEC.
 
         Returns:
-
+            list: List of widgets created from the given items.
         """
         widgets = []  # Initialize an empty list to hold the widgets
 
@@ -333,6 +339,7 @@ class ScanControl(QWidget):
     def clear_and_delete_layout(self, layout: QLayout):
         """
         Clears and deletes the given layout and all its child widgets.
+
         Args:
             layout(QLayout): Layout to clear and delete
         """
@@ -383,6 +390,7 @@ class ScanControl(QWidget):
     def extract_args_from_table(self, table: QTableWidget) -> list:
         """
         Extracts the arguments from the given table widget.
+
         Args:
             table(QTableWidget): Table widget from which to extract the arguments
         """

bec_widgets/widgets/toolbar/toolbar.py

@@ -82,6 +82,7 @@ class RunScriptAction:
 
 class ModularToolBar(QToolBar):
     """Modular toolbar with optional automatic initialization.
+
     Args:
         parent (QWidget, optional): The parent widget of the toolbar. Defaults to None.
         auto_init (bool, optional): If True, automatically populates the toolbar based on the parent widget.

{bec_widgets-0.51.0.dist-info → bec_widgets-0.52.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: bec-widgets
-Version: 0.51.0
+Version: 0.52.1
 Summary: BEC Widgets
 Home-page: https://gitlab.psi.ch/bec/bec-widgets
 Project-URL: Bug Tracker, https://gitlab.psi.ch/bec/bec-widgets/issues