radtools.TET.plot#

method

TET.plot(kind='primitive', ax=None, **kwargs)#

Main plotting function of the Lattice.

Parameters:
kindstr or list od str

Type of the plot to be plotted. Supported plots:

  • "conventional"

  • "primitive"

  • "brillouin"

  • "kpath"

  • "brillouin-kpath"

  • "wigner-seitz"

axaxis, optional

3D matplotlib axis for the plot.

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

show

Shows the plot.

savefig

Save the figure in the file.