tepkit.utils.mpl_tools.plotters.BrillouinZone2DPlotter

class tepkit.utils.mpl_tools.plotters.BrillouinZone2DPlotter(b_lattice: tepkit.utils.typing_tools.NumpyArray3x3, bravais_lattice_2d: tepkit.core.symmetry.BravaisLattice2D | None = None)

Bases: tepkit.utils.mpl_tools.plotters.plotter.Plotter

The plotter to plot the Brillouin Zone of 2D materials.

[zh-CN] 用于绘制二维布里渊区的 Plotter。

Parameters:

• b_lattice – The base vectors of the reciprocal lattice, used to get the shape of the Brillouin Zone.

• bravais_lattice_2d – The type of the 2D Bravais lattice, used to determine the high-symmetry points.

Attributes

Attribute	Default Value	Description
b_lattice	None
bravais_lattice_2d	None
boundary_data	None
data	None
config	None
hsps	None
plot_boundary_step	True
plot_path_step	True
plot_point_step	True
plot_point_text_step	True
plot_base_vectors_step	True
base_vectors_length	1.0

Methods

from_poscar(poscar[, with_2pi, bravais_lattice_2d, ...])	Instantiation a Plotter by a Poscar.
plot(ax)
plot_boundary(ax)	Plot the boundary of the first Brillouin zone.
plot_path(ax)	Plot the high-symmetriy paths.
plot_point(ax)	Plot the high-symmetriy points.
plot_point_text(ax)	Plot the name of the high-symmetriy points.
plot_base_vectors(ax[, length])	Plot the base vectors of the reciprocal lattice as arrows with dashed lines and green color.
to_png()

All Members

b_lattice: NumpyArray3x3

bravais_lattice_2d: tepkit.core.symmetry.BravaisLattice2D | None

boundary_data

data

config: dict

hsps

plot_boundary_step = True

plot_path_step = True

plot_point_step = True

plot_point_text_step = True

plot_base_vectors_step = True

base_vectors_length = 1.0

classmethod from_poscar(poscar: tepkit.io.vasp.Poscar, with_2pi: bool = True, bravais_lattice_2d=None, sym_prec=1e-05)

Instantiation a Plotter by a Poscar.

plot(ax)

plot_boundary(ax)

Plot the boundary of the first Brillouin zone.

plot_path(ax)

Plot the high-symmetriy paths.

plot_point(ax)

Plot the high-symmetriy points.

plot_point_text(ax)

Plot the name of the high-symmetriy points.

plot_base_vectors(ax, length=None)

Plot the base vectors of the reciprocal lattice as arrows with dashed lines and green color.

to_png()