pingwyn.plot_profile

Plot a profile.

param ax:: 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.
type ax:: matplotlib.axes.Axes
param profile:: The profile object to draw
type profile:: pingwyn.Profile
param image:: Image object that corresponds to the profile. Used to extract metadata for the profile distance in SI units. By default None.
type image:: pingwyn.Image, optional
param ax_image:: Reference to the plotted image where an arrow corresponding to the profile should be drawn. By default None.
type ax_image:: matplotlib.axes.Axes, optional
param width:: Relative size of the arrow head, by default 3.
type width:: int, optional
param arrow_label:: A text label that will be plotted next to the drawn arrow head if ax_image is not None. By default “”.
type arrow_label:: str, optional
param **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.