bec/bec_widgets
0
0
Fork 0
mirror of https://github.com/bec-project/bec_widgets.git synced 2025-07-14 03:31:50 +02:00
Code Activity

fix(docstrings): docstrings formating fixed for sphinx to properly format readdocs

Browse Source
This commit is contained in:
wyzula_j
2024-05-08 15:31:22 +02:00
parent 1454f6192b
commit 7f2f7cd07a
24 changed files with 281 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

131
bec_widgets/cli/client.py
View File

@ -11,6 +11,7 @@ class BECPlotBase(RPCBase):
def config_dict(self) -> "dict":
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -19,8 +20,10 @@ class BECPlotBase(RPCBase):
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
@ -35,6 +38,7 @@ class BECPlotBase(RPCBase):
def set_title(self, title: "str"):
"""
Set the title of the plot widget.
Args:
title(str): Title of the plot widget.
"""
@ -43,6 +47,7 @@ class BECPlotBase(RPCBase):
def set_x_label(self, label: "str"):
"""
Set the label of the x-axis.
Args:
label(str): Label of the x-axis.
"""
@ -51,6 +56,7 @@ class BECPlotBase(RPCBase):
def set_y_label(self, label: "str"):
"""
Set the label of the y-axis.
Args:
label(str): Label of the y-axis.
"""
@ -59,6 +65,7 @@ class BECPlotBase(RPCBase):
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.
"""
@ -67,6 +74,7 @@ class BECPlotBase(RPCBase):
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.
"""
@ -105,6 +113,7 @@ class BECPlotBase(RPCBase):
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.
@ -114,6 +123,7 @@ class BECPlotBase(RPCBase):
def lock_aspect_ratio(self, lock):
"""
Lock aspect ratio.
Args:
lock(bool): True to lock, False to unlock.
"""
@ -122,6 +132,7 @@ class BECPlotBase(RPCBase):
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
@ -148,6 +159,7 @@ class BECWaveform(RPCBase):
def config_dict(self) -> "dict":
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -169,6 +181,7 @@ class BECWaveform(RPCBase):
) -> "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.
@ -196,6 +209,7 @@ class BECWaveform(RPCBase):
) -> "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.
@ -211,6 +225,7 @@ class BECWaveform(RPCBase):
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).
"""
@ -220,6 +235,7 @@ class BECWaveform(RPCBase):
"""
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.
@ -238,8 +254,10 @@ class BECWaveform(RPCBase):
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.
"""
@ -248,8 +266,10 @@ class BECWaveform(RPCBase):
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.
"""
@ -258,6 +278,7 @@ class BECWaveform(RPCBase):
def apply_config(self, config: "dict | SubplotConfig", replot_last_scan: "bool" = False):
"""
Apply the configuration to the 1D waveform widget.
Args:
config(dict|SubplotConfig): Configuration settings.
replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
@ -267,8 +288,10 @@ class BECWaveform(RPCBase):
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.
"""
@ -277,8 +300,10 @@ class BECWaveform(RPCBase):
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
@ -293,6 +318,7 @@ class BECWaveform(RPCBase):
def set_title(self, title: "str"):
"""
Set the title of the plot widget.
Args:
title(str): Title of the plot widget.
"""
@ -301,6 +327,7 @@ class BECWaveform(RPCBase):
def set_x_label(self, label: "str"):
"""
Set the label of the x-axis.
Args:
label(str): Label of the x-axis.
"""
@ -309,6 +336,7 @@ class BECWaveform(RPCBase):
def set_y_label(self, label: "str"):
"""
Set the label of the y-axis.
Args:
label(str): Label of the y-axis.
"""
@ -317,6 +345,7 @@ class BECWaveform(RPCBase):
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.
"""
@ -325,6 +354,7 @@ class BECWaveform(RPCBase):
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.
"""
@ -363,6 +393,7 @@ class BECWaveform(RPCBase):
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.
@ -372,6 +403,7 @@ class BECWaveform(RPCBase):
def lock_aspect_ratio(self, lock):
"""
Lock aspect ratio.
Args:
lock(bool): True to lock, False to unlock.
"""
@ -380,6 +412,7 @@ class BECWaveform(RPCBase):
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
@ -406,6 +439,7 @@ class BECFigure(RPCBase):
def config_dict(self) -> "dict":
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -414,6 +448,7 @@ class BECFigure(RPCBase):
def axes(self, row: "int", col: "int") -> "BECPlotBase":
"""
Get widget by its coordinates in the figure.
Args:
row(int): the row coordinate
col(int): the column coordinate
@ -453,6 +488,7 @@ class BECFigure(RPCBase):
) -> "BECWaveform":
"""
Add a Waveform1D plot to the figure at the specified position.
Args:
widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
@ -476,6 +512,7 @@ class BECFigure(RPCBase):
) -> "BECImageShow":
"""
Add an image to the figure at the specified position.
Args:
monitor(str): The name of the monitor to display.
color_bar(Literal["simple","full"]): The type of color bar to display.
@ -533,6 +570,7 @@ class BECFigure(RPCBase):
) -> "BECWaveform":
"""
Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
Args:
x_name(str): The name of the device for the x-axis.
y_name(str): The name of the device for the y-axis.
@ -564,6 +602,7 @@ class BECFigure(RPCBase):
) -> "BECImageShow":
"""
Add an image to the figure. Always access the first image widget in the figure.
Args:
monitor(str): The name of the monitor to display.
color_bar(Literal["simple","full"]): The type of color bar to display.
@ -582,6 +621,7 @@ class BECFigure(RPCBase):
) -> "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.
@ -601,6 +641,7 @@ class BECFigure(RPCBase):
) -> "None":
"""
Remove a widget from the figure. Can be removed by its unique identifier or by its coordinates.
Args:
row(int): The row coordinate of the widget to remove.
col(int): The column coordinate of the widget to remove.
@ -623,6 +664,7 @@ class BECFigure(RPCBase):
def change_theme(self, theme: "Literal['dark', 'light']") -> "None":
"""
Change the theme of the figure widget.
Args:
theme(Literal["dark","light"]): The theme to set for the figure widget.
"""
@ -668,6 +710,7 @@ class BECCurve(RPCBase):
def config_dict(self) -> "dict":
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -676,8 +719,10 @@ class BECCurve(RPCBase):
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
@ -697,6 +742,7 @@ class BECCurve(RPCBase):
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.
@ -706,6 +752,7 @@ class BECCurve(RPCBase):
def set_colormap(self, colormap: "str"):
"""
Set the colormap for the scatter plot z gradient.
Args:
colormap(str): Colormap for the scatter plot.
"""
@ -714,6 +761,7 @@ class BECCurve(RPCBase):
def set_symbol(self, symbol: "str"):
"""
Change the symbol of the curve.
Args:
symbol(str): Symbol of the curve.
"""
@ -722,6 +770,7 @@ class BECCurve(RPCBase):
def set_symbol_color(self, symbol_color: "str"):
"""
Change the symbol color of the curve.
Args:
symbol_color(str): Color of the symbol.
"""
@ -730,6 +779,7 @@ class BECCurve(RPCBase):
def set_symbol_size(self, symbol_size: "int"):
"""
Change the symbol size of the curve.
Args:
symbol_size(int): Size of the symbol.
"""
@ -738,6 +788,7 @@ class BECCurve(RPCBase):
def set_pen_width(self, pen_width: "int"):
"""
Change the pen width of the curve.
Args:
pen_width(int): Width of the pen.
"""
@ -746,6 +797,7 @@ class BECCurve(RPCBase):
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.
"""
@ -772,6 +824,7 @@ class BECImageShow(RPCBase):
def config_dict(self) -> "dict":
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -780,6 +833,7 @@ class BECImageShow(RPCBase):
def add_image_by_config(self, config: "ImageItemConfig | dict") -> "BECImageItem":
"""
Add an image to the widget by configuration.
Args:
config(ImageItemConfig|dict): The configuration of the image.
@ -791,6 +845,7 @@ class BECImageShow(RPCBase):
def get_image_config(self, image_id, dict_output: "bool" = True) -> "ImageItemConfig | dict":
"""
Get the configuration of the image.
Args:
image_id(str): The ID of the image.
dict_output(bool): Whether to return the configuration as a dictionary. Defaults to True.
@ -803,6 +858,7 @@ class BECImageShow(RPCBase):
def get_image_dict(self) -> "dict[str, dict[str, BECImageItem]]":
"""
Get all images.
Returns:
dict[str, dict[str, BECImageItem]]: The dictionary of images.
"""
@ -843,6 +899,7 @@ class BECImageShow(RPCBase):
"""
Set the range of the color bar.
If name is not specified, then set vrange for all images.
Args:
vmin(float): Minimum value of the color bar.
vmax(float): Maximum value of the color bar.
@ -854,6 +911,7 @@ class BECImageShow(RPCBase):
"""
Set the color map of the image.
If name is not specified, then set color map for all images.
Args:
cmap(str): The color map of the image.
name(str): The name of the image. If None, apply to all images.
@ -863,6 +921,7 @@ class BECImageShow(RPCBase):
def set_autorange(self, enable: "bool" = False, name: "str" = None):
"""
Set the autoscale of the image.
Args:
enable(bool): Whether to autoscale the color bar.
name(str): The name of the image. If None, apply to all images.
@ -873,6 +932,7 @@ class BECImageShow(RPCBase):
"""
Set the monitor of the image.
If name is not specified, then set monitor for all images.
Args:
monitor(str): The name of the monitor.
name(str): The name of the image. If None, apply to all images.
@ -883,6 +943,7 @@ class BECImageShow(RPCBase):
"""
Set the post processing of the image.
If name is not specified, then set post processing for all images.
Args:
name(str): The name of the image. If None, apply to all images.
**kwargs: Keyword arguments for the properties to be set.
@ -897,6 +958,7 @@ class BECImageShow(RPCBase):
def set_image_properties(self, name: "str" = None, **kwargs):
"""
Set the properties of the image.
Args:
name(str): The name of the image. If None, apply to all images.
**kwargs: Keyword arguments for the properties to be set.
@ -917,6 +979,7 @@ class BECImageShow(RPCBase):
"""
Set the FFT of the image.
If name is not specified, then set FFT for all images.
Args:
enable(bool): Whether to perform FFT on the monitor data.
name(str): The name of the image. If None, apply to all images.
@ -927,6 +990,7 @@ class BECImageShow(RPCBase):
"""
Set the log of the image.
If name is not specified, then set log for all images.
Args:
enable(bool): Whether to perform log on the monitor data.
name(str): The name of the image. If None, apply to all images.
@ -937,6 +1001,7 @@ class BECImageShow(RPCBase):
"""
Set the rotation of the image.
If name is not specified, then set rotation for all images.
Args:
deg_90(int): The rotation angle of the monitor data before displaying.
name(str): The name of the image. If None, apply to all images.
@ -947,6 +1012,7 @@ class BECImageShow(RPCBase):
"""
Set the transpose of the image.
If name is not specified, then set transpose for all images.
Args:
enable(bool): Whether to transpose the monitor data before displaying.
name(str): The name of the image. If None, apply to all images.
@ -956,6 +1022,7 @@ class BECImageShow(RPCBase):
def toggle_threading(self, use_threading: "bool"):
"""
Toggle threading for the widgets postprocessing and updating.
Args:
use_threading(bool): Whether to use threading.
"""
@ -964,8 +1031,10 @@ class BECImageShow(RPCBase):
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
@ -980,6 +1049,7 @@ class BECImageShow(RPCBase):
def set_title(self, title: "str"):
"""
Set the title of the plot widget.
Args:
title(str): Title of the plot widget.
"""
@ -988,6 +1058,7 @@ class BECImageShow(RPCBase):
def set_x_label(self, label: "str"):
"""
Set the label of the x-axis.
Args:
label(str): Label of the x-axis.
"""
@ -996,6 +1067,7 @@ class BECImageShow(RPCBase):
def set_y_label(self, label: "str"):
"""
Set the label of the y-axis.
Args:
label(str): Label of the y-axis.
"""
@ -1004,6 +1076,7 @@ class BECImageShow(RPCBase):
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.
"""
@ -1012,6 +1085,7 @@ class BECImageShow(RPCBase):
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.
"""
@ -1050,6 +1124,7 @@ class BECImageShow(RPCBase):
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.
@ -1059,6 +1134,7 @@ class BECImageShow(RPCBase):
def lock_aspect_ratio(self, lock):
"""
Lock aspect ratio.
Args:
lock(bool): True to lock, False to unlock.
"""
@ -1067,6 +1143,7 @@ class BECImageShow(RPCBase):
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
@ -1095,6 +1172,7 @@ class BECConnector(RPCBase):
def config_dict(self) -> "dict":
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -1119,6 +1197,7 @@ class BECImageItem(RPCBase):
def config_dict(self) -> "dict":
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -1127,8 +1206,10 @@ class BECImageItem(RPCBase):
def set(self, **kwargs):
"""
Set the properties of the image.
Args:
**kwargs: Keyword arguments for the properties to be set.
Possible properties:
- downsample
- color_map
@ -1145,6 +1226,7 @@ class BECImageItem(RPCBase):
def set_fft(self, enable: "bool" = False):
"""
Set the FFT of the image.
Args:
enable(bool): Whether to perform FFT on the monitor data.
"""
@ -1153,6 +1235,7 @@ class BECImageItem(RPCBase):
def set_log(self, enable: "bool" = False):
"""
Set the log of the image.
Args:
enable(bool): Whether to perform log on the monitor data.
"""
@ -1161,6 +1244,7 @@ class BECImageItem(RPCBase):
def set_rotation(self, deg_90: "int" = 0):
"""
Set the rotation of the image.
Args:
deg_90(int): The rotation angle of the monitor data before displaying.
"""
@ -1169,6 +1253,7 @@ class BECImageItem(RPCBase):
def set_transpose(self, enable: "bool" = False):
"""
Set the transpose of the image.
Args:
enable(bool): Whether to transpose the image.
"""
@ -1177,6 +1262,7 @@ class BECImageItem(RPCBase):
def set_opacity(self, opacity: "float" = 1.0):
"""
Set the opacity of the image.
Args:
opacity(float): The opacity of the image.
"""
@ -1185,6 +1271,7 @@ class BECImageItem(RPCBase):
def set_autorange(self, autorange: "bool" = False):
"""
Set the autorange of the color bar.
Args:
autorange(bool): Whether to autorange the color bar.
"""
@ -1193,6 +1280,7 @@ class BECImageItem(RPCBase):
def set_color_map(self, cmap: "str" = "magma"):
"""
Set the color map of the image.
Args:
cmap(str): The color map of the image.
"""
@ -1201,6 +1289,7 @@ class BECImageItem(RPCBase):
def set_auto_downsample(self, auto: "bool" = True):
"""
Set the auto downsample of the image.
Args:
auto(bool): Whether to downsample the image.
"""
@ -1209,6 +1298,7 @@ class BECImageItem(RPCBase):
def set_monitor(self, monitor: "str"):
"""
Set the monitor of the image.
Args:
monitor(str): The name of the monitor.
"""
@ -1219,6 +1309,7 @@ class BECImageItem(RPCBase):
):
"""
Set the range of the color bar.
Args:
vmin(float): Minimum value of the color bar.
vmax(float): Maximum value of the color bar.
@ -1239,6 +1330,7 @@ class BECMotorMap(RPCBase):
def config_dict(self) -> "dict":
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -1254,6 +1346,7 @@ class BECMotorMap(RPCBase):
) -> "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.
@ -1266,6 +1359,7 @@ class BECMotorMap(RPCBase):
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.
"""
@ -1274,6 +1368,7 @@ class BECMotorMap(RPCBase):
def set_precision(self, precision: "int") -> "None":
"""
Set the decimal precision of the motor position.
Args:
precision(int): Decimal precision of the motor position.
"""
@ -1282,6 +1377,7 @@ class BECMotorMap(RPCBase):
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.
"""
@ -1290,6 +1386,7 @@ class BECMotorMap(RPCBase):
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.
"""
@ -1298,6 +1395,7 @@ class BECMotorMap(RPCBase):
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.
"""
@ -1312,11 +1410,19 @@ class BECMotorMap(RPCBase):
class BECDock(RPCBase):
@property
@rpc_call
def rpc_id(self) -> "str":
"""
Get the RPC ID of the widget.
"""
@property
@rpc_call
def widget_list(self) -> "list":
"""
Get the widgets in the dock.
Returns:
widgets(list): The widgets in the dock.
"""
@ -1363,6 +1469,7 @@ class BECDock(RPCBase):
):
"""
Add a widget to the dock.
Args:
widget_type(str): The widget to add. Only BEC RPC widgets from RPCWidgetHandler are allowed.
row(int): The row to add the widget to. If None, the widget will be added to the next available row.
@ -1376,6 +1483,7 @@ class BECDock(RPCBase):
def list_eligible_widgets(self) -> "list":
"""
List all widgets that can be added to the dock.
Returns:
list: The list of eligible widgets.
"""
@ -1384,6 +1492,7 @@ class BECDock(RPCBase):
def move_widget(self, widget: "QWidget", new_row: "int", new_col: "int"):
"""
Move a widget to a new position in the layout.
Args:
widget(QWidget): The widget to move.
new_row(int): The new row to move the widget to.
@ -1391,11 +1500,12 @@ class BECDock(RPCBase):
"""
@rpc_call
def remove_widget(self, widget: "QWidget"):
def remove_widget(self, widget_rpc_id: "str"):
"""
Remove a widget from the dock.
Args:
widget(QWidget): The widget to remove.
widget_rpc_id(str): The ID of the widget to remove.
"""
@rpc_call
@ -1407,13 +1517,13 @@ class BECDock(RPCBase):
@rpc_call
def attach(self):
"""
None
Attach the dock to the parent dock area.
"""
@rpc_call
def detach(self):
"""
None
Detach the dock from the parent dock area.
"""
@ -1431,6 +1541,7 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
def save_state(self) -> "dict":
"""
Save the state of the dock area.
Returns:
dict: The state of the dock area.
"""
@ -1439,6 +1550,7 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
def remove_dock(self, name: "str"):
"""
Remove a dock by name and ensure it is properly closed and cleaned up.
Args:
name(str): The name of the dock to remove.
"""
@ -1449,6 +1561,7 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
):
"""
Restore the state of the dock area. If no state is provided, the last state is restored.
Args:
state(dict): The state to restore.
missing(Literal['ignore','error']): What to do if a dock is missing.
@ -1460,10 +1573,10 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
self,
name: "str" = None,
position: "Literal['bottom', 'top', 'left', 'right', 'above', 'below']" = None,
relative_to: "Optional[BECDock]" = None,
relative_to: "BECDock | None" = None,
closable: "bool" = False,
prefix: "str" = "dock",
widget: "QWidget" = None,
widget: "str | QWidget | None" = None,
row: "int" = None,
col: "int" = 0,
rowspan: "int" = 1,
@ -1478,11 +1591,12 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
relative_to(BECDock): The dock to which the new dock should be added relative to.
closable(bool): Whether the dock is closable.
prefix(str): The prefix for the dock name if no name is provided.
widget(QWidget): The widget to be added to the dock.
widget(str|QWidget|None): The widget to be added to the dock. While using RPC, only BEC RPC widgets from RPCWidgetHandler are allowed.
row(int): The row of the added widget.
col(int): The column of the added widget.
rowspan(int): The rowspan of the added widget.
colspan(int): The colspan of the added widget.
Returns:
BECDock: The created dock.
"""
@ -1497,8 +1611,9 @@ class BECDockArea(RPCBase, BECGuiClientMixin):
def detach_dock(self, dock_name: "str") -> "BECDock":
"""
Undock a dock from the dock area.
Args:
dock(BECDock): The dock to undock.
dock_name(str): The dock to undock.
Returns:
BECDock: The undocked dock.

1
bec_widgets/cli/client_utils.py
View File

@ -281,6 +281,7 @@ class RPCBase:
def _wait_for_response(self, request_id: str, timeout: int = 5):
"""
Wait for the response from the server.
Args:
request_id(str): The request ID.
timeout(int): The timeout in seconds.

1
bec_widgets/cli/generate_cli.py
View File

@ -41,6 +41,7 @@ from typing import Literal, Optional, overload"""
def generate_content_for_class(self, cls):
"""
Generate the content for the class.
Args:
cls: The class for which to generate the content.
"""

4
bec_widgets/cli/rpc_register.py
View File

@ -28,6 +28,7 @@ class RPCRegister:
def add_rpc(self, rpc: QObject):
"""
Add an RPC object to the register.
Args:
rpc(QObject): The RPC object to be added to the register.
"""
@ -38,6 +39,7 @@ class RPCRegister:
def remove_rpc(self, rpc: str):
"""
Remove an RPC object from the register.
Args:
rpc(str): The RPC object to be removed from the register.
"""
@ -48,6 +50,7 @@ class RPCRegister:
def get_rpc_by_id(self, gui_id: str) -> QObject:
"""
Get an RPC object by its ID.
Args:
gui_id(str): The ID of the RPC object to be retrieved.
@ -60,6 +63,7 @@ class RPCRegister:
def list_all_connections(self) -> dict:
"""
List all the registered RPC objects.
Returns:
dict: A dictionary containing all the registered RPC objects.
"""

1
bec_widgets/cli/rpc_wigdet_handler.py
View File

@ -13,6 +13,7 @@ class RPCWidgetHandler:
def create_widget(widget_type, **kwargs) -> BECConnector:
"""
Create a widget from an RPC message.
Args:
widget_type(str): The type of the widget.
**kwargs: The keyword arguments for the widget.

0
bec_widgets/simulations/__init__.py
View File

7
bec_widgets/utils/bec_connector.py
View File

@ -78,6 +78,7 @@ class BECConnector:
def config_dict(self) -> dict:
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -87,6 +88,7 @@ class BECConnector:
def config_dict(self, config: BaseModel) -> None:
"""
Get the configuration of the widget.
Returns:
dict: The configuration of the widget.
"""
@ -96,6 +98,7 @@ class BECConnector:
def set_gui_id(self, gui_id: str) -> None:
"""
Set the GUI ID for the widget.
Args:
gui_id(str): GUI ID
"""
@ -116,6 +119,7 @@ class BECConnector:
def update_client(self, client) -> None:
"""Update the client and device manager from BEC and create object for BEC shortcuts.
Args:
client: BEC client
"""
@ -126,6 +130,7 @@ class BECConnector:
def on_config_update(self, config: ConnectionConfig | dict) -> None:
"""
Update the configuration for the widget.
Args:
config(ConnectionConfig): Configuration settings.
"""
@ -138,8 +143,10 @@ class BECConnector:
def get_config(self, dict_output: bool = True) -> dict | BaseModel:
"""
Get the configuration of the widget.
Args:
dict_output(bool): If True, return the configuration as a dictionary. If False, return the configuration as a pydantic model.
Returns:
dict: The configuration of the plot widget.
"""

1
bec_widgets/utils/bec_table.py
View File

@ -8,6 +8,7 @@ class BECTable(QTableWidget):
def keyPressEvent(self, event) -> None:
"""
Delete selected rows with backspace or delete key
Args:
event: keyPressEvent
"""

3
bec_widgets/utils/container_utils.py
View File

@ -10,6 +10,7 @@ class WidgetContainerUtils:
def generate_unique_widget_id(container: dict, prefix: str = "widget") -> str:
"""
Generate a unique widget ID.
Args:
container(dict): The container of widgets.
prefix(str): The prefix of the widget ID.
@ -29,10 +30,12 @@ class WidgetContainerUtils:
) -> QWidget | None:
"""
Find the first widget of a given class in the figure.
Args:
container(dict): The container of widgets.
widget_class(Type): The class of the widget to find.
can_fail(bool): If True, the method will return None if no widget is found. If False, it will raise an error.
Returns:
widget: The widget of the given class.
"""

1
bec_widgets/utils/crosshair.py
View File

@ -17,6 +17,7 @@ class Crosshair(QObject):
def __init__(self, plot_item: pg.PlotItem, precision: int = None, parent=None):
"""
Crosshair for 1D and 2D plots.
Args:
plot_item (pyqtgraph.PlotItem): The plot item to which the crosshair will be attached.
precision (int, optional): Number of decimal places to round the coordinates to. Defaults to None.

39
bec_widgets/utils/ctrl_c.py
View File

@ -1,39 +0,0 @@
# TODO haven't found yet how to deal with QAbstractSocket in qtpy
# 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

2
bec_widgets/utils/entry_validator.py
View File

@ -5,6 +5,7 @@ class EntryValidator:
def validate_signal(self, name: str, entry: str = None) -> str:
"""
Validate a signal entry for a given device. If the entry is not provided, the first signal entry will be used from the device hints.
Args:
name(str): Device name
entry(str): Signal entry
@ -28,6 +29,7 @@ class EntryValidator:
def validate_monitor(self, monitor: str) -> str:
"""
Validate a monitor entry for a given device.
Args:
monitor(str): Monitor entry

4
bec_widgets/utils/layout_manager.py
View File

@ -21,6 +21,7 @@ class GridLayoutManager:
def is_position_occupied(self, row: int, col: int) -> bool:
"""
Check if the position in the layout is occupied by a widget.
Args:
row(int): The row to check.
col(int): The column to check.
@ -42,6 +43,7 @@ class GridLayoutManager:
):
"""
Shift widgets in the layout in the specified direction starting from the specified position.
Args:
direction(str): The direction to shift the widgets. Can be "down", "up", "left", or "right".
start_row(int): The row to start shifting from. Default is 0.
@ -63,6 +65,7 @@ class GridLayoutManager:
def move_widget(self, widget: QWidget, new_row: int, new_col: int):
"""
Move a widget to a new position in the layout.
Args:
widget(QWidget): The widget to move.
new_row(int): The new row to move the widget to.
@ -82,6 +85,7 @@ class GridLayoutManager:
):
"""
Add a widget to the layout at the specified position.
Args:
widget(QWidget): The widget to add.
row(int): The row to add the widget to. If None, the widget will be added to the next available row.

5
bec_widgets/utils/widget_io.py
View File

@ -114,6 +114,7 @@ class WidgetIO:
def get_value(widget, ignore_errors=False):
"""
Retrieve value from the widget instance.
Args:
widget: Widget instance.
ignore_errors(bool, optional): Whether to ignore if no handler is found.
@ -129,6 +130,7 @@ class WidgetIO:
def set_value(widget, value, ignore_errors=False):
"""
Set a value on the widget instance.
Args:
widget: Widget instance.
value: Value to set.
@ -155,6 +157,7 @@ class WidgetHierarchy:
) -> None:
"""
Print the widget hierarchy to the console.
Args:
widget: Widget to print the hierarchy of
indent(int, optional): Level of indentation.
@ -196,6 +199,7 @@ class WidgetHierarchy:
) -> dict:
"""
Export the widget hierarchy to a dictionary.
Args:
widget: Widget to print the hierarchy of.
config(dict,optional): Dictionary to export the hierarchy to.
@ -245,6 +249,7 @@ class WidgetHierarchy:
def import_config_from_dict(widget, config: dict, set_values: bool = False) -> None:
"""
Import the widget hierarchy from a dictionary.
Args:
widget: Widget to import the hierarchy to.
config:

2
bec_widgets/utils/yaml_dialog.py
View File

@ -9,6 +9,7 @@ from qtpy.QtWidgets import QFileDialog
def load_yaml(instance) -> Union[dict, None]:
"""
Load YAML file from disk.
Args:
instance: Instance of the calling widget.
@ -40,6 +41,7 @@ def load_yaml(instance) -> Union[dict, None]:
def save_yaml(instance, config: dict) -> None:
"""
Save YAML file to disk.
Args:
instance: Instance of the calling widget.
config: Configuration data to be saved.

3
bec_widgets/validation/monitor_config_validator.py
View File

@ -8,7 +8,7 @@ class Signal(BaseModel):
"""
Represents a signal in a plot configuration.
Attributes:
Args:
name (str): The name of the signal.
entry (Optional[str]): The entry point of the signal, optional.
"""
@ -21,6 +21,7 @@ class Signal(BaseModel):
def validate_fields(cls, values):
"""Validate the fields of the model.
First validate the 'name' field, then validate the 'entry' field.
Args:
values (dict): The values to be validated."""
devices = MonitorConfigValidator.devices

5
bec_widgets/widgets/dock/dock_area.py
View File

@ -77,6 +77,7 @@ class BECDockArea(BECConnector, DockArea):
):
"""
Restore the state of the dock area. If no state is provided, the last state is restored.
Args:
state(dict): The state to restore.
missing(Literal['ignore','error']): What to do if a dock is missing.
@ -89,6 +90,7 @@ class BECDockArea(BECConnector, DockArea):
def save_state(self) -> dict:
"""
Save the state of the dock area.
Returns:
dict: The state of the dock area.
"""
@ -98,6 +100,7 @@ class BECDockArea(BECConnector, DockArea):
def remove_dock(self, name: str):
"""
Remove a dock by name and ensure it is properly closed and cleaned up.
Args:
name(str): The name of the dock to remove.
"""
@ -138,6 +141,7 @@ class BECDockArea(BECConnector, DockArea):
col(int): The column of the added widget.
rowspan(int): The rowspan of the added widget.
colspan(int): The colspan of the added widget.
Returns:
BECDock: The created dock.
"""
@ -178,6 +182,7 @@ class BECDockArea(BECConnector, DockArea):
def detach_dock(self, dock_name: str) -> BECDock:
"""
Undock a dock from the dock area.
Args:
dock_name(str): The dock to undock.

12
bec_widgets/widgets/figure/figure.py
View File

@ -210,6 +210,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
) -> BECWaveform:
"""
Add a Waveform1D plot to the figure at the specified position.
Args:
widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
row(int): The row coordinate of the widget in the figure. If not provided, the next empty row will be used.
@ -289,6 +290,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
) -> BECWaveform:
"""
Add a 1D waveform plot to the figure. Always access the first waveform widget in the figure.
Args:
x_name(str): The name of the device for the x-axis.
y_name(str): The name of the device for the y-axis.
@ -375,6 +377,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
) -> BECImageShow:
"""
Add an image to the figure. Always access the first image widget in the figure.
Args:
monitor(str): The name of the monitor to display.
color_bar(Literal["simple","full"]): The type of color bar to display.
@ -428,6 +431,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
) -> BECImageShow:
"""
Add an image to the figure at the specified position.
Args:
monitor(str): The name of the monitor to display.
color_bar(Literal["simple","full"]): The type of color bar to display.
@ -482,6 +486,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
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.
@ -558,6 +563,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
) -> BECPlotBase:
"""
Add a widget to the figure at the specified position.
Args:
widget_type(Literal["PlotBase","Waveform1D"]): The type of the widget to add.
widget_id(str): The unique identifier of the widget. If not provided, a unique ID will be generated.
@ -620,6 +626,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
) -> None:
"""
Remove a widget from the figure. Can be removed by its unique identifier or by its coordinates.
Args:
row(int): The row coordinate of the widget to remove.
col(int): The column coordinate of the widget to remove.
@ -638,6 +645,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
def change_theme(self, theme: Literal["dark", "light"]) -> None:
"""
Change the theme of the figure widget.
Args:
theme(Literal["dark","light"]): The theme to set for the figure widget.
"""
@ -648,6 +656,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
def _remove_by_coordinates(self, row: int, col: int) -> None:
"""
Remove a widget from the figure by its coordinates.
Args:
row(int): The row coordinate of the widget to remove.
col(int): The column coordinate of the widget to remove.
@ -661,6 +670,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
def _remove_by_id(self, widget_id: str) -> None:
"""
Remove a widget from the figure by its unique identifier.
Args:
widget_id(str): The unique identifier of the widget to remove.
"""
@ -678,6 +688,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
def axes(self, row: int, col: int) -> BECPlotBase:
"""
Get widget by its coordinates in the figure.
Args:
row(int): the row coordinate
col(int): the column coordinate
@ -700,6 +711,7 @@ class BECFigure(BECConnector, pg.GraphicsLayoutWidget):
def _change_grid(self, widget_id: str, row: int, col: int):
"""
Change the grid to reflect the new position of the widget.
Args:
widget_id(str): The unique identifier of the widget.
row(int): The new row coordinate of the widget in the figure.

41
bec_widgets/widgets/plots/image.py
View File

@ -112,8 +112,10 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set(self, **kwargs):
"""
Set the properties of the image.
Args:
**kwargs: Keyword arguments for the properties to be set.
Possible properties:
- downsample
- color_map
@ -145,6 +147,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_fft(self, enable: bool = False):
"""
Set the FFT of the image.
Args:
enable(bool): Whether to perform FFT on the monitor data.
"""
@ -153,6 +156,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_log(self, enable: bool = False):
"""
Set the log of the image.
Args:
enable(bool): Whether to perform log on the monitor data.
"""
@ -163,6 +167,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_rotation(self, deg_90: int = 0):
"""
Set the rotation of the image.
Args:
deg_90(int): The rotation angle of the monitor data before displaying.
"""
@ -171,6 +176,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_transpose(self, enable: bool = False):
"""
Set the transpose of the image.
Args:
enable(bool): Whether to transpose the image.
"""
@ -179,6 +185,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_opacity(self, opacity: float = 1.0):
"""
Set the opacity of the image.
Args:
opacity(float): The opacity of the image.
"""
@ -188,6 +195,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_autorange(self, autorange: bool = False):
"""
Set the autorange of the color bar.
Args:
autorange(bool): Whether to autorange the color bar.
"""
@ -198,6 +206,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_color_map(self, cmap: str = "magma"):
"""
Set the color map of the image.
Args:
cmap(str): The color map of the image.
"""
@ -212,6 +221,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_auto_downsample(self, auto: bool = True):
"""
Set the auto downsample of the image.
Args:
auto(bool): Whether to downsample the image.
"""
@ -221,6 +231,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_monitor(self, monitor: str):
"""
Set the monitor of the image.
Args:
monitor(str): The name of the monitor.
"""
@ -229,6 +240,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
def set_vrange(self, vmin: float = None, vmax: float = None, vrange: tuple[int, int] = None):
"""
Set the range of the color bar.
Args:
vmin(float): Minimum value of the color bar.
vmax(float): Maximum value of the color bar.
@ -258,6 +270,7 @@ class BECImageItem(BECConnector, pg.ImageItem):
):
"""
Add color bar to the layout.
Args:
style(Literal["simple,full"]): The style of the color bar.
vrange(tuple[int,int]): The range of the color bar.
@ -363,6 +376,7 @@ class BECImageShow(BECPlotBase):
def find_image_by_monitor(self, item_id: str) -> BECImageItem:
"""
Find the widget by its gui_id.
Args:
item_id(str): The gui_id of the widget.
@ -381,6 +395,7 @@ class BECImageShow(BECPlotBase):
def apply_config(self, config: dict | SubplotConfig):
"""
Apply the configuration to the 1D waveform widget.
Args:
config(dict|SubplotConfig): Configuration settings.
replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
@ -416,6 +431,7 @@ class BECImageShow(BECPlotBase):
def add_image_by_config(self, config: ImageItemConfig | dict) -> BECImageItem:
"""
Add an image to the widget by configuration.
Args:
config(ImageItemConfig|dict): The configuration of the image.
@ -432,6 +448,7 @@ class BECImageShow(BECPlotBase):
def get_image_config(self, image_id, dict_output: bool = True) -> ImageItemConfig | dict:
"""
Get the configuration of the image.
Args:
image_id(str): The ID of the image.
dict_output(bool): Whether to return the configuration as a dictionary. Defaults to True.
@ -473,6 +490,7 @@ class BECImageShow(BECPlotBase):
def get_image_dict(self) -> dict[str, dict[str, BECImageItem]]:
"""
Get all images.
Returns:
dict[str, dict[str, BECImageItem]]: The dictionary of images.
"""
@ -574,6 +592,7 @@ class BECImageShow(BECPlotBase):
"""
Set the range of the color bar.
If name is not specified, then set vrange for all images.
Args:
vmin(float): Minimum value of the color bar.
vmax(float): Maximum value of the color bar.
@ -585,6 +604,7 @@ class BECImageShow(BECPlotBase):
"""
Set the color map of the image.
If name is not specified, then set color map for all images.
Args:
cmap(str): The color map of the image.
name(str): The name of the image. If None, apply to all images.
@ -594,6 +614,7 @@ class BECImageShow(BECPlotBase):
def set_autorange(self, enable: bool = False, name: str = None):
"""
Set the autoscale of the image.
Args:
enable(bool): Whether to autoscale the color bar.
name(str): The name of the image. If None, apply to all images.
@ -604,6 +625,7 @@ class BECImageShow(BECPlotBase):
"""
Set the monitor of the image.
If name is not specified, then set monitor for all images.
Args:
monitor(str): The name of the monitor.
name(str): The name of the image. If None, apply to all images.
@ -614,6 +636,7 @@ class BECImageShow(BECPlotBase):
"""
Set the post processing of the image.
If name is not specified, then set post processing for all images.
Args:
name(str): The name of the image. If None, apply to all images.
**kwargs: Keyword arguments for the properties to be set.
@ -628,6 +651,7 @@ class BECImageShow(BECPlotBase):
def set_image_properties(self, name: str = None, **kwargs):
"""
Set the properties of the image.
Args:
name(str): The name of the image. If None, apply to all images.
**kwargs: Keyword arguments for the properties to be set.
@ -648,6 +672,7 @@ class BECImageShow(BECPlotBase):
"""
Set the FFT of the image.
If name is not specified, then set FFT for all images.
Args:
enable(bool): Whether to perform FFT on the monitor data.
name(str): The name of the image. If None, apply to all images.
@ -658,6 +683,7 @@ class BECImageShow(BECPlotBase):
"""
Set the log of the image.
If name is not specified, then set log for all images.
Args:
enable(bool): Whether to perform log on the monitor data.
name(str): The name of the image. If None, apply to all images.
@ -668,6 +694,7 @@ class BECImageShow(BECPlotBase):
"""
Set the rotation of the image.
If name is not specified, then set rotation for all images.
Args:
deg_90(int): The rotation angle of the monitor data before displaying.
name(str): The name of the image. If None, apply to all images.
@ -678,6 +705,7 @@ class BECImageShow(BECPlotBase):
"""
Set the transpose of the image.
If name is not specified, then set transpose for all images.
Args:
enable(bool): Whether to transpose the monitor data before displaying.
name(str): The name of the image. If None, apply to all images.
@ -687,6 +715,7 @@ class BECImageShow(BECPlotBase):
def toggle_threading(self, use_threading: bool):
"""
Toggle threading for the widgets postprocessing and updating.
Args:
use_threading(bool): Whether to use threading.
"""
@ -698,6 +727,7 @@ class BECImageShow(BECPlotBase):
def on_image_update(self, msg: dict):
"""
Update the image of the device monitor from bec.
Args:
msg(dict): The message from bec.
"""
@ -716,6 +746,7 @@ class BECImageShow(BECPlotBase):
def update_image(self, device: str, data: np.ndarray):
"""
Update the image of the device monitor.
Args:
device(str): The name of the device.
data(np.ndarray): The data to be updated.
@ -726,6 +757,7 @@ class BECImageShow(BECPlotBase):
def _connect_device_monitor(self, monitor: str):
"""
Connect to the device monitor.
Args:
monitor(str): The name of the monitor.
"""
@ -760,6 +792,7 @@ class BECImageShow(BECPlotBase):
def _check_image_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.
@ -778,6 +811,7 @@ class BECImageShow(BECPlotBase):
def _validate_monitor(self, monitor: str, validate_bec: bool = True):
"""
Validate the monitor name.
Args:
monitor(str): The name of the monitor.
validate_bec(bool): Whether to validate the monitor name with BEC.
@ -818,6 +852,7 @@ class ImageProcessor:
def set_config(self, config: ProcessingConfig):
"""
Set the configuration of the processor.
Args:
config(ProcessingConfig): The configuration of the processor.
"""
@ -826,6 +861,7 @@ class ImageProcessor:
def FFT(self, data: np.ndarray) -> np.ndarray:
"""
Perform FFT on the data.
Args:
data(np.ndarray): The data to be processed.
@ -837,6 +873,7 @@ class ImageProcessor:
def rotation(self, data: np.ndarray, rotate_90: int) -> np.ndarray:
"""
Rotate the data by 90 degrees n times.
Args:
data(np.ndarray): The data to be processed.
rotate_90(int): The number of 90 degree rotations.
@ -849,6 +886,7 @@ class ImageProcessor:
def transpose(self, data: np.ndarray) -> np.ndarray:
"""
Transpose the data.
Args:
data(np.ndarray): The data to be processed.
@ -860,6 +898,7 @@ class ImageProcessor:
def log(self, data: np.ndarray) -> np.ndarray:
"""
Perform log on the data.
Args:
data(np.ndarray): The data to be processed.
@ -878,6 +917,7 @@ class ImageProcessor:
def process_image(self, data: np.ndarray) -> np.ndarray:
"""
Process the data according to the configuration.
Args:
data(np.ndarray): The data to be processed.
@ -914,6 +954,7 @@ class ProcessorWorker(QObject):
def process_image(self, device: str, image: np.ndarray):
"""
Process the image data.
Args:
device(str): The name of the device.
image(np.ndarray): The image data.

14
bec_widgets/widgets/plots/motor_map.py
View File

@ -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.
"""

10
bec_widgets/widgets/plots/plot_base.py
View File

@ -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

31
bec_widgets/widgets/plots/waveform.py
View File

@ -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.
"""
@ -299,6 +308,7 @@ class BECWaveform(BECPlotBase):
def apply_config(self, config: dict | SubplotConfig, replot_last_scan: bool = False):
"""
Apply the configuration to the 1D waveform widget.
Args:
config(dict|SubplotConfig): Configuration settings.
replot_last_scan(bool, optional): If True, replot the last scan. Defaults to False.
@ -339,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.
"""
@ -354,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.
"""
@ -382,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.
"""
@ -407,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.
@ -457,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.
"""
@ -489,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.
@ -559,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.
@ -567,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.
"""
@ -584,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.
@ -602,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).
"""
@ -618,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.
"""
@ -634,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.
"""
@ -679,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.
"""
@ -713,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.
@ -735,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.
@ -754,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.
"""

12
bec_widgets/widgets/scan_control/scan_control.py
View File

@ -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
"""

1
bec_widgets/widgets/toolbar/toolbar.py
View File

@ -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.