navlie.utils.plot.plot_nees¶
- navlie.utils.plot.plot_nees(results: GaussianResultList, ax: Axes | None = None, label: str | None = None, color=None, confidence_interval: float = 0.95, normalize: bool = False, expected_nees_color='r') → Tuple[Figure, Axes]¶
Makes a plot of the NEES, showing the actual NEES values, the expected NEES, and the bounds of the specified confidence interval.
- Parameters:
results (GaussianResultList or MonteCarloResult) – Results to plot
ax (plt.Axes, optional) – Axes on which to draw, by default None. If None, new axes will be created.
label (str, optional) – Label to assign to the NEES line, by default None
color (optional) – Fed directly to the
plot(..., color=color)
function, by default Noneconfidence_interval (float or None, optional) – Desired probability confidence region, by default 0.95. Must lie between 0 and 1. If None, no confidence interval will be plotted.
normalize (bool, optional) – Whether to normalize the NEES by the degrees of freedom, by default False
- Returns:
plt.Figure – Figure on which the plot was drawn
plt.Axes – Axes on which the plot was drawn