cupyx.scipy.fft.irfft

cupyx.scipy.fft.irfft(x, n=None, axis=-1, norm=None, overwrite_x=False, *, plan=None)

Compute the one-dimensional inverse FFT for real input.

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 (None or 'ortho') – Normalization mode.

  • 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,
                                            value_type='C2R')
    

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

Returns

The transformed array.

Return type

cupy.ndarray