cupyx.scipy.fft.rfft#
- cupyx.scipy.fft.rfft(x, n=None, axis=-1, norm=None, overwrite_x=False, *, plan=None)[source]#
Compute the one-dimensional FFT for real input.
The returned array contains the positive frequency components of the corresponding
fft()
, up to and including the Nyquist frequency.- 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 byaxis
is used.axis (int) – Axis over which to compute the FFT.
norm (
"backward"
,"ortho"
, or"forward"
) – Optional keyword to specify the normalization mode. Default isNone
, which is an alias of"backward"
.overwrite_x (bool) – If True, the contents of
x
can be destroyed.plan (
cupy.cuda.cufft.Plan1d
orNone
) –a cuFFT plan for transforming
x
overaxis
, which can be obtained using:plan = cupyx.scipy.fftpack.get_fft_plan(x, n, axis, value_type='R2C')
Note that
plan
is defaulted toNone
, meaning CuPy will use an auto-generated plan behind the scene.
- Returns:
The transformed array.
- Return type:
See also