dpnp.fft.irfft

dpnp.fft.irfft(a, n=None, axis=-1, norm=None, out=None)[source]

Computes the inverse of dpnp.fft.rfft.

This function computes the inverse of the one-dimensional n-point discrete Fourier Transform of real input computed by dpnp.fft.rfft. In other words, irfft(rfft(a), len(a)) == a to within numerical accuracy. (See Notes below for why len(a) is necessary here.)

The input is expected to be in the form returned by dpnp.fft.rfft, i.e. the real zero-frequency term followed by the complex positive frequency terms in order of increasing frequency. Since the discrete Fourier Transform of real input is Hermitian-symmetric, the negative frequency terms are taken to be the complex conjugates of the corresponding positive frequency terms.

For full documentation refer to numpy.fft.irfft.

Parameters:

a ({dpnp.ndarray, usm_ndarray}) -- Input array.
n ({None, int}, optional) -- Length of the transformed axis of the output. For n output points, n//2+1 input points are necessary. If the input is longer than this, it is cropped. If it is shorter than this, it is padded with zeros. If n is not given, it is taken to be 2*(m-1) where m is the length of the input along the axis specified by axis. Default: None.
axis (int, optional) -- Axis over which to compute the FFT. If not given, the last axis is used. Default: -1.
norm ({None, "backward", "ortho", "forward"}, optional) -- Normalization mode (see dpnp.fft). Indicates which direction of the forward/backward pair of transforms is scaled and with what normalization factor. None is an alias of the default option "backward". Default: "backward".
out ({None, dpnp.ndarray, usm_ndarray}, optional) -- If provided, the result will be placed in this array. It should be of the appropriate shape and dtype. Default: None.

Returns:

out -- The truncated or zero-padded input, transformed along the axis indicated by axis, or the last one if axis is not specified. The length of the transformed axis is n, or, if n is not given, 2*(m-1) where m is the length of the transformed axis of the input. To get an odd number of output points, n must be specified.

Return type:

dpnp.ndarray

See also

dpnp.fft: For definition of the DFT and conventions used.
dpnp.fft.rfft: The one-dimensional FFT of real input, of which dpnp.fft.irfft is inverse.
dpnp.fft.fft: The one-dimensional FFT of general (complex) input.
dpnp.fft.irfft2: The inverse of the two-dimensional FFT of real input.
dpnp.fft.irfftn: The inverse of the N-dimensional FFT of real input.

Notes

Returns the real valued n-point inverse discrete Fourier transform of a, where a contains the non-negative frequency terms of a Hermitian-symmetric sequence. n is the length of the result, not the input.

If you specify an n such that a must be zero-padded or truncated, the extra/removed values will be added/removed at high frequencies. One can thus re-sample a series to m points via Fourier interpolation by: a_resamp = irfft(rfft(a), m).

The correct interpretation of the Hermitian input depends on the length of the original data, as given by n. This is because each input shape could correspond to either an odd or even length signal. By default, dpnp.fft.irfft assumes an even output length which puts the last entry at the Nyquist frequency; aliasing with its symmetric counterpart. By Hermitian symmetry, the value is thus treated as purely real. To avoid losing information, the correct length of the real input must be given.

Examples

>>> import dpnp as np
>>> a = np.array([1, -1j, -1, 1j])
>>> np.fft.ifft(a)
array([0.+0.j,  1.+0.j,  0.+0.j,  0.+0.j]) # may vary
>>> np.fft.irfft(a[:-1])
array([0.,  1.,  0.,  0.])

Notice how the last term in the input to the ordinary dpnp.fft.ifft is the complex conjugate of the second term, and the output has zero imaginary part everywhere. When calling dpnp.fft.irfft, the negative frequencies are not specified, and the output array is purely real.