ADCS.helpers.plot.control.controlplot module

class ADCS.helpers.plot.control.controlplot.ControlPlot(*, time='time_s', title='Control Inputs', units='', labels=None, log_y=False)[source]

Bases: Subplot

Multi-panel visualization of all control input channels.

This class provides a compact overview of each control channel stored in the simulation control history, arranged automatically in a grid of subplots. Each channel is plotted separately with optional actuator saturation limits. The class is intended for quick inspection of control activity rather than detailed tuning.

The plot reads control inputs from the simulation and displays them as functions of time. If actuator limits are available from the simulation satellite model, symmetric bounds are overlaid for reference.

Parameters:

  • time (str) – Name of the simulation attribute containing the time vector in seconds.

  • title (str) – Title displayed at the top of the subplot group.

  • units (str) – Physical units of the control inputs, displayed on the y-axis labels.

  • labels (list[str] or None) – Optional list of labels for each control channel.

  • log_y (bool) – If True, the y-axis of each subplot is displayed on a logarithmic scale.

plot(ax, sim)[source]
Return type:

None

class ADCS.helpers.plot.control.controlplot.ControlPlotCombined(*, time='time_s', title='Control Inputs', units='', labels=None, log_y=False, colors=None)[source]

Bases: Subplot

Combined visualization of all control input channels on a single axis.

This class plots all control channels together in one figure, enabling direct comparison of magnitudes and temporal behavior. Each channel is assigned a distinct label and optional color. Actuator saturation limits are shown when available.

This representation is useful for high-level assessment of control effort and relative channel usage.

Parameters:

  • time (str) – Name of the simulation attribute containing the time vector in seconds.

  • title (str) – Title of the plot.

  • units (str) – Physical units of the control inputs.

  • labels (list[str] or None) – Optional list of labels for each control channel.

  • log_y (bool) – If True, the y-axis is displayed on a logarithmic scale.

  • colors (list[str] or None) – Optional list of colors used cyclically for control channels.

plot(ax, sim)[source]
Return type:

None

class ADCS.helpers.plot.control.controlplot.ControlPlotSingle(index, *, time='time_s', title=None, units='', label=None, color=None, log_y=False)[source]

Bases: Subplot

Visualization of a single control input channel.

This class plots one selected control channel versus time, allowing focused inspection of a specific actuator or control dimension. Optional actuator saturation limits are shown when available.

The plot is suitable for detailed analysis or comparison across multiple figures when individual control channels are of interest.

Parameters:

  • index (int) – Index of the control channel to plot.

  • time (str) – Name of the simulation attribute containing the time vector in seconds.

  • title (str or None) – Title of the plot. If None, a default title is used.

  • units (str) – Physical units of the control input.

  • label (str or None) – Label for the plotted control signal.

  • color (str or None) – Matplotlib color specification for the control signal.

  • log_y (bool) – If True, the y-axis is displayed on a logarithmic scale.

plot(ax, sim)[source]
Return type:

None