utils.plotting.bootstrap_fill_plot

utils.plotting.bootstrap_fill_plot(
    series,
    ax=None,
    line_color=None,
    fill_color=None,
    transition_interval=None,
    plot_kwargs=None,
    ci_kwargs=None,
    background_series=None,
    background_kwargs=None,
)

Plot RQA results with bootstrap confidence bounds as a filled region

Parameters

series : pyleoclim.Series

Series object containing the timeseries to plot.

ax : matplotlib.axes.Axes = None

Axes to plot on. If None, a new figure will be generated.

line_color : str or tuple = None

String or RGB tuple to use for the line colour.

fill_color : str or tuple = None

String or RGB tuple to use for the fill colour between confidence bounds.

transition_interval : list or tuple = None

(upper, lower) bounds for the transition interval. If None, computed automatically via bootstrapping using ci_kwargs.

plot_kwargs : dict = None

Keyword arguments for the main plot. See pyleoclim.Series.plot <https://pyleoclim-util.readthedocs.io/en/latest/core/api.html#series-pyleoclim-series>_ for details.

ci_kwargs : dict = None

Keyword arguments for calculating the confidence interval. Only used if transition_interval is not passed. See ammonyte.utils.sampling.confidence_interval for details.

background_series : pyleoclim.Series = None

Optional series to plot behind the main series.

background_kwargs : dict = None

Keyword arguments for the background plot. If not passed, the colour of the main plot will be reused and alpha will be set to 0.2.

Returns

fig : matplotlib.figure.Figure

The figure object from matplotlib. See matplotlib.pyplot.figure <https://matplotlib.org/stable/api/figure_api.html>_ for details.

ax : matplotlib.axes.Axes

The axis object from matplotlib. See matplotlib.axes <https://matplotlib.org/stable/api/axes_api.html>_ for details.

See Also

ammonyte.utils.sampling.confidence_interval