pydda.vis.plot_xz_xsection_streamlines#

pydda.vis.plot_xz_xsection_streamlines(Grids, ax=None, background_field='reflectivity', level=1, cmap='ChaseSpectral', vmin=0, vmax=70, u_vel_contours=None, v_vel_contours=None, w_vel_contours=None, wind_vel_contours=None, u_field='u', v_field='v', w_field='w', title_flag=True, axes_labels_flag=True, colorbar_flag=True, colorbar_contour_flag=False, bg_grid_no=0, contour_alpha=0.7, arrowsize=1.0, linewidth=None)[source]#

This procedure plots a cross section of winds from wind fields generated by PyDDA in the X-Z plane using streamlines. The density of streamlines varies with horizontal wind speed.

Parameters:

  • Grids (list or DataTree) – List of Py-DDA Grids to visualize

  • ax (matplotlib axis handle) – The axis handle to place the plot on. Set to None to plot on the current axis.

  • background_field (str) – The name of the background field to plot the streamlines on.

  • level (int) – The number of the Y level to plot the cross section through.

  • cmap (str or matplotlib colormap) – The name of the matplotlib colormap to use for the background field.

  • vmin (float) – The minimum bound to use for plotting the background field. None will automatically detect the background field minimum.

  • vmax (float) – The maximum bound to use for plotting the background field. None will automatically detect the background field maximum.

  • u_vel_contours (1-D array) – The contours to use for plotting contours of u. Set to None to not display such contours.

  • v_vel_contours (1-D array) – The contours to use for plotting contours of v. Set to None to not display such contours.

  • w_vel_contours (1-D array) – The contours to use for plotting contours of w. Set to None to not display such contours.

  • wind_vel_contours (1-D array) – The contours to use for plotting contours of horizontal wind speed. Set to None to not display such contours.

  • u_field (str) – Name of zonal wind (u) field in Grids.

  • v_field (str) – Name of meridional wind (v) field in Grids.

  • w_field (str) – Name of vertical wind (w) field in Grids.

  • show_lobes (bool) – If True, the dual doppler lobes from each pair of radars will be shown.

  • title_flag (bool) – If True, PyDDA will generate a title for the plot.

  • axes_labels_flag (bool) – If True, PyDDA will generate axes labels for the plot

  • colorbar_flag (bool) – If True, PyDDA will generate a colorbar for the plot background field.

  • colorbar_contour_flag (bool) – If True, PyDDA will generate a colorbar for the contours.

  • bg_grid_no (int) – Number of grid in Grids to take background field from. Set to -1 to use maximum value from all grids.

  • contour_alpha (float) – Alpha (transparency) of velocity contours. 0 = transparent, 1 = opaque

  • arrowsize (float) – Factor scale arrow size for streamlines.

  • linewidth (numeric or 2d array) – Linewidths for streamlines.

Returns:

ax (matplotlib axis) – Axis handle to output axis

On this page
Show Source