matplotlib.quiver.Quiver#

class matplotlib.quiver.Quiver(ax, *args, scale=None, headwidth=3, headlength=5, headaxislength=4.5, minshaft=1, minlength=1, units='width', scale_units=None, angles='uv', width=None, color='k', pivot='tail', **kwargs)[source]#

Bases: PolyCollection

Specialized PolyCollection for arrows.

The only API method is set_UVC(), which can be used to change the size, orientation, and color of the arrows; their locations are fixed when the class is instantiated. Possibly this method will be useful in animations.

Much of the work in this class is done in the draw() method so that as much information as possible is available about the plot. In subsequent draw() calls, recalculation is limited to things that might have changed, so there should be no performance penalty from putting the calculations in the draw() method.

The constructor takes one required argument, an Axes instance, followed by the args and kwargs described by the following pyplot interface documentation:

Plot a 2D field of arrows.

Call signature:

quiver([X, Y], U, V, [C], **kwargs)

X, Y define the arrow locations, U, V define the arrow directions, and C optionally sets the color.

Arrow length

The default settings auto-scales the length of the arrows to a reasonable size. To change this behavior see the scale and scale_units parameters.

Arrow shape

The arrow shape is determined by width, headwidth, headlength and headaxislength. See the notes below.

Arrow styling

Each arrow is internally represented by a filled polygon with a default edge linewidth of 0. As a result, an arrow is rather a filled area, not a line with a head, and PolyCollection properties like linewidth, edgecolor, facecolor, etc. act accordingly.

Parameters:
X, Y1D or 2D array-like, optional

The x and y coordinates of the arrow locations.

If not given, they will be generated as a uniform integer meshgrid based on the dimensions of U and V.

If X and Y are 1D but U, V are 2D, X, Y are expanded to 2D using X, Y = np.meshgrid(X, Y). In this case len(X) and len(Y) must match the column and row dimensions of U and V.

U, V1D or 2D array-like

The x and y direction components of the arrow vectors. The interpretation of these components (in data or in screen space) depends on angles.

U and V must have the same number of elements, matching the number of arrow locations in X, Y. U and V may be masked. Locations masked in any of U, V, and C will not be drawn.

C1D or 2D array-like, optional

Numeric data that defines the arrow colors by colormapping via norm and cmap.

This does not support explicit colors. If you want to set colors directly, use color instead. The size of C must match the number of arrow locations.

angles{'uv', 'xy'} or array-like, default: 'uv'

Method for determining the angle of the arrows.

  • 'uv': Arrow direction in screen coordinates. Use this if the arrows symbolize a quantity that is not based on X, Y data coordinates.

    If U == V the orientation of the arrow on the plot is 45 degrees counter-clockwise from the horizontal axis (positive to the right).

  • 'xy': Arrow direction in data coordinates, i.e. the arrows point from (x, y) to (x+u, y+v). Use this e.g. for plotting a gradient field.

  • Arbitrary angles may be specified explicitly as an array of values in degrees, counter-clockwise from the horizontal axis.

    In this case U, V is only used to determine the length of the arrows.

Note: inverting a data axis will correspondingly invert the arrows only with angles='xy'.

pivot{'tail', 'mid', 'middle', 'tip'}, default: 'tail'

The part of the arrow that is anchored to the X, Y grid. The arrow rotates about this point.

'mid' is a synonym for 'middle'.

scalefloat, optional

Scales the length of the arrow inversely.

Number of data units per arrow length unit, e.g., m/s per plot width; a smaller scale parameter makes the arrow longer. Default is None.

If None, a simple autoscaling algorithm is used, based on the average vector length and the number of vectors. The arrow length unit is given by the scale_units parameter.

scale_units{'width', 'height', 'dots', 'inches', 'x', 'y', 'xy'}, optional

If the scale kwarg is None, the arrow length unit. Default is None.

e.g. scale_units is 'inches', scale is 2.0, and (u, v) = (1, 0), then the vector will be 0.5 inches long.

If scale_units is 'width' or 'height', then the vector will be half the width/height of the axes.

If scale_units is 'x' then the vector will be 0.5 x-axis units. To plot vectors in the x-y plane, with u and v having the same units as x and y, use angles='xy', scale_units='xy', scale=1.

units{'width', 'height', 'dots', 'inches', 'x', 'y', 'xy'}, default: 'width'

Affects the arrow size (except for the length). In particular, the shaft width is measured in multiples of this unit.

Supported values are:

  • 'width', 'height': The width or height of the Axes.

  • 'dots', 'inches': Pixels or inches based on the figure dpi.

  • 'x', 'y', 'xy': X, Y or \(\sqrt{X^2 + Y^2}\) in data units.

The following table summarizes how these values affect the visible arrow size under zooming and figure size changes:

units

zoom

figure size change

'x', 'y', 'xy'

arrow size scales

'width', 'height'

arrow size scales

'dots', 'inches'

widthfloat, optional

Shaft width in arrow units. All head parameters are relative to width.

The default depends on choice of units above, and number of vectors; a typical starting value is about 0.005 times the width of the plot.

headwidthfloat, default: 3

Head width as multiple of shaft width. See the notes below.

headlengthfloat, default: 5

Head length as multiple of shaft width. See the notes below.

headaxislengthfloat, default: 4.5

Head length at shaft intersection as multiple of shaft width. See the notes below.

minshaftfloat, default: 1

Length below which arrow scales, in units of head length. Do not set this to less than 1, or small arrows will look terrible!

minlengthfloat, default: 1

Minimum length as a multiple of shaft width; if an arrow length is less than this, plot a dot (hexagon) of this diameter instead.

colorcolor or color sequence, optional

Explicit color(s) for the arrows. If C has been set, color has no effect.

This is a synonym for the PolyCollection facecolor parameter.

Returns:
Quiver
Other Parameters:
dataindexable object, optional

DATA_PARAMETER_PLACEHOLDER

**kwargsPolyCollection properties, optional

All other keyword arguments are passed on to PolyCollection:

Property

Description

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

array-like or scalar or None

animated

bool

antialiased or aa or antialiaseds

bool or list of bools

array

array-like or None

capstyle

CapStyle or {'butt', 'projecting', 'round'}

clim

(vmin: float, vmax: float)

clip_box

Bbox

clip_on

bool

clip_path

Patch or (Path, Transform) or None

cmap

Colormap or str or None

color

color or list of rgba tuples

edgecolor or ec or edgecolors

color or list of colors or 'face'

facecolor or facecolors or fc

color or list of colors

figure

Figure

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle or dashes or linestyles or ls

str or tuple or list thereof

linewidth or linewidths or lw

float or list of floats

mouseover

bool

norm

Normalize or None

offset_transform or transOffset

unknown

offsets

(N, 2) or (2,) array-like

path_effects

AbstractPathEffect

paths

list of array-like

picker

None or bool or float or callable

pickradius

float

rasterized

bool

sizes

ndarray or None

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

transform

Transform

url

str

urls

list of str or None

verts

list of array-like

verts_and_codes

unknown

visible

bool

zorder

float

See also

Axes.quiverkey

Add a key to a quiver plot.

Notes

Arrow shape

The arrow is drawn as a polygon using the nodes as shown below. The values headwidth, headlength, and headaxislength are in units of width.

../../_images/quiver_sizes.svg

The defaults give a slightly swept-back arrow. Here are some guidelines how to get other head shapes:

  • To make the head a triangle, make headaxislength the same as headlength.

  • To make the arrow more pointed, reduce headwidth or increase headlength and headaxislength.

  • To make the head smaller relative to the shaft, scale down all the head parameters proportionally.

  • To remove the head completely, set all head parameters to 0.

  • To get a diamond-shaped head, make headaxislength larger than headlength.

  • Warning: For headaxislength < (headlength / headwidth), the "headaxis" nodes (i.e. the ones connecting the head with the shaft) will protrude out of the head in forward direction so that the arrow head looks broken.

draw(renderer)[source]#

Draw the Artist (and its children) using the given renderer.

This has no effect if the artist is not visible (Artist.get_visible returns False).

Parameters:
rendererRendererBase subclass.

Notes

This method is overridden in the Artist subclasses.

get_datalim(transData)[source]#
quiver_doc = '\nPlot a 2D field of arrows.\n\nCall signature::\n\n  quiver([X, Y], U, V, [C], **kwargs)\n\n*X*, *Y* define the arrow locations, *U*, *V* define the arrow directions, and\n*C* optionally sets the color.\n\n**Arrow length**\n\nThe default settings auto-scales the length of the arrows to a reasonable size.\nTo change this behavior see the *scale* and *scale_units* parameters.\n\n**Arrow shape**\n\nThe arrow shape is determined by *width*, *headwidth*, *headlength* and\n*headaxislength*. See the notes below.\n\n**Arrow styling**\n\nEach arrow is internally represented by a filled polygon with a default edge\nlinewidth of 0. As a result, an arrow is rather a filled area, not a line with\na head, and `.PolyCollection` properties like *linewidth*, *edgecolor*,\n*facecolor*, etc. act accordingly.\n\n\nParameters\n----------\nX, Y : 1D or 2D array-like, optional\n    The x and y coordinates of the arrow locations.\n\n    If not given, they will be generated as a uniform integer meshgrid based\n    on the dimensions of *U* and *V*.\n\n    If *X* and *Y* are 1D but *U*, *V* are 2D, *X*, *Y* are expanded to 2D\n    using ``X, Y = np.meshgrid(X, Y)``. In this case ``len(X)`` and ``len(Y)``\n    must match the column and row dimensions of *U* and *V*.\n\nU, V : 1D or 2D array-like\n    The x and y direction components of the arrow vectors. The interpretation\n    of these components (in data or in screen space) depends on *angles*.\n\n    *U* and *V* must have the same number of elements, matching the number of\n    arrow locations in  *X*, *Y*. *U* and *V* may be masked. Locations masked\n    in any of *U*, *V*, and *C* will not be drawn.\n\nC : 1D or 2D array-like, optional\n    Numeric data that defines the arrow colors by colormapping via *norm* and\n    *cmap*.\n\n    This does not support explicit colors. If you want to set colors directly,\n    use *color* instead.  The size of *C* must match the number of arrow\n    locations.\n\nangles : {\'uv\', \'xy\'} or array-like, default: \'uv\'\n    Method for determining the angle of the arrows.\n\n    - \'uv\': Arrow direction in screen coordinates. Use this if the arrows\n      symbolize a quantity that is not based on *X*, *Y* data coordinates.\n\n      If *U* == *V* the orientation of the arrow on the plot is 45 degrees\n      counter-clockwise from the  horizontal axis (positive to the right).\n\n    - \'xy\': Arrow direction in data coordinates, i.e. the arrows point from\n      (x, y) to (x+u, y+v). Use this e.g. for plotting a gradient field.\n\n    - Arbitrary angles may be specified explicitly as an array of values\n      in degrees, counter-clockwise from the horizontal axis.\n\n      In this case *U*, *V* is only used to determine the length of the\n      arrows.\n\n    Note: inverting a data axis will correspondingly invert the\n    arrows only with ``angles=\'xy\'``.\n\npivot : {\'tail\', \'mid\', \'middle\', \'tip\'}, default: \'tail\'\n    The part of the arrow that is anchored to the *X*, *Y* grid. The arrow\n    rotates about this point.\n\n    \'mid\' is a synonym for \'middle\'.\n\nscale : float, optional\n    Scales the length of the arrow inversely.\n\n    Number of data units per arrow length unit, e.g., m/s per plot width; a\n    smaller scale parameter makes the arrow longer. Default is *None*.\n\n    If *None*, a simple autoscaling algorithm is used, based on the average\n    vector length and the number of vectors. The arrow length unit is given by\n    the *scale_units* parameter.\n\nscale_units : {\'width\', \'height\', \'dots\', \'inches\', \'x\', \'y\', \'xy\'}, optional\n    If the *scale* kwarg is *None*, the arrow length unit. Default is *None*.\n\n    e.g. *scale_units* is \'inches\', *scale* is 2.0, and ``(u, v) = (1, 0)``,\n    then the vector will be 0.5 inches long.\n\n    If *scale_units* is \'width\' or \'height\', then the vector will be half the\n    width/height of the axes.\n\n    If *scale_units* is \'x\' then the vector will be 0.5 x-axis\n    units. To plot vectors in the x-y plane, with u and v having\n    the same units as x and y, use\n    ``angles=\'xy\', scale_units=\'xy\', scale=1``.\n\nunits : {\'width\', \'height\', \'dots\', \'inches\', \'x\', \'y\', \'xy\'}, default: \'width\'\n    Affects the arrow size (except for the length). In particular, the shaft\n    *width* is measured in multiples of this unit.\n\n    Supported values are:\n\n    - \'width\', \'height\': The width or height of the Axes.\n    - \'dots\', \'inches\': Pixels or inches based on the figure dpi.\n    - \'x\', \'y\', \'xy\': *X*, *Y* or :math:`\\sqrt{X^2 + Y^2}` in data units.\n\n    The following table summarizes how these values affect the visible arrow\n    size under zooming and figure size changes:\n\n    =================  =================   ==================\n    units              zoom                figure size change\n    =================  =================   ==================\n    \'x\', \'y\', \'xy\'     arrow size scales   -\n    \'width\', \'height\'  -                   arrow size scales\n    \'dots\', \'inches\'   -                   -\n    =================  =================   ==================\n\nwidth : float, optional\n    Shaft width in arrow units. All head parameters are relative to *width*.\n\n    The default depends on choice of *units* above, and number of vectors;\n    a typical starting value is about 0.005 times the width of the plot.\n\nheadwidth : float, default: 3\n    Head width as multiple of shaft *width*. See the notes below.\n\nheadlength : float, default: 5\n    Head length as multiple of shaft *width*. See the notes below.\n\nheadaxislength : float, default: 4.5\n    Head length at shaft intersection as multiple of shaft *width*.\n    See the notes below.\n\nminshaft : float, default: 1\n    Length below which arrow scales, in units of head length. Do not\n    set this to less than 1, or small arrows will look terrible!\n\nminlength : float, default: 1\n    Minimum length as a multiple of shaft width; if an arrow length\n    is less than this, plot a dot (hexagon) of this diameter instead.\n\ncolor : color or color sequence, optional\n    Explicit color(s) for the arrows. If *C* has been set, *color* has no\n    effect.\n\n    This is a synonym for the `.PolyCollection` *facecolor* parameter.\n\nOther Parameters\n----------------\ndata : indexable object, optional\n    DATA_PARAMETER_PLACEHOLDER\n\n**kwargs : `~matplotlib.collections.PolyCollection` properties, optional\n    All other keyword arguments are passed on to `.PolyCollection`:\n\n    \n    .. table::\n       :class: property-table\n\n       =================================================================================================   ==============================================================================================================================================================\n       Property                                                                                            Description                                                                                                                                                   \n       =================================================================================================   ==============================================================================================================================================================\n       :meth:`agg_filter <matplotlib.artist.Artist.set_agg_filter>`                                        a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image\n       :meth:`alpha <matplotlib.collections.Collection.set_alpha>`                                         array-like or scalar or None                                                                                                                                  \n       :meth:`animated <matplotlib.artist.Artist.set_animated>`                                            bool                                                                                                                                                          \n       :meth:`antialiased <matplotlib.collections.Collection.set_antialiased>` or aa or antialiaseds       bool or list of bools                                                                                                                                         \n       :meth:`array <matplotlib.cm.ScalarMappable.set_array>`                                              array-like or None                                                                                                                                            \n       :meth:`capstyle <matplotlib.collections.Collection.set_capstyle>`                                   `.CapStyle` or {\'butt\', \'projecting\', \'round\'}                                                                                                                \n       :meth:`clim <matplotlib.cm.ScalarMappable.set_clim>`                                                (vmin: float, vmax: float)                                                                                                                                    \n       :meth:`clip_box <matplotlib.artist.Artist.set_clip_box>`                                            `.Bbox`                                                                                                                                                       \n       :meth:`clip_on <matplotlib.artist.Artist.set_clip_on>`                                              bool                                                                                                                                                          \n       :meth:`clip_path <matplotlib.artist.Artist.set_clip_path>`                                          Patch or (Path, Transform) or None                                                                                                                            \n       :meth:`cmap <matplotlib.cm.ScalarMappable.set_cmap>`                                                `.Colormap` or str or None                                                                                                                                    \n       :meth:`color <matplotlib.collections.Collection.set_color>`                                         color or list of rgba tuples                                                                                                                                  \n       :meth:`edgecolor <matplotlib.collections.Collection.set_edgecolor>` or ec or edgecolors             color or list of colors or \'face\'                                                                                                                             \n       :meth:`facecolor <matplotlib.collections.Collection.set_facecolor>` or facecolors or fc             color or list of colors                                                                                                                                       \n       :meth:`figure <matplotlib.artist.Artist.set_figure>`                                                `.Figure`                                                                                                                                                     \n       :meth:`gid <matplotlib.artist.Artist.set_gid>`                                                      str                                                                                                                                                           \n       :meth:`hatch <matplotlib.collections.Collection.set_hatch>`                                         {\'/\', \'\\\\\', \'|\', \'-\', \'+\', \'x\', \'o\', \'O\', \'.\', \'*\'}                                                                                                           \n       :meth:`in_layout <matplotlib.artist.Artist.set_in_layout>`                                          bool                                                                                                                                                          \n       :meth:`joinstyle <matplotlib.collections.Collection.set_joinstyle>`                                 `.JoinStyle` or {\'miter\', \'round\', \'bevel\'}                                                                                                                   \n       :meth:`label <matplotlib.artist.Artist.set_label>`                                                  object                                                                                                                                                        \n       :meth:`linestyle <matplotlib.collections.Collection.set_linestyle>` or dashes or linestyles or ls   str or tuple or list thereof                                                                                                                                  \n       :meth:`linewidth <matplotlib.collections.Collection.set_linewidth>` or linewidths or lw             float or list of floats                                                                                                                                       \n       :meth:`mouseover <matplotlib.artist.Artist.set_mouseover>`                                          bool                                                                                                                                                          \n       :meth:`norm <matplotlib.cm.ScalarMappable.set_norm>`                                                `.Normalize` or None                                                                                                                                          \n       :meth:`offset_transform <matplotlib.collections.Collection.set_offset_transform>` or transOffset    unknown                                                                                                                                                       \n       :meth:`offsets <matplotlib.collections.Collection.set_offsets>`                                     (N, 2) or (2,) array-like                                                                                                                                     \n       :meth:`path_effects <matplotlib.artist.Artist.set_path_effects>`                                    `.AbstractPathEffect`                                                                                                                                         \n       :meth:`paths <matplotlib.collections.PolyCollection.set_verts>`                                     list of array-like                                                                                                                                            \n       :meth:`picker <matplotlib.artist.Artist.set_picker>`                                                None or bool or float or callable                                                                                                                             \n       :meth:`pickradius <matplotlib.collections.Collection.set_pickradius>`                               float                                                                                                                                                         \n       :meth:`rasterized <matplotlib.artist.Artist.set_rasterized>`                                        bool                                                                                                                                                          \n       :meth:`sizes <matplotlib.collections._CollectionWithSizes.set_sizes>`                               ndarray or None                                                                                                                                               \n       :meth:`sketch_params <matplotlib.artist.Artist.set_sketch_params>`                                  (scale: float, length: float, randomness: float)                                                                                                              \n       :meth:`snap <matplotlib.artist.Artist.set_snap>`                                                    bool or None                                                                                                                                                  \n       :meth:`transform <matplotlib.artist.Artist.set_transform>`                                          `.Transform`                                                                                                                                                  \n       :meth:`url <matplotlib.artist.Artist.set_url>`                                                      str                                                                                                                                                           \n       :meth:`urls <matplotlib.collections.Collection.set_urls>`                                           list of str or None                                                                                                                                           \n       :meth:`verts <matplotlib.collections.PolyCollection.set_verts>`                                     list of array-like                                                                                                                                            \n       :meth:`verts_and_codes <matplotlib.collections.PolyCollection.set_verts_and_codes>`                 unknown                                                                                                                                                       \n       :meth:`visible <matplotlib.artist.Artist.set_visible>`                                              bool                                                                                                                                                          \n       :meth:`zorder <matplotlib.artist.Artist.set_zorder>`                                                float                                                                                                                                                         \n       =================================================================================================   ==============================================================================================================================================================\n\n\nReturns\n-------\n`~matplotlib.quiver.Quiver`\n\nSee Also\n--------\n.Axes.quiverkey : Add a key to a quiver plot.\n\nNotes\n-----\n\n**Arrow shape**\n\nThe arrow is drawn as a polygon using the nodes as shown below. The values\n*headwidth*, *headlength*, and *headaxislength* are in units of *width*.\n\n.. image:: /_static/quiver_sizes.svg\n   :width: 500px\n\nThe defaults give a slightly swept-back arrow. Here are some guidelines how to\nget other head shapes:\n\n- To make the head a triangle, make *headaxislength* the same as *headlength*.\n- To make the arrow more pointed, reduce *headwidth* or increase *headlength*\n  and *headaxislength*.\n- To make the head smaller relative to the shaft, scale down all the head\n  parameters proportionally.\n- To remove the head completely, set all *head* parameters to 0.\n- To get a diamond-shaped head, make *headaxislength* larger than *headlength*.\n- Warning: For *headaxislength* < (*headlength* / *headwidth*), the "headaxis"\n  nodes (i.e. the ones connecting the head with the shaft) will protrude out\n  of the head in forward direction so that the arrow head looks broken.\n'#
set(*, UVC=<UNSET>, agg_filter=<UNSET>, alpha=<UNSET>, animated=<UNSET>, antialiased=<UNSET>, array=<UNSET>, capstyle=<UNSET>, clim=<UNSET>, clip_box=<UNSET>, clip_on=<UNSET>, clip_path=<UNSET>, cmap=<UNSET>, color=<UNSET>, edgecolor=<UNSET>, facecolor=<UNSET>, gid=<UNSET>, hatch=<UNSET>, in_layout=<UNSET>, joinstyle=<UNSET>, label=<UNSET>, linestyle=<UNSET>, linewidth=<UNSET>, mouseover=<UNSET>, norm=<UNSET>, offset_transform=<UNSET>, offsets=<UNSET>, path_effects=<UNSET>, paths=<UNSET>, picker=<UNSET>, pickradius=<UNSET>, rasterized=<UNSET>, sizes=<UNSET>, sketch_params=<UNSET>, snap=<UNSET>, transform=<UNSET>, url=<UNSET>, urls=<UNSET>, verts=<UNSET>, verts_and_codes=<UNSET>, visible=<UNSET>, zorder=<UNSET>)[source]#

Set multiple properties at once.

Supported properties are

Property

Description

UVC

unknown

agg_filter

a filter function, which takes a (m, n, 3) float array and a dpi value, and returns a (m, n, 3) array and two offsets from the bottom left corner of the image

alpha

array-like or scalar or None

animated

bool

antialiased or aa or antialiaseds

bool or list of bools

array

array-like or None

capstyle

CapStyle or {'butt', 'projecting', 'round'}

clim

(vmin: float, vmax: float)

clip_box

Bbox

clip_on

bool

clip_path

Patch or (Path, Transform) or None

cmap

Colormap or str or None

color

color or list of rgba tuples

edgecolor or ec or edgecolors

color or list of colors or 'face'

facecolor or facecolors or fc

color or list of colors

figure

Figure

gid

str

hatch

{'/', '\', '|', '-', '+', 'x', 'o', 'O', '.', '*'}

in_layout

bool

joinstyle

JoinStyle or {'miter', 'round', 'bevel'}

label

object

linestyle or dashes or linestyles or ls

str or tuple or list thereof

linewidth or linewidths or lw

float or list of floats

mouseover

bool

norm

Normalize or None

offset_transform or transOffset

unknown

offsets

(N, 2) or (2,) array-like

path_effects

AbstractPathEffect

paths

list of array-like

picker

None or bool or float or callable

pickradius

float

rasterized

bool

sizes

ndarray or None

sketch_params

(scale: float, length: float, randomness: float)

snap

bool or None

transform

Transform

url

str

urls

list of str or None

verts

list of array-like

verts_and_codes

unknown

visible

bool

zorder

float

set_UVC(U, V, C=None)[source]#

Examples using matplotlib.quiver.Quiver#