radtools.MatplotlibBackend.plot#

method

MatplotlibBackend.plot(lattice, kind='primitive', **kwargs)[source]#

Main plotting function of the Lattice.

Parameters:
latticeLattice

Lattice to be plotted.

kindstr or list od str

Type of the plot to be plotted. Supported plots:

  • "conventional"

  • "primitive"

  • "brillouin"

  • "kpath"

  • "brillouin-kpath"

  • "wigner-seitz"

  • "unit-cell"

**kwargs

Parameters to be passed to the plotting function. See each function for the list of supported parameters.

Raises:
ValueError

If the plot kind is not supported.

See also

plot_conventional

"conventional" plot.

plot_primitive

"primitive" plot.

plot_brillouin

"brillouin" plot.

plot_kpath

"kpath" plot.

plot_brillouin_kpath

"brillouin_kpath" plot.

plot_wigner_seitz

"wigner-seitz" plot.

plot_unit_cell

"unit-cell" plot.

show

Shows the plot.

save

Save the figure in the file.