ADCS.helpers.plot.states.quaternionplot module

class ADCS.helpers.plot.states.quaternionplot.QuaternionPlot(*, sources=None, time='time_s', title='Quaternion Components', units='', colors=('tab:blue', 'tab:orange', 'tab:green', 'tab:red'))[source]

Bases: Subplot

Multi-panel visualization of quaternion components over time.

This class displays the four quaternion components in a fixed 2x2 layout, allowing comparison between real and estimated attitude representations. The plot is intended to give a clear overview of quaternion behavior without requiring knowledge of the underlying attitude propagation.

User configuration focuses on selecting data sources, colors, units, and the time reference used for the x-axis.

Parameters:

  • sources (list[str] or None) – List of quaternion sources to display. Supported values are real and estimated. If None, only the real quaternion is shown.

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

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

  • units (str) – Optional units string appended to quaternion component labels.

  • colors (tuple[str, str, str, str]) – Colors used for the quaternion components q0, q1, q2, and q3.

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

None

class ADCS.helpers.plot.states.quaternionplot.QuaternionPlotCombined(*, sources=None, time='time_s', title='Quaternion Components', units='', colors=('tab:blue', 'tab:orange', 'tab:green', 'tab:red'))[source]

Bases: Subplot

Combined plot of all quaternion components on a single axis.

This class overlays all four quaternion components on one set of axes, optionally including both real and estimated data. It provides a compact view suitable for quick comparison of relative component behavior.

The plot emphasizes user-defined configuration of sources, colors, units, and the time reference.

Parameters:

  • sources (list[str] or None) – List of quaternion sources to display. Supported values are real and estimated.

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

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

  • units (str) – Optional units string appended to the y-axis label.

  • colors (tuple[str, str, str, str]) – Colors used for the quaternion components q0, q1, q2, and q3.

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

None

class ADCS.helpers.plot.states.quaternionplot.QuaternionPlotSingle(*, component, sources=None, time='time_s', title=None, units='', color=None, colors=('tab:blue', 'tab:orange', 'tab:green', 'tab:red'))[source]

Bases: Subplot

Visualization of a single quaternion component over time.

This class plots one selected quaternion component, optionally overlaying real and estimated values. It is intended for focused inspection of a specific quaternion element.

User settings control which component is displayed, visual styling, labeling, and the time reference.

Parameters:

  • component (int) – Quaternion component index to plot. Must be one of 0, 1, 2, or 3.

  • sources (list[str] or None) – List of quaternion sources to display. Supported values are real and estimated.

  • 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) – Optional units string appended to the y-axis label.

  • color (str or None) – Color used for the plotted quaternion component.

  • colors (tuple[str, str, str, str]) – Default colors for quaternion components q0, q1, q2, and q3.

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

None

class ADCS.helpers.plot.states.quaternionplot.Subplot[source]

Bases: ABC

plot(ax, sim)[source]
Parameters:

ax (matplotlib.pyplot.Axes)

Return type:

None