suboptimumg.sweep.motor_sweep_results#

class suboptimumg.sweep.motor_sweep_results.MotorSweepResults(sweep_data)[source]#

Bases: object

Parameters:

sweep_data (MotorSweepData)

get_single_motor_sweep_data(motor_name)[source]#

Retrieve sweep results for a specific motor by name.

Parameters:

motor_name (str) – Name of the motor to retrieve

Returns:

Sweep data for the specified motor

Return type:

SweepData1D

plot_all(show_event_times=False, *, title=None, x_label=None, y_label=None, **kwargs)[source]#

Plot sweep results of all motors on a single overlay grid.

Parameters:

  • show_event_times (bool, optional) – Whether to show event times on the plot instead of points (default is False)

  • title (str, optional) – Overall title for the grid

  • x_label (str, optional) – Common x-axis label. Defaults to the first motor’s var_name.

  • y_label (str, optional) – Common y-axis label (e.g., “Points” or “Time (s)”)

  • kwargs (dict) – Additional keyword arguments for the overlay_grid_plot_2D function, including: rows, cols, show_legend, fit_curve, layout_config, font_config, smoothing_config

Returns:

Plotly figure object

Return type:

go.Figure

plot_single_motor_sweep_result(motor_name, y_var=SweepDatatype.TOTAL_PTS, *, title=None, **kawrgs)[source]#

Plot a single motor’s sweep results.

Parameters:

  • motor_name (str) – Name of the motor to plot

  • y_var (SweepDatatype, optional) – SweepDatatype to plot on y-axis (default is SweepDatatype.TOTAL_PTS)

  • title (str, optional) – Plot title

  • kawrgs (dict) – Additional keyword arguments for the plot method, including: subtitle, x_label, y_label, fit_curve, show_points, h_line, v_line, theme, font_config, layout_config, smoothing_config

Returns:

Plotly figure object

Return type:

go.Figure