PlotAxes.streamplot¶
- PlotAxes.streamplot(**kwargs)[source]¶
Plot streamlines.
- Parameters
*args (
u
,v
orx
,y
,u
,v
) – The data passed as positional or keyword arguments. Interpreted as follows:If only
u
andv
coordinates are passed, try to infer thex
andy
coordinates from theDataFrame
indices and columns or theDataArray
coordinates. Otherwise, they
coordinates arenp.arange(0, y.shape[0])
and thex
coordinates arenp.arange(0, y.shape[1])
.For
pcolor
andpcolormesh
, calculate coordinate edges usingedges
oredges2d
if centers were provided. For all other methods, calculate coordinate centers if edges were provided.If the
x
ory
coordinates arepint.Quantity
, auto-add the pint unit registry to matplotlib’s unit registry usingsetup_matplotlib
. If theu
andv
coordinates arepint.Quantity
, pass the magnitude to the plotting command. Apint.Quantity
embedded in anxarray.DataArray
is also supported.
c, color, colors (array-like or
color-spec
, optional) – The colors of the streamlines passed as either a keyword argument or a fifth positional argument. This can be a single color or a color array to be scaled bycmap
andnorm
.data (dict-like, optional) – A dict-like dataset container (e.g.,
DataFrame
orDataset
). If passed, each data argument can optionally be a stringkey
and the arrays used for plotting are retrieved withdata[key]
. This is a native matplotlib feature.autoformat (
bool
, default:rc.autoformat
=True
) – Whether thex
axis labels,y
axis labels, axis formatters, axes titles, legend titles, and colorbar labels are automatically configured when aSeries
,DataFrame
,DataArray
, orQuantity
is passed to the plotting command. Formatting ofpint.Quantity
unit strings is controlled byrc.unitformat
='L'
.transpose (
bool
, default:False
) – Whether to transpose the input data. This should be used when passing datasets with column-major dimension order(x, y)
. Otherwise row-major dimension order(y, x)
is expected.order (
{'C', 'F'}
, default:'C'
) – Alternative totranspose
.'C'
corresponds to the default C-cyle row-major ordering (equivalent totranspose=False
).'F'
corresponds to Fortran-style column-major ordering (equivalent totranspose=True
).globe (
bool
, default:False
) – Forproplot.axes.GeoAxes
only. Whether to enforce global coverage. When set toTrue
this does the following:Interpolates input data to the North and South poles by setting the data values at the poles to the mean from latitudes nearest each pole.
Makes meridional coverage “circular”, i.e. the last longitude coordinate equals the first longitude coordinate plus 360°.
When basemap is the backend, cycles 1D longitude vectors to fit within the map edges. For example, if the central longitude is 90°, the data is shifted so that it spans -90° to 270°.
- Other Parameters
cmap (
colormap-spec
, default:rc['cmap.sequential']
='Fire'
orrc['cmap.diverging']
='BuRd'
) – The colormap specifer, passed to theColormap
constructor function. Ifrc['cmap.autodiverging']
isTrue
and the normalization range contains negative and positive values thenrc['cmap.diverging']
is used. Otherwiserc['cmap.sequential']
is used.c, color, colors (
color-spec
or sequence ofcolor-spec
, optional) – The color(s) used to create aDiscreteColormap
. If not passed,cmap
is used.norm (
norm-spec
, default:Normalize
orDivergingNorm
) – The data value normalizer, passed to theNorm
constructor function. Ifdiscrete
isTrue
then 1) this affects the default level-generation algorithm (e.g.norm='log'
builds levels in log-space) and 2) this is passed toDiscreteNorm
to scale the colors before they are discretized (ifnorm
is not already aDiscreteNorm
). Ifrc['cmap.autodiverging']
isTrue
and the normalization range contains negative and positive values thenDivergingNorm
is used. OtherwiseNormalize
is used.extend (
{'neither', 'both', 'min', 'max'}
, default:'neither'
) – Direction for drawing colorbar “extensions” indicating out-of-bounds data on the end of the colorbar.discrete (
bool
, default:rc['cmap.discrete']
=None
) – IfFalse
, thenDiscreteNorm
is not applied to the colormap. Instead, for non-contour plots, the number of levels will be roughly controlled byrc['cmap.lut']
. This has a similar effect to usinglevels=large_number
but it may improve rendering speed. Default isTrue
only for contouring commands likecontourf
and pseudocolor commands likepcolor
.sequential, diverging, cyclic, qualitative (
bool
, default:None
) – Boolean arguments used ifcmap
is not passed. Set these toTrue
to use the defaultrc['cmap.sequential']
,rc['cmap.diverging']
,rc['cmap.cyclic']
, andrc['cmap.qualitative']
colormaps. Thediverging
option also appliesDivergingNorm
as the default continuous normalizer.vmin, vmax (
float
, optional) – The minimum and maximum color scale values used with thenorm
normalizer. Ifdiscrete
isFalse
these are the absolute limits, and ifdiscrete
isTrue
these are the approximate limits used to automatically determinelevels
orvalues
lists at “nice” intervals. Iflevels
orvalues
were already passed as lists, these are ignored, andvmin
andvmax
are set to the minimum and maximum of the lists. Ifrobust
was passed, the defaultvmin
andvmax
are some percentile range of the data values. Otherwise, the defaultvmin
andvmax
are the minimum and maximum of the data values.N – Shorthand for
levels
.levels (
int
or sequence offloat
, default:rc['cmap.levels']
=11
) – The number of level edges or a sequence of level edges. If the former,locator
is used to generate this many level edges at “nice” intervals. If the latter, the levels should be monotonically increasing or decreasing (note decreasing levels fail withcontour
plots).values (
int
or sequence offloat
, default:None
) – The number of level centers or a sequence of level centers. If the former,locator
is used to generate this many level centers at “nice” intervals. If the latter, levels are inferred usingedges
. This will override anylevels
input.robust (
bool
,float
, or2-tuple
, default:rc['cmap.robust']
=False
) – IfTrue
andvmin
orvmax
were not provided, they are determined from the 2nd and 98th data percentiles rather than the minimum and maximum. If float, this percentile range is used (for example,90
corresponds to the 5th to 95th percentiles). If 2-tuple of float, these specific percentiles should be used. This feature is useful when your data has large outliers.inbounds (
bool
, default:rc['cmap.inbounds']
=True
) – IfTrue
andvmin
orvmax
were not provided, when axis limits have been explicitly restricted withset_xlim
orset_ylim
, out-of-bounds data is ignored. See alsorc['cmap.inbounds']
andrc['axes.inbounds']
.locator (
locator-spec
, default:matplotlib.ticker.MaxNLocator
) – The locator used to determine level locations iflevels
orvalues
were not already passed as lists. Passed to theLocator
constructor. Default isMaxNLocator
withlevels
integer levels.locator_kw (dict-like, optional) – Keyword arguments passed to
matplotlib.ticker.Locator
class.symmetric (
bool
, default:False
) – IfTrue
, the normalization range or discrete colormap levels are symmetric about zero.positive (
bool
, default:False
) – IfTrue
, the normalization range or discrete colormap levels are positive with a minimum at zero.negative (
bool
, default:False
) – IfTrue
, the normaliation range or discrete colormap levels are negative with a minimum at zero.nozero (
bool
, default:False
) – IfTrue
,0
is removed from the level list. This is mainly useful for single-colorcontour
plots.**kwargs – Passed to
matplotlib.axes.Axes.streamplot