LDOS_from_eigenstate

class hubbard.plot.LDOS_from_eigenstate(HH, wavefunction, sites=[], ext_geom=None, realspace=False, **kwargs)[source]

Bases: hubbard.plot.plot.GeometryPlot

Plot LDOS in the configuration space for the hubbard.HubbardHamiltonian object

Parameters

  • HH (HubbardHamiltonian) – mean-field Hubbard Hamiltonian

  • WF (numpy.ndarray or sisl.physics.electron.EigenstateElectron) – Eigenstate to be plotted as LDOS, WF can be an array-like containing more than WF The WF have to be stored along the second axis, i.e. each WF is stored as column vectors in this case this method sums the EigenLDOS corresponding to each WF in the grid This can be handy if one wants to plot the LDOS = LDOS_up + LDOS_dn

  • 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

Methods

__init__(HH, wavefunction[, sites, ...])

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

See also

matplotlib.pyplot.savefig

set_axes(bdx=2)
set_colorbar_xlabel(label, fontsize=20)
set_colorbar_xticklabels(labels=None, fontsize=20)
set_colorbar_xticks(ticks)
set_colorbar_ylabel(label, fontsize=20)
set_colorbar_yticklabels(labels=None, fontsize=20)
set_colorbar_yticks(ticks)
set_title(title, fontsize=16)

Set figure title

Parameters

  • title (str) – figure title

  • fontsize (int, optional) – title fontsize, defaults to 16

set_xlabel(label, fontsize=16)

Set label for the x-axis

Parameters

  • label (str) – label for the x-axis

  • fontsize (int, optional) – label fontsize

set_xlim(xmin, xmax)

Set maximum and minimum x-axis values

Parameters

  • xmin (float) – minimum value to show in the x-axis

  • xmax (float) – maximum value to show in the x-axis

set_ylabel(label, fontsize=16)

Set label for the y-axis

Parameters

  • label (str) – label for the y-axis

  • fontsize (int, optional) – label fontsize

set_ylim(ymin, ymax)

Set maximum and minimum y-axis values

Parameters

  • ymin (float) – minimum value to show in the y-axis

  • ymax (float) – maximum value to show in the y-axis