orbithunter.core.Orbit.roll

Orbit.roll(shift, axis=0)

Apply numpy roll along specified axis.

Parameters

shiftint or tuple of int

Number of discrete points to rotate by

axisint or tuple of int

The numpy ndarray axes along which to roll

Returns

OrbitKS :

Instance with rolled state

Notes

If provided tuples of ints, shift and axis need to be the same length as to be coherent.