kwant.plotter.bands

kwant.plotter.bands(sys, args=(), momenta=65, file=None, show=True, dpi=None, fig_size=None, ax=None)

Plot band structure of a translationally invariant 1D system.

Parameters:

sys : kwant.system.InfiniteSystem

A system bands of which are to be plotted.

args : tuple, defaults to empty

Positional arguments to pass to the hamiltonian method.

momenta : int or 1D array-like

Either a number of sampling points on the interval [-pi, pi], or an array of points at which the band structure has to be evaluated.

file : string or file object or None

The output file. If None, output will be shown instead.

show : bool

Whether matplotlib.pyplot.show() is to be called, and the output is to be shown immediately. Defaults to True.

dpi : float

Number of pixels per inch. If not set the matplotlib default is used.

fig_size : tuple

Figure size (width, height) in inches. If not set, the default matplotlib value is used.

ax : matplotlib.axes.Axes instance or None

If ax is not None, no new figure is created, but the plot is done within the existing Axes ax. in this case, file, show, dpi and fig_size are ignored.

Returns:

fig : matplotlib figure

A figure with the output if ax is not set, else None.

Notes

See physics.Bands for the calculation of dispersion without plotting.