make_path

make_path(k0: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], k1: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes], *ks: Iterable[_SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes]], step: float = 0.1, point_labels: List[str] | None = None) → Path

Create a path which connects the given k points

Parameters:

k0, k1, *ks

Points in k-space to connect.

stepfloat

Length in k-space between two samples. Smaller step -> finer detail.

point_labelsOptional[List[str]]

The labels for the points.

Examples

>>> np.allclose(make_path(0, 3, -1, step=1).T, [0, 1, 2, 3, 2, 1, 0, -1])
True
>>> np.allclose(make_path([0, 0], [2, 3], [-1, 4], step=1.4),
...             [[0, 0], [1, 1.5], [2, 3], [0.5, 3.5], [-1, 4]])
True