act.plotting.TimeSeriesDisplay.plot_time_height_xsection_from_1d_data¶
- TimeSeriesDisplay.plot_time_height_xsection_from_1d_data(data_field, pres_field, dsname=None, subplot_index=(0,), set_title=None, day_night_background=False, num_time_periods=20, num_y_levels=20, invert_y_axis=True, cbar_label=None, set_shading='auto', **kwargs)[source]¶
This will plot a time-height cross section from 1D datasets using nearest neighbor interpolation on a regular time by height grid. All that is needed are a data variable and a height variable.
- Parameters:
data_field (str) – The name of the field to plot.
pres_field (str) – The name of the height or pressure field to plot.
dsname (str or None) – The name of the datastream to plot
subplot_index (2-tuple) – The index of the subplot to create the plot on.
set_title (str or None) – The title of the plot.
day_night_background (bool) – Set to true to plot the day/night background.
num_time_periods (int) – Set to determine how many time periods. Setting to None will do one time period per day.
num_y_levels (int) – The number of levels in the y axis to use.
invert_y_axis (bool) – Set to true to invert the y-axis (recommended for pressure coordinates).
cbar_label (str) – Option to overwrite default colorbar label.
set_shading (string) – Option to to set the matplotlib.pcolormesh shading parameter. Default to ‘auto’
**kwargs (keyword arguments) – Additional keyword arguments will be passed into
plt.pcolormesh()
- Returns:
ax (matplotlib axis handle) – The matplotlib axis handle pointing to the plot.