ADCS.helpers.plot.sensors.biasplot module

class ADCS.helpers.plot.sensors.biasplot.BiasPlot(*, kind='sensor', time='time_s', title=None, units='', labels=None, log_y=False, sources=None)[source]

Bases: Subplot

Multi-panel visualization of sensor or actuator bias histories.

This class displays each bias component as a separate subplot, arranged automatically in a grid. Real and estimated bias histories can be shown simultaneously for comparison, depending on the selected sources.

The primary user controls are the bias type, displayed sources, labeling, units, and axis scaling.

Parameters:

  • kind (str) – Type of bias to plot. Must be either sensor or actuator.

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

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

  • units (str) – Physical units of the bias values.

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

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

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

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

None

class ADCS.helpers.plot.sensors.biasplot.BiasPlotCombined(*, kind='sensor', time='time_s', title=None, units='', labels=None, log_y=False, colors=None, sources=None)[source]

Bases: Subplot

Combined plot of all bias components on a single axis.

This class overlays all bias components on one set of axes, optionally including both real and estimated sources. It is useful for high-level comparison of bias magnitudes and trends across components.

The plot emphasizes user-defined labeling, colors, and axis scaling.

Parameters:

  • kind (str) – Type of bias to plot. Must be either sensor or actuator.

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

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

  • units (str) – Physical units of the bias values.

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

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

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

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

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

None

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

Bases: Subplot

Visualization of a single bias component over time.

This class plots one selected bias component for sensor or actuator biases. Real and estimated sources may be overlaid for direct comparison. It is intended for focused inspection of a specific bias term.

User settings determine which bias component is shown and how it is styled.

Parameters:

  • index (int) – Index of the bias component to plot.

  • kind (str) – Type of bias to plot. Must be either sensor or actuator.

  • 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 bias values.

  • label (str or None) – Label used for the bias component.

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

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

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

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

None