cupyx.scipy.fftpack.ifft

cupyx.scipy.fftpack.ifft(x, n=None, axis=-1, overwrite_x=False, plan=None)

Compute the one-dimensional inverse 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.

  • 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, 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

Note

The argument plan is currently experimental and the interface may be changed in the future version.