flopscope.numpy.fft.rfft
fnp.fft.rfft(a, n=None, axis=-1, norm=None, out=None)[flopscope source][numpy source]
Compute the one-dimensional discrete Fourier Transform for real input.
Adapted from NumPy docs np.fft.rfft
1-D real FFT. Cost: 5*(n//2)*ceil(log2(n)) (Cooley-Tukey radix-2; Van Loan 1992 §1.4).
This function computes the one-dimensional n-point discrete Fourier Transform (DFT) of a real-valued array by means of an efficient algorithm called the Fast Fourier Transform (FFT).
Parameters
- a:array_like
Input array
- n:int, optional
Number of points along transformation axis in the input to use. If
nis smaller than the length of the input, the input is cropped. If it is larger, the input is padded with zeros. Ifnis not given, the length of the input along the axis specified byaxisis used.- axis:int, optional
Axis over which to compute the FFT. If not given, the last axis is used.
- norm:{"backward", "ortho", "forward"}, optional
Normalization mode (see flops.fft). Default is "backward". Indicates which direction of the forward/backward pair of transforms is scaled and with what normalization factor.
Added in version 1.20.0.- out:complex ndarray, optional
If provided, the result will be placed in this array. It should be of the appropriate shape and dtype.
Added in version 2.0.0.
Returns
- out:complex ndarray
The truncated or zero-padded input, transformed along the axis indicated by
axis, or the last one ifaxisis not specified. Ifnis even, the length of the transformed axis is(n/2)+1. Ifnis odd, the length is(n+1)/2.
Raises
- :IndexError
If
axisis not a valid axis ofa.
See also
Notes
When the DFT is computed for purely real input, the output is
Hermitian-symmetric, i.e. the negative frequency terms are just the complex
conjugates of the corresponding positive-frequency terms, and the
negative-frequency terms are therefore redundant. This function does not
compute the negative frequency terms, and the length of the transformed
axis of the output is therefore n//2 + 1.
When A = rfft(a) and fs is the sampling frequency, A[0] contains
the zero-frequency term 0*fs, which is real due to Hermitian symmetry.
If n is even, A[-1] contains the term representing both positive
and negative Nyquist frequency (+fs/2 and -fs/2), and must also be purely
real. If n is odd, there is no term at fs/2; A[-1] contains
the largest positive frequency (fs/2*(n-1)/n), and is complex in the
general case.
If the input a contains an imaginary part, it is silently discarded.
Examples
>>> import flopscope.numpy as fnp
>>> flops.fft.fft([0, 1, 0, 0])
array([ 1.+0.j, 0.-1.j, -1.+0.j, 0.+1.j]) # may vary
>>> flops.fft.rfft([0, 1, 0, 0])
array([ 1.+0.j, 0.-1.j, -1.+0.j]) # may varyNotice how the final element of the fft output is the complex conjugate
of the second element, for real input. For rfft, this symmetry is
exploited to compute only the non-negative frequency terms.