diff options
| author | endolith <endolith@gmail.com> | 2013-08-21 16:20:43 -0400 |
|---|---|---|
| committer | endolith <endolith@gmail.com> | 2013-08-21 16:20:43 -0400 |
| commit | 768a7393f7258cfb2df19df60c8ee6a1ed307eb1 (patch) | |
| tree | cf1fd3eb751313f6d6f6906bc63c1bf0b92b59f6 /numpy/fft/fftpack.py | |
| parent | 9464075c7260475bdd5d693b3046379a2bb62482 (diff) | |
| download | numpy-768a7393f7258cfb2df19df60c8ee6a1ed307eb1.tar.gz | |
DOC: hfft/ihfft description conflicts with itself
Says Hermite spectrum when it means signal
Diffstat (limited to 'numpy/fft/fftpack.py')
| -rw-r--r-- | numpy/fft/fftpack.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/numpy/fft/fftpack.py b/numpy/fft/fftpack.py index 1fb7bafc4..caafb6295 100644 --- a/numpy/fft/fftpack.py +++ b/numpy/fft/fftpack.py @@ -412,7 +412,7 @@ def irfft(a, n=None, axis=-1): def hfft(a, n=None, axis=-1): """ - Compute the FFT of a signal whose spectrum has Hermitian symmetry. + Compute the FFT of a signal which has Hermitian symmetry (real spectrum). Parameters ---------- @@ -437,8 +437,8 @@ def hfft(a, n=None, axis=-1): Notes ----- `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 `hfft` for which + opposite case: here the signal has Hermite symmetry in the time domain + and is real in the frequency 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. @@ -463,7 +463,7 @@ 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 which has Hermitian symmetry (real spectrum). Parameters ---------- @@ -487,8 +487,8 @@ def ihfft(a, n=None, axis=-1): Notes ----- `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 `hfft` for which + opposite case: here the signal has Hermite symmetry in the time domain + and is real in the frequency 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. |