act.plotting.TimeSeriesDisplay.plot_stripes#

TimeSeriesDisplay.plot_stripes(field, dsname=None, subplot_index=(0,), set_title=None, reference_period=None, cmap='bwr', cbar_label=None, colorbar=True, **kwargs)[source]#

Makes a climate stripe plot with or without a baseline period specified

Parameters:

  • field (str) – The name of the field to plot.

  • dsname (None or str) – If there is more than one datastream in the display object the name of the datastream needs to be specified. If set to None and there is only one datastream ACT will use the sole datastream in the object.

  • subplot_index (1 or 2D tuple, list, or array) – The index of the subplot to set the x range of.

  • set_title (str) – The title for the plot.

  • reference_period (list) – List of a start and end date for a reference period [‘2020-01-01’, ‘2020-04-01’] If this is set, the plot will subtract the mean of the reference period from the field to create an anomaly calculation.

  • cmap (string) – Colormap to use for plotting. Defaults to bwr

  • cbar_label (str) – Option to overwrite default colorbar label.

  • colorbar (boolean) – Option to not plot the colorbar. Default is to plot it

  • **kwargs (keyword arguments) – The keyword arguments for plt.plot() (1D timeseries) or plt.pcolormesh() (2D timeseries).

Returns:

ax (matplotlib axis handle) – The matplotlib axis handle of the plot.