LDOS

class hubbard.plot.LDOS(HH, E, sites=[], spin=[0, 1], ext_geom=None, realspace=False, eta=0.001, distribution='lorentzian', **kwargs)[source]

Bases: GeometryPlot

Plot LDOS for an energy E with a certain distribution function for the hubbard.HubbardHamiltonian object

Parameters:

HH (HubbardHamiltonian) – mean-field Hubbard Hamiltonian
E (float) – energy at which the LDOS will be computed
eta (float, optional) – smearing parameter. Defaults to 1e-3 eV
dist (str, optional) – distribution function. Defaults to Lorentzian distribution
spin (array_like, optional) – To plot the LDOS corresponding to the specified spin index. Default to spin=[0,1] i.e. it sums the LDOS corresponding to both spin components
realspace – If True it will plot the LDOS in a realspace grid otherwise it plots it as a scatter plot (PDOS) with varying size depending on the PDOS numerical value In this case either a sisl.SuperCell (sc kwarg) or the z kwarg to slice the real space grid at the desired z coordinate needs to be passed

See also

hubbard.HubbardHamiltonian.PDOS

sisl.get_distribution: sisl method to create distribution function
sisl.physics.electron.PDOS: sisl method to obtain PDOS

Methods

`__init__`(HH, E[, sites, spin, ext_geom, ...])
`add_colorbar`(layer[, pos, size])	Add figure colorbar
`annotate`([sites, size])	Annotate the site indices in the pi-network
`close`()	Close figure
`get_colorbar_xticks`()
`get_colorbar_yticks`()
`legend`(**kwargs)	Add legend to figure.
`savefig`(fn)	Save figure to external file
`set_axes`([bdx])
`set_colorbar_xlabel`(label[, fontsize])
`set_colorbar_xticklabels`([labels, fontsize])
`set_colorbar_xticks`(ticks)
`set_colorbar_ylabel`(label[, fontsize])
`set_colorbar_yticklabels`([labels, fontsize])
`set_colorbar_yticks`(ticks)
`set_title`(title[, fontsize])	Set figure title
`set_xlabel`(label[, fontsize])	Set label for the x-axis
`set_xlim`(xmin, xmax)	Set maximum and minimum x-axis values
`set_ylabel`(label[, fontsize])	Set label for the y-axis
`set_ylim`(ymin, ymax)	Set maximum and minimum y-axis values

add_colorbar(layer, pos='right', size='5%')

Add figure colorbar

Parameters:

layer (matplotlib.cm.ScalarMappable) – i.e., AxesImage, ContourSet, etc. described by this colorbar
pos (str, optional) – position of the colorbar with respect to axes
size (str, optional) – size of the colorbar in %

annotate(sites=[], size=6)

Annotate the site indices in the pi-network

Parameters:

sites (array_like, optional) – specify sites to be annotated in figure
size (int, optional) – font size for the annotation

close(): Close figure

get_colorbar_xticks()

get_colorbar_yticks()

legend(**kwargs): Add legend to figure. It takes into account possible repeated labels and show them once

savefig(fn)

Save figure to external file

Parameters:: fn (str) – external file name to save plot