kwant.plotter.
streamplot
(field, box, cmap=None, bgcolor=None, linecolor='k', max_linewidth=3, min_linewidth=1, density=0.2222222222222222, colorbar=True, file=None, show=True, dpi=None, fig_size=None, ax=None)[source]¶Draw streamlines of a flow field in Kwant style
Solid colored streamlines are drawn, superimposed on a color plot of the flow speed that may be disabled by setting bgcolor. The width of the streamlines is proportional to the flow speed. Lines that would be thinner than min_linewidth are blended in a perceptually correct way into the background color in order to create the illusion of arbitrarily thin lines. (This is done because some plot backends like PDF do not support lines of arbitrarily thin width.)
Internally, this routine uses matplotlib.pyplot.streamplot
.
Parameters: | field : 3d arraylike of float
box : 2-sequence of 2-sequences of float
cmap : colormap, optional
bgcolor : color definition, optional
linecolor : color definition
max_linewidth : float
min_linewidth : float
density : float
colorbar : bool
file : string or file object or None
show : bool
dpi : float or None
fig_size : tuple or None
ax :
|
---|---|
Returns: | fig : matplotlib figure
|