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

bec_widgets/widgets/plots/image.py

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

bec_widgets/widgets/plots/motor_map.py

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

bec_widgets/widgets/plots/plot_base.py

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

bec_widgets/widgets/plots/waveform.py

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