ADCS.helpers.plot.sensors.sensorsplot module

class ADCS.helpers.plot.sensors.sensorsplot.SensorsPlot(*, time='time_s', title='Sensors', units='', labels=None, log_y=False, sources=None)[source]

Bases: Subplot

Multi-panel visualization of sensor measurement histories.

This class displays each sensor channel in its own subplot, arranged automatically in a grid. Multiple data sources, such as real and clean sensor readings, may be overlaid for comparison.

The plot is configured primarily through user settings for sources, labeling, units, and axis scaling.

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 sensor readings.

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

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

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

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

None

class ADCS.helpers.plot.sensors.sensorsplot.SensorsPlotCombined(*, time='time_s', title='Sensors', units='', labels=None, log_y=False, colors=None, sources=None)[source]

Bases: Subplot

Combined plot of all sensor channels on a single axis.

This class overlays all sensor channels on one set of axes, optionally including multiple data sources. It provides a compact, high-level view of sensor activity and relative magnitudes.

The plot emphasizes user-defined configuration of labels, colors, units, and axis scaling.

Parameters:

  • 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 sensor readings.

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

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

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

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

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

None

class ADCS.helpers.plot.sensors.sensorsplot.SensorsPlotSingle(index, *, time='time_s', title=None, units='', label=None, color=None, log_y=False, sources=None)[source]

Bases: Subplot

Visualization of a single sensor channel over time.

This class plots one selected sensor channel, optionally overlaying multiple data sources such as real and clean measurements. It is intended for focused inspection of a specific sensor output.

User settings control the selected channel, labeling, color, and axis scaling.

Parameters:

  • index (int) – Index of the sensor 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 sensor readings.

  • label (str or None) – Label used for the sensor channel.

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

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

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

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

None