BondHoppings

class hubbard.plot.BondHoppings(H, annotate=False, off_diagonal_only=True, **kwargs)[source]

Bases: hubbard.plot.plot.Plot

Plot matrix element of a tight-binding Hamiltonian in real space

Parameters

  • H (sisl.Hamiltonian or hubbard.HubbardHamiltonian object) – tight-binding Hamitlonian

  • annotate (bool, optional) – if True it annotates the numerical value of the matrix element

  • off_diagonal_only (bool, optional) – if True it also plots the onsite energies

Methods

__init__(H[, annotate, off_diagonal_only])

add_colorbar(layer[, pos, size])

Add figure colorbar

close()

Close figure

legend(**kwargs)

Add legend to figure.

savefig(fn)

Save figure to external file

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 %

close()

Close figure

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_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