cupyx.scipy.fft.rfftn

cupyx.scipy.fft.rfftn(x, s=None, axes=None, norm=None, overwrite_x=False, *, plan=None)[source]

Compute the N-dimensional FFT for real input.

Parameters
  • a (cupy.ndarray) – Array to be transform.

  • s (None or tuple of ints) – Shape to use from the input. If s is not given, the lengths of the input along the axes specified by axes are used.

  • axes (tuple of ints) – Axes over which to compute the FFT.

  • norm (None or "ortho") – Keyword to specify the normalization mode.

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

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

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

    plan = cupyx.scipy.fftpack.get_fft_plan(x, s, axes,
                                            value_type='R2C')
    

    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 s and type will convert to complex if the input is other. The length of the last axis transformed will be s[-1]//2+1.

Return type

cupy.ndarray