pythtb.Wannier.plot_centers#
- Wannier.plot_centers(center_scale=200, section_home_cell=True, color_home_cell=True, translate_centers=False, show=False, legend=False, pmx=4, pmy=4, center_color='r', center_marker='*', lat_home_color='b', lat_color='k', fig=None, ax=None)[source]#
Plot the Wannier function centers in the supercell.
- Parameters:
- center_scalefloat
Scale factor for the size of the center markers. Scales with the spread of the Wannier functions, this is a multiplicative factor.
- section_home_cellbool
If True, delineate the home cell in the plot.
- color_home_cellbool
If True, color the home cell orbitals differently from other cells.
- translate_centersbool
If True, translate the home cell Wannier centers to neighboring cells.
- showbool
If True, display the plot immediately.
- legendbool
If True, include a legend in the plot.
- pmxint
Plus-minus range in x-direction for plotting supercell.
- pmyint
Plus-minus range in y-direction for plotting supercell.
- center_colorstr
Color for the Wannier center markers.
- center_markerstr
Marker style for the Wannier center markers.
- lat_home_colorstr
Color for the home cell lattice sites.
- lat_colorstr
Color for the other lattice sites.
- figmatplotlib.figure.Figure | None
Matplotlib figure object to plot on. If None, a new figure is created.
- axmatplotlib.axes.Axes | None
Matplotlib axes object to plot on. If None, new axes are created.
- Returns:
- figmatplotlib.figure.Figure
The figure object containing the plot.
- axmatplotlib.axes.Axes
The axes object containing the plot.