ADCS.helpers.plot.orbit.orbitmagneticplot module

class ADCS.helpers.plot.orbit.orbitmagneticplot.OrbitMagneticPlot(*, time='time_s', title='Magnetic Field (ECI)', units='T', colors=('tab:blue', 'tab:orange', 'tab:green'), mag_color='tab:red', log_y=False)[source]

Bases: Subplot

Multi-panel visualization of the geomagnetic field along the orbit.

This class displays the three Cartesian components of the magnetic field in the inertial frame, together with the field magnitude, arranged in a fixed grid layout. It is intended for quick inspection of magnetic environment variations during orbital motion.

Users mainly control appearance options such as colors, axis scaling, and labeling.

Parameters:

  • 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 magnetic field values.

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

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

  • log_y (bool) – If True, all magnetic field axes use logarithmic scaling.

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

None

class ADCS.helpers.plot.orbit.orbitmagneticplot.OrbitMagneticPlotSingle(*, component, time='time_s', title=None, units='T', color=None, log_y=False, labels=None)[source]

Bases: Subplot

Single-component visualization of the geomagnetic field.

This class plots one selected magnetic field component or the field magnitude as a function of time. It is useful when focusing on a specific direction or when embedding a single magnetic signal into a larger figure.

The component, labeling, and visual style are fully user-configurable.

Parameters:

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

  • 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 magnetic field values.

  • color (str or None) – Color used for the plotted magnetic field 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