shift(input, shift, output=None, order=3, mode='constant', cval=0.0, prefilter=True)[source]¶
Shift an array.
The array is shifted using spline interpolation of the requested order. Points outside the boundaries of the input are filled according to the given mode.
input : ndarray
The input array.
shift : float or sequence, optional
output : ndarray or dtype, optional
The array in which to place the output, or the dtype of the returned array.
order : int, optional
The order of the spline interpolation, default is 3. The order has to be in the range 0-5.
mode : str, optional
Points outside the boundaries of the input are filled according to the given mode (‘constant’, ‘nearest’, ‘reflect’, ‘mirror’ or ‘wrap’). Default is ‘constant’.
cval : scalar, optional
Value used for points outside the boundaries of the input if
mode='constant'. Default is 0.0
prefilter : bool, optional
The parameter prefilter determines if the input is pre-filtered with
spline_filterbefore interpolation (necessary for spline interpolation of order > 1). If False, it is assumed that the input is already filtered. Default is True.
shift : ndarray or None
The shifted input. If output is given as a parameter, None is returned.