solarwindpy.solar_activity.plots

Plotting helpers for solar activity indicators.

Classes

IndicatorPlot(indicator, ykey[, plasma_index])

Base class for plotting a solar activity indicator.

SSNPlot(indicator, **kwargs)

Plotter specialised for sunspot number.
class IndicatorPlot(indicator, ykey, plasma_index=None)[source]

Bases: Base

Base class for plotting a solar activity indicator.

Parameters:

  • indicator (ActivityIndicator) – Object providing the time series to plot.

  • ykey (str) – Column in indicator.data to display.

  • plasma_index (pandas.DatetimeIndex, optional) – Restrict plotted data to this index.

__init__(indicator, ykey, plasma_index=None)[source]
property indicator
property plasma_index
property ykey
property plot_data
set_path(new, add_scale=True)[source]

Build the plot save path.

Parameters:

  • new (str or Path) – If str and == “auto”, then build path from self.labels. Otherwise, assume parameter specifies the desired path and use Path(new).

  • add_scale (bool) – If True, add information about the axis scales to the end of the path.

set_data(indicator, ykey, plasma_index)[source]
make_plot(ax=None)[source]
property clip
property data
property labels
property log
property logger
property path

Path for saving figure.

set_labels(**kwargs)

Set or update x, y, or z labels. Any label not specified in kwargs.

is propagated from self.labels.<x, y, or z>.

set_log(x=None, y=None)
class SSNPlot(indicator, **kwargs)[source]

Bases: IndicatorPlot

Plotter specialised for sunspot number.

__init__(indicator, **kwargs)[source]
property clip
property data
property indicator
property labels
property log
property logger
make_plot(ax=None)
property path

Path for saving figure.

property plasma_index
property plot_data
set_data(indicator, ykey, plasma_index)
set_labels(**kwargs)

Set or update x, y, or z labels. Any label not specified in kwargs.

is propagated from self.labels.<x, y, or z>.

set_log(x=None, y=None)
set_path(new, add_scale=True)

Build the plot save path.

Parameters:

  • new (str or Path) – If str and == “auto”, then build path from self.labels. Otherwise, assume parameter specifies the desired path and use Path(new).

  • add_scale (bool) – If True, add information about the axis scales to the end of the path.

property ykey