kwant.plotter.spectrum(syst, x, y=None, params=None, mask=None, file=None, show=True, dpi=None, fig_size=None, ax=None)[source]

Plot the spectrum of a Hamiltonian as a function of 1 or 2 parameters


syst : kwant.system.FiniteSystem or callable

If a function, then it must take named parameters and return the Hamiltonian as a dense matrix.

x : pair (name, values)

Parameter to ham that will be varied. Consists of the parameter name, and a sequence of parameter values.

y : pair (name, values), optional

Used for 3D plots (same as x). If provided, then the cartesian product of the x values and these values will be used as a grid over which to evaluate the spectrum.

params : dict, optional

The rest of the parameters to ham, which will be kept constant.

mask : callable, optional

Takes the parameters specified by x and y and returns True if the spectrum should not be calculated for the given parameter values.

file : string or file object or None

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

show : bool

Whether 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.


fig : matplotlib figure

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

Previous topic


Next topic


This Page