cupyx.scipy.ndimage.fourier_shift¶
- cupyx.scipy.ndimage.fourier_shift(input, shift, n=- 1, axis=- 1, output=None)[source]¶
Multidimensional Fourier shift filter.
The array is multiplied with the Fourier transform of a shift operation.
- Parameters
input (cupy.ndarray) – The input array. This should be in the Fourier domain.
shift (float or sequence of float) – The size of shift. If a float, shift is the same for all axes. If a sequence, shift has to contain one value for each axis.
n (int, optional) – If n is negative (default), then the input is assumed to be the result of a complex fft. If n is larger than or equal to zero, the input is assumed to be the result of a real fft, and n gives the length of the array before transformation along the real transform direction.
axis (int, optional) – The axis of the real transform (only used when
n > -1
).output (cupy.ndarray, optional) – If given, the result of shifting the input is placed in this array.
- Returns
The shifted output (in the Fourier domain).
- Return type
output (cupy.ndarray)