annotate doc/interpreter/signal.txi @ 11542:695141f1c05c ss-3-3-55

snapshot 3.3.55
author John W. Eaton <jwe@octave.org>
date Sat, 15 Jan 2011 04:53:04 -0500
parents fd0a3ac60b0e
children 72c96de7a403
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11523
fd0a3ac60b0e update copyright notices
John W. Eaton <jwe@octave.org>
parents: 11392
diff changeset
1 @c Copyright (C) 1996-2011 John W. Eaton
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
4 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
5 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
6 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
7 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
8 @c your option) any later version.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
9 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
13 @c for more details.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
14 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
16 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 6778
diff changeset
17 @c <http://www.gnu.org/licenses/>.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
18
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3920
diff changeset
19 @node Signal Processing
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
20 @chapter Signal Processing
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
21
8828
8463d1a2e544 Doc fixes.
Brian Gough <bjg@network-theory.co.uk>
parents: 8426
diff changeset
22
9072
bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
23 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
24 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
25 computed with the @sc{fftw} or @sc{fftpack} libraries depending on how
8828
8463d1a2e544 Doc fixes.
Brian Gough <bjg@network-theory.co.uk>
parents: 8426
diff changeset
26 Octave is built.
8463d1a2e544 Doc fixes.
Brian Gough <bjg@network-theory.co.uk>
parents: 8426
diff changeset
27
8463d1a2e544 Doc fixes.
Brian Gough <bjg@network-theory.co.uk>
parents: 8426
diff changeset
28
8463d1a2e544 Doc fixes.
Brian Gough <bjg@network-theory.co.uk>
parents: 8426
diff changeset
29
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
30 @DOCSTRING(detrend)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
31
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
32 @DOCSTRING(fft)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
33
9072
bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
34 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
35 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
36 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
37 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
38 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
39 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
40
7523742aa026 Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents: 7018
diff changeset
41 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
42 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
43 (@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
44 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
45
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
46 @DOCSTRING(fftw)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
47
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
48 @DOCSTRING(ifft)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
49
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
50 @DOCSTRING(fft2)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
51
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
52 @DOCSTRING(ifft2)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
53
4773
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4167
diff changeset
54 @DOCSTRING(fftn)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4167
diff changeset
55
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4167
diff changeset
56 @DOCSTRING(ifftn)
ccfbd6047a54 [project @ 2004-02-16 19:02:32 by jwe]
jwe
parents: 4167
diff changeset
57
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
58 @DOCSTRING(fftconv)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
59
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
60 @DOCSTRING(fftfilt)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
61
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
62 @DOCSTRING(filter)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
63
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
64 @DOCSTRING(filter2)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
65
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
66 @DOCSTRING(freqz)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
67
3920
87db95b22f8f [project @ 2002-05-01 04:07:31 by jwe]
jwe
parents: 3449
diff changeset
68 @DOCSTRING(freqz_plot)
87db95b22f8f [project @ 2002-05-01 04:07:31 by jwe]
jwe
parents: 3449
diff changeset
69
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
70 @DOCSTRING(sinc)
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
71
3920
87db95b22f8f [project @ 2002-05-01 04:07:31 by jwe]
jwe
parents: 3449
diff changeset
72 @DOCSTRING(unwrap)
87db95b22f8f [project @ 2002-05-01 04:07:31 by jwe]
jwe
parents: 3449
diff changeset
73
5775
ace8d8d26933 [project @ 2006-04-24 19:13:06 by jwe]
jwe
parents: 5041
diff changeset
74 @c FIXME -- someone needs to organize these...
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
75
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
76 @DOCSTRING(arch_fit)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
77
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
78 @DOCSTRING(arch_rnd)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
79
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
80 @DOCSTRING(arch_test)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
81
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
82 @DOCSTRING(arma_rnd)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
83
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
84 @DOCSTRING(autoreg_matrix)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
85
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
86 @DOCSTRING(bartlett)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
87
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
88 @DOCSTRING(blackman)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
89
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
90 @DOCSTRING(diffpara)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
91
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
92 @DOCSTRING(durbinlevinson)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
93
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
94 @DOCSTRING(fftshift)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
95
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
96 @DOCSTRING(ifftshift)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
97
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
98 @DOCSTRING(fractdiff)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
99
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
100 @DOCSTRING(hamming)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
101
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
102 @DOCSTRING(hanning)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
103
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
104 @DOCSTRING(hurst)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
105
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
106 @DOCSTRING(pchip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
107
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
108 @DOCSTRING(periodogram)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
109
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
110 @DOCSTRING(rectangle_lw)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
111
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
112 @DOCSTRING(rectangle_sw)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
113
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
114 @DOCSTRING(sinetone)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
115
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
116 @DOCSTRING(sinewave)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
117
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
118 @DOCSTRING(spectral_adf)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
119
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
120 @DOCSTRING(spectral_xdf)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
121
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
122 @DOCSTRING(spencer)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
123
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
124 @DOCSTRING(stft)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
125
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
126 @DOCSTRING(synthesis)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
127
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
128 @DOCSTRING(triangle_lw)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
129
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
130 @DOCSTRING(triangle_sw)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
131
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
132 @DOCSTRING(yulewalker)