pythtb.Lattice.get_kpath_distance#

Lattice.get_kpath_distance(kpts, k_nodes=None, labels=None, cartesian=False, tol=1e-08)[source]#

Transform k-points to k-distance along a path.

Parameters:
kptsarray_like

Array of k-points in reduced coordinates.

k_nodesarray_like, optional

Array of special k-point nodes along the path.

labelslist of str, optional

Labels corresponding to the k_nodes.

tolfloat, optional

Tolerance for matching k-points, by default 1e-8

Returns:
k_distarray

Cumulative k-point distances along the path.

node_distarray, optional

Distances of the special k-point nodes.

node_indicesdict, optional

Indices of the special k-point nodes.

label_indicesdict, optional

Mapping from labels to k-point nodes.