pyorc.Velocimetry.plot.quiver#

Velocimetry.plot.quiver(x, y, u, v, s=None, ax=None, **kwargs)#

Create quiver plot from velocimetry results on new or existing axes.

Note that the width parameter is always in a unitless scale, with 1 providing a nice-looking default value for all plot modes. The default value is usually very nice. If you do want to change:

The scale parameter defaults to 1, providing a nice looking arrow length. With a smaller (larger) value, quivers will become longer (shorter).

The width parameter is in a unitless scale, with 1 providing a nice-looking default value.

Wraps matplotlib:matplotlib.pyplot.quiver().

Parameters:

mode (str, optional) – perspective mode to use for plotting. Can be “local” (default), “geographical”, or “camera”. For “geographical” a velocimetry result that contains “lon” and “lat” coordinates must be provided (i.e. produced with known CRS for control points).
x (str, optional) – Coordinate for x axis. If None, use darray.dims[1].
y (str, optional) – Coordinate for y axis. If None, use darray.dims[0].
ax (plt.axes, optional) – If None (default), use the current axes. Not applicable when using facets.
**kwargs (additional keyword arguments to wrapped Matplotlib function.) –

Returns:

artist – The same type of primitive artist that the wrapped Matplotlib function returns.

Return type:

matplotlib mappable