pingwyn.plot_profile

pingwyn.plot_profile(ax, profile, image=None, ax_image=None, width=3, arrow_label='', cbar_ax=None, **kwargs)

Plot a profile.

Parameters:

ax (matplotlib.axes.Axes) – The axis to draw the image onto. If ax is None, no profile is drawn. This can be used in combination with setting ax_image to only draw the profile arrow.
profile (pingwyn.Profile) – The profile object to draw
image (pingwyn.Image, optional) – Image object that corresponds to the profile. Used to extract metadata for the profile distance in SI units. By default None.
ax_image (matplotlib.axes.Axes, optional) – Reference to the plotted image where an arrow corresponding to the profile should be drawn. By default None.
width (int, optional) – Relative size of the arrow head, by default 3.
arrow_label (str, optional) – A text label that will be plotted next to the drawn arrow head if ax_image is not None. By default “”.
**kwargs – Any additional keyword arguments provided will be passed onto ax.imshow() or ax.set(), whichever is applicable. Note: providing xlabel, `ylabel, `title, extent, vmin, vmax, aspect, cmap or `interpolation as keyword arguments will override some default behaviour of this function.