matplotlib 3.5.1

ParametersReturns
streamplot(axes, x, y, u, v, density=1, linewidth=None, color=None, cmap=None, norm=None, arrowsize=1, arrowstyle='-|>', minlength=0.1, transform=None, zorder=None, start_points=None, maxlength=4.0, integration_direction='both', *, data=None)

Parameters

x, y : 1D/2D arrays

Evenly spaced strictly increasing arrays to make a grid. If 2D, all rows of x must be equal and all columns of y must be equal; i.e., they must be as if generated by np.meshgrid(x_1d, y_1d) .

u, v : 2D arrays

x and y-velocities. The number of rows and columns must match the length of y and x, respectively.

density : float or (float, float)

Controls the closeness of streamlines. When density = 1 , the domain is divided into a 30x30 grid. density linearly scales this grid. Each cell in the grid can have, at most, one traversing streamline. For different densities in each direction, use a tuple (density_x, density_y).

linewidth : float or 2D array

The width of the stream lines. With a 2D array the line width can be varied across the grid. The array must have the same shape as u and v.

color : color or 2D array

The streamline color. If given an array, its values are converted to colors using cmap and norm. The array must have the same shape as u and v.

cmap : `~matplotlib.colors.Colormap`

Colormap used to plot streamlines and arrows. This is only used if color is an array.

norm : `~matplotlib.colors.Normalize`

Normalize object used to scale luminance data to 0, 1. If None , stretch (min, max) to (0, 1). This is only used if color is an array.

arrowsize : float

Scaling factor for the arrow size.

arrowstyle : str

Arrow style specification. See ~matplotlib.patches.FancyArrowPatch .

minlength : float

Minimum length of streamline in axes coordinates.

start_points : Nx2 array

Coordinates of starting points for the streamlines in data coordinates (the same coordinates as the x and y arrays).

zorder : int

The zorder of the stream lines and arrows. Artists with lower zorder values are drawn first.

maxlength : float

Maximum length of streamline in axes coordinates.

integration_direction : {'forward', 'backward', 'both'}, default: 'both'

Integrate the streamline in forward, backward or both directions.

data : indexable object, optional

If given, the following parameters also accept a string s , which is interpreted as data[s] (unless this raises an exception):

x, y, u, v, start_points

Returns

StreamplotSet

Container object with attributes

This container will probably change in the future to allow changes to the colormap, alpha, etc. for both lines and arrows, but these changes should be backward compatible.

Draw streamlines of a vector flow.

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /matplotlib/streamplot.py#19
type: <class 'function'>
Commit: