summaryrefslogtreecommitdiff
path: root/numpy/fft/fftpack.py
diff options
context:
space:
mode:
authorJarrod Millman <millman@berkeley.edu>2009-11-13 17:49:06 +0000
committerJarrod Millman <millman@berkeley.edu>2009-11-13 17:49:06 +0000
commitf07c79d3709a7f81219abc3c516fd772f469c167 (patch)
treeeaff2baba0176a7c41e749fd61b88a421dcfb188 /numpy/fft/fftpack.py
parent3122ee546fc0617e195aeb288abe65b9ae95d983 (diff)
downloadnumpy-f07c79d3709a7f81219abc3c516fd772f469c167.tar.gz
first set of checkins from the doc editor
Diffstat (limited to 'numpy/fft/fftpack.py')
-rw-r--r--numpy/fft/fftpack.py24
1 files changed, 14 insertions, 10 deletions
diff --git a/numpy/fft/fftpack.py b/numpy/fft/fftpack.py
index d74307f5e..a63977912 100644
--- a/numpy/fft/fftpack.py
+++ b/numpy/fft/fftpack.py
@@ -458,30 +458,34 @@ def hfft(a, n=None, axis=-1):
def ihfft(a, n=None, axis=-1):
"""
- Compute the inverse fft of a signal whose spectrum has Hermitian symmetry.
+ Compute the inverse FFT of a signal whose spectrum has Hermitian symmetry.
Parameters
----------
a : array_like
Input array.
n : int, optional
- Length of the ihfft.
+ Length of the inverse FFT.
axis : int, optional
- Axis over which to compute the ihfft.
+ Axis over which to compute the inverse FFT, assuming Hermitian
+ symmetry of the spectrum. Default is the last axis.
+
+ Returns
+ -------
+ out : ndarray
+ The transformed input.
See also
--------
- rfft, hfft
+ hfft, irfft
Notes
-----
- These are a pair analogous to rfft/irfft, but for the
+ `hfft`/`ihfft` are a pair analogous to `rfft`/`irfft`, but for the
opposite case: here the signal is real in the frequency domain and has
- Hermite symmetry in the time domain. So here it's hermite_fft for which
- you must supply the length of the result if it is to be odd.
-
- ihfft(hfft(a), len(a)) == a
- within numerical accuracy.
+ Hermite symmetry in the time domain. So here it's `hfft` for which
+ you must supply the length of the result if it is to be odd:
+ ``ihfft(hfft(a), len(a)) == a``, within numerical accuracy.
"""