cupyx.scipy.fft.fft#

cupyx.scipy.fft.fft(x, n=None, axis=-1, norm=None, overwrite_x=False, *, plan=None)[source]#

Compute the one-dimensional FFT.

Parameters
  • x (cupy.ndarray) – Array to be transformed.

  • n (None or int) – Length of the transformed axis of the output. If n is not given, the length of the input along the axis specified by axis is used.

  • axis (int) – Axis over which to compute the FFT.

  • norm ("backward", "ortho", or "forward") – Optional keyword to specify the normalization mode. Default is None, which is an alias of "backward".

  • overwrite_x (bool) – If True, the contents of x can be destroyed.

  • plan (cupy.cuda.cufft.Plan1d or None) –

    a cuFFT plan for transforming x over axis, which can be obtained using:

    plan = cupyx.scipy.fftpack.get_fft_plan(x, n, axis)
    

    Note that plan is defaulted to None, meaning CuPy will use an auto-generated plan behind the scene.

Returns

The transformed array which shape is specified by n and type will convert to complex if that of the input is another.

Return type

cupy.ndarray

See also

scipy.fft.fft()