make_area

make_area(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], k_origin: _SupportsArray[dtype[Any]] | _NestedSequence[_SupportsArray[dtype[Any]]] | bool | int | float | complex | str | bytes | _NestedSequence[bool | int | float | complex | str | bytes] | None = None, step: float = 1, point_labels: List[str] | None = None) → Area

Create an area of k-point between k0 and k1, starting from k_origin.

Parameters:

k0, k1

Point to which the area goes

k_origin

Point from which the area begins, default = [0, 0]

stepfloat

Length in k-space between two samples.

point_indicesUnion[List[str], List[List[str]]

The indices that are spcial. If 1D, the N-th position in the array.flatten() will be taken.

point_labelsList[str]

The labels for the chosen special points. If None, the default values from pb.results.Area will be used.