Mercurial > hg > octave-nkf
annotate doc/interpreter/signal.txi @ 9072:bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
| author | Rik <rdrider0-list@yahoo.com> |
|---|---|
| date | Wed, 01 Apr 2009 17:06:45 -0700 |
| parents | eb63fbe60fab |
| children | 757efa1d7e2a |
| rev | line source |
|---|---|
| 8920 | 1 @c Copyright (C) 1996, 1997, 1999, 2000, 2002, 2004, 2006, 2007, 2008, 2009 |
| 2 @c John W. Eaton | |
| 7018 | 3 @c |
| 4 @c This file is part of Octave. | |
| 5 @c | |
| 6 @c Octave is free software; you can redistribute it and/or modify it | |
| 7 @c under the terms of the GNU General Public License as published by the | |
| 8 @c Free Software Foundation; either version 3 of the License, or (at | |
| 9 @c your option) any later version. | |
| 10 @c | |
| 11 @c Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 12 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 @c for more details. | |
| 15 @c | |
| 16 @c You should have received a copy of the GNU General Public License | |
| 17 @c along with Octave; see the file COPYING. If not, see | |
| 18 @c <http://www.gnu.org/licenses/>. | |
| 3294 | 19 |
| 4167 | 20 @node Signal Processing |
| 3294 | 21 @chapter Signal Processing |
| 22 | |
| 8828 | 23 |
|
9072
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
24 This chapter describes the signal processing and fast Fourier |
|
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
25 transform functions available in Octave. Fast Fourier transforms are |
|
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
26 computed with the @sc{fftw} or @sc{fftpack} libraries depending on how |
| 8828 | 27 Octave is built. |
| 28 | |
| 29 | |
| 30 | |
| 3367 | 31 @DOCSTRING(detrend) |
| 3294 | 32 |
| 3367 | 33 @DOCSTRING(fft) |
| 3294 | 34 |
|
9072
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
35 Octave uses the @sc{fftw} libraries to perform FFT computations. When Octave |
|
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
36 starts up and initializes the @sc{fftw} libraries, they read a system wide |
|
8426
7523742aa026
Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents:
7018
diff
changeset
|
37 file (on a Unix system, it is typically @file{/etc/fftw/wisdom}) that |
|
7523742aa026
Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents:
7018
diff
changeset
|
38 contains information useful to speed up FFT computations. This |
|
7523742aa026
Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents:
7018
diff
changeset
|
39 information is called the @emph{wisdom}. The system-wide file allows |
|
9072
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
40 wisdom to be shared between all applications using the @sc{fftw} libraries. |
|
8426
7523742aa026
Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents:
7018
diff
changeset
|
41 |
|
7523742aa026
Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents:
7018
diff
changeset
|
42 Use the @code{fftw} function to generate and save wisdom. Using the |
|
9072
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
43 utilities provided together with the @sc{fftw} libraries |
|
8426
7523742aa026
Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents:
7018
diff
changeset
|
44 (@command{fftw-wisdom} on Unix systems), you can even add wisdom |
|
7523742aa026
Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents:
7018
diff
changeset
|
45 generated by Octave to the system-wide wisdom file. |
|
7523742aa026
Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents:
7018
diff
changeset
|
46 |
| 6549 | 47 @DOCSTRING(fftw) |
| 48 | |
| 3367 | 49 @DOCSTRING(ifft) |
| 3294 | 50 |
| 3367 | 51 @DOCSTRING(fft2) |
| 3294 | 52 |
| 3367 | 53 @DOCSTRING(ifft2) |
| 3294 | 54 |
| 4773 | 55 @DOCSTRING(fftn) |
| 56 | |
| 57 @DOCSTRING(ifftn) | |
| 58 | |
| 3367 | 59 @DOCSTRING(fftconv) |
| 3294 | 60 |
| 3367 | 61 @DOCSTRING(fftfilt) |
| 3294 | 62 |
| 3367 | 63 @DOCSTRING(filter) |
| 3294 | 64 |
| 6549 | 65 @DOCSTRING(filter2) |
| 66 | |
| 3367 | 67 @DOCSTRING(freqz) |
| 3294 | 68 |
| 3920 | 69 @DOCSTRING(freqz_plot) |
| 70 | |
| 3367 | 71 @DOCSTRING(sinc) |
| 3449 | 72 |
| 3920 | 73 @DOCSTRING(unwrap) |
| 74 | |
| 5775 | 75 @c FIXME -- someone needs to organize these... |
| 3449 | 76 |
| 77 @DOCSTRING(arch_fit) | |
| 78 | |
| 79 @DOCSTRING(arch_rnd) | |
| 80 | |
| 81 @DOCSTRING(arch_test) | |
| 82 | |
| 83 @DOCSTRING(arma_rnd) | |
| 84 | |
| 85 @DOCSTRING(autocor) | |
| 86 | |
| 87 @DOCSTRING(autocov) | |
| 88 | |
| 89 @DOCSTRING(autoreg_matrix) | |
| 90 | |
| 91 @DOCSTRING(bartlett) | |
| 92 | |
| 93 @DOCSTRING(blackman) | |
| 94 | |
| 95 @DOCSTRING(diffpara) | |
| 96 | |
| 97 @DOCSTRING(durbinlevinson) | |
| 98 | |
| 99 @DOCSTRING(fftshift) | |
| 100 | |
| 6549 | 101 @DOCSTRING(ifftshift) |
| 102 | |
| 3449 | 103 @DOCSTRING(fractdiff) |
| 104 | |
| 105 @DOCSTRING(hamming) | |
| 106 | |
| 107 @DOCSTRING(hanning) | |
| 108 | |
| 109 @DOCSTRING(hurst) | |
| 110 | |
| 6549 | 111 @DOCSTRING(pchip) |
| 112 | |
| 3449 | 113 @DOCSTRING(periodogram) |
| 114 | |
| 115 @DOCSTRING(rectangle_lw) | |
| 116 | |
| 117 @DOCSTRING(rectangle_sw) | |
| 118 | |
| 119 @DOCSTRING(sinetone) | |
| 120 | |
| 121 @DOCSTRING(sinewave) | |
| 122 | |
| 123 @DOCSTRING(spectral_adf) | |
| 124 | |
| 125 @DOCSTRING(spectral_xdf) | |
| 126 | |
| 127 @DOCSTRING(spencer) | |
| 128 | |
| 129 @DOCSTRING(stft) | |
| 130 | |
| 131 @DOCSTRING(synthesis) | |
| 132 | |
| 133 @DOCSTRING(triangle_lw) | |
| 134 | |
| 135 @DOCSTRING(triangle_sw) | |
| 136 | |
| 137 @DOCSTRING(yulewalker) |