matplotlib.axes.Axes.streamplot#

Axes.streamplot(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',broken_streamlines=True,*,data=None)[source]#

Draw streamlines of a vector flow.

Parameters:
x, y1D/2D arrays

Evenly spaced strictly increasing arrays to make a grid. If 2D, allrows ofx must be equal and all columns ofy must be equal; i.e.,they must be as if generated bynp.meshgrid(x_1d,y_1d).

u, v2D arrays

x andy-velocities. The number of rows and columns must matchthe length ofy andx, respectively.

densityfloat or (float, float)

Controls the closeness of streamlines. Whendensity=1, the domainis 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).

linewidthfloat or 2D array

The width of the streamlines. With a 2D array the line width can bevaried across the grid. The array must have the same shape asuandv.

colorcolor or 2D array

The streamline color. If given an array, its values are converted tocolors usingcmap andnorm. The array must have the same shapeasu andv.

cmap, norm

Data normalization and colormapping parameters forcolor; only usedifcolor is an array of floats. Seeimshow for a detaileddescription.

arrowsizefloat

Scaling factor for the arrow size.

arrowstylestr

Arrow style specification.SeeFancyArrowPatch.

minlengthfloat

Minimum length of streamline in axes coordinates.

start_points(N, 2) array

Coordinates of starting points for the streamlines in data coordinates(the same coordinates as thex andy arrays).

zorderfloat

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

maxlengthfloat

Maximum length of streamline in axes coordinates.

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

Integrate the streamline in forward, backward or both directions.

dataindexable object, optional

If given, the following parameters also accept a strings, which isinterpreted asdata[s] ifs is a key indata:

x,y,u,v,start_points

broken_streamlinesboolean, default: True

If False, forces streamlines to continue until theyleave the plot domain. If True, they may be terminated if theycome too close to another streamline.

Returns:
StreamplotSet

Container object with attributes

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

Examples usingmatplotlib.axes.Axes.streamplot#

Streamplot

Streamplot

streamplot(X, Y, U, V)

streamplot(X, Y, U, V)