act.plotting.TimeSeriesDisplay.time_height_scatter

TimeSeriesDisplay.time_height_scatter(data_field=None, alt_field='alt', dsname=None, cmap='rainbow', alt_label=None, cb_label=None, subplot_index=(0,), plot_alt_field=False, cb_friendly=False, day_night_background=False, set_title=None, **kwargs)[source]

Create a time series plot of altitude and data variable with color also indicating value with a color bar. The Color bar is positioned to serve both as the indicator of the color intensity and the second y-axis.

Parameters:
  • data_field (str) – Name of data field in the dataset to plot on second y-axis.

  • alt_field (str) – Variable to use for y-axis.

  • dsname (str or None) – The name of the datastream to plot.

  • cmap (str) – Colorbar color map to use.

  • alt_label (str) – Altitude first y-axis label to use. If None, will try to use long_name and units.

  • cb_label (str) – Colorbar label to use. If not set will try to use long_name and units.

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

  • plot_alt_field (boolean) – Set to true to plot the altitude field on the secondary y-axis

  • cb_friendly (boolean) – If set to True will use the Homeyer colormap

  • day_night_background (boolean) – If set to True will plot the day_night_background

  • set_title (str) – Title to set on the plot

  • **kwargs (keyword arguments) – Any other keyword arguments that will be passed into TimeSeriesDisplay.plot module when the figure is made.