ADCS.helpers.plot.orbit.orbitvelocityplot module

class ADCS.helpers.plot.orbit.orbitvelocityplot.OrbitVelocityPlot(*, sources=None, time='time_s', title='Orbit Velocity (ECI)', units='km/s', colors=('tab:blue', 'tab:orange', 'tab:green'), mag_color='tab:red', log_y=False)[source]

Bases: Subplot

Multi-panel visualization of spacecraft velocity components in ECI.

This class displays the Cartesian velocity components and the velocity magnitude as functions of time, arranged in a fixed grid layout. Real and estimated velocity histories can be shown together for comparison.

User configuration focuses on selecting data sources, visual styling, units, and axis scaling.

Parameters:

  • sources (list[str] or None) – List of orbit velocity sources to display. Supported values are real and estimated. If None, only the real velocity 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) – Physical units of the velocity components.

  • colors (tuple[str, str, str]) – Colors used for the x, y, and z velocity components.

  • mag_color (str) – Color used for the velocity magnitude plot.

  • log_y (bool) – If True, the y-axes use logarithmic scaling.

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

None

class ADCS.helpers.plot.orbit.orbitvelocityplot.OrbitVelocityPlotCombined(*, sources=None, time='time_s', title='Orbit Velocity (ECI)', units='km/s', colors=('tab:blue', 'tab:orange', 'tab:green'), log_y=False, labels=None)[source]

Bases: Subplot

Combined plot of all spacecraft velocity components in ECI.

This class overlays the x, y, and z velocity components on a single set of axes, enabling direct comparison of component magnitudes and trends over time. Real and estimated sources may be displayed simultaneously.

The plot emphasizes user-defined appearance options such as colors, labels, and axis scaling.

Parameters:

  • sources (list[str] or None) – List of orbit velocity 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) – Physical units of the velocity values.

  • colors (tuple[str, str, str]) – Colors used for the x, y, and z velocity components.

  • log_y (bool) – If True, the y-axis uses logarithmic scaling.

  • labels (list[str] or None) – Labels used for the velocity components.

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

None

class ADCS.helpers.plot.orbit.orbitvelocityplot.OrbitVelocityPlotSingle(*, component, sources=None, time='time_s', title=None, units='km/s', color=None, log_y=False, labels=None)[source]

Bases: Subplot

Single-component visualization of spacecraft velocity in ECI.

This class plots one selected velocity component or the velocity magnitude as a function of time. It supports overlaying real and estimated data and is suited for focused inspection of a single velocity dimension.

The user controls the component selection, labeling, color, and axis scaling.

Parameters:

  • component (str) – Velocity component to plot. Must be one of x, y, z, or m for magnitude.

  • sources (list[str] or None) – List of orbit velocity 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) – Physical units of the velocity values.

  • color (str or None) – Color used for the plotted velocity signal.

  • log_y (bool) – If True, the y-axis uses logarithmic scaling.

  • labels (dict[str, str] or None) – Optional mapping from component identifiers to display labels.

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

None