act.plotting.TimeSeriesDisplay.plot_barbs_from_u_v#

TimeSeriesDisplay.plot_barbs_from_u_v(u_field, v_field, pres_field=None, dsname=None, subplot_index=(0,), set_title=None, day_night_background=False, invert_y_axis=True, num_barbs_x=20, num_barbs_y=20, barb_step_x=None, barb_step_y=None, use_var_for_y=None, **kwargs)[source]#

This function will plot a wind barb timeseries from u and v wind data. If pres_field is given, a time-height series will be plotted from 1-D wind data.

Parameters:

  • u_field (str) – The name of the field containing the U component of the wind.

  • v_field (str) – The name of the field containing the V component of the wind.

  • pres_field (str or None) – The name of the field containing the pressure or height. Set to None to not use this.

  • dsname (str or None) – The name of the datastream to plot. Setting to None will make ACT automatically try to determine this.

  • subplot_index (2-tuple) – The index of the subplot to make the plot on.

  • set_title (str or None) – The title of the plot.

  • day_night_background (bool) – Set to True to plot a day/night background.

  • invert_y_axis (bool) – Set to True to invert the y axis (i.e. for plotting pressure as the height coordinate).

  • num_barbs_x (int) – The number of wind barbs to plot in the x axis.

  • num_barbs_y (int) – The number of wind barbs to plot in the y axis.

  • barb_step_x (int) – Step between each wind barb to plot. If set, will override values given for num_barbs_x

  • barb_step_y (int) – Step between each wind barb to plot. If set, will override values given for num_barbs_y

  • cmap (matplotlib.colors.LinearSegmentedColormap) – A color map to use with wind barbs. If this is set the plt.barbs routine will be passed the C parameter scaled as sqrt of sum of the squares and used with the passed in color map. A colorbar will also be added. Setting the limits of the colorbar can be done with ‘clim’. Setting this changes the wind barbs from black to colors.

  • use_var_for_y (str) – Set this to the name of a data variable in the Dataset to use as the y-axis variable instead of the default dimension. Useful for instances where data has an index-based dimension instead of a height-based dimension. If shapes of arrays do not match it will automatically revert back to the original ydata.

  • **kwargs (keyword arguments) – Additional keyword arguments will be passed into plt.barbs.

Returns:

ax (matplotlib axis handle) – The axis handle that contains the reference to the constructed plot.