cupyx.scipy.fftpack.fft2¶
-
cupyx.scipy.fftpack.
fft2
(x, shape=None, axes=(-2, -1), overwrite_x=False, plan=None)¶ Compute the two-dimensional FFT.
Parameters: - x (cupy.ndarray) – Array to be transformed.
- shape (None or tuple of ints) – Shape of the transformed axes of the
output. If
shape
is not given, the lengths of the input along the axes specified byaxes
are used. - axes (tuple of ints) – Axes over which to compute the FFT.
- overwrite_x (bool) – If True, the contents of
x
can be destroyed. - plan (cupy.cuda.cufft.PlanNd) –
a cuFFT plan for transforming
x
overaxes
, which can be obtained using:plan = cupyx.scipy.fftpack.get_fft_plan(x, axes)
Note that plan is defaulted to None, meaning CuPy will either use an auto-generated plan behind the scene if cupy.fft.config. enable_nd_planning = True, or use no cuFFT plan if it is set to False.
Returns: The transformed array which shape is specified by
shape
and type will convert to complex if that of the input is another.Return type: See also
Note
The argument plan is currently experimental and the interface may be changed in the future version.