Mercurial > octave

annotate doc/interpreter/signal.txi @ 31225:3eab70385569

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
sparse-xpow.cc: Use faster multiplication technique, this time for complex
author Arun Giridhar <arungiridhar@gmail.com>
date Sun, 11 Sep 2022 13:53:38 -0400
parents 796f54d4ddbf
children 597f3ee61a48
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 26376
diff changeset
1 @c Copyright (C) 1996-2022 The Octave Project Developers
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
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
5 @c Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
6 @c under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
7 @c the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
8 @c (at your option) any later version.
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
9 @c
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
11 @c WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 @c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 @c GNU General Public License for more details.
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
14 @c
7018
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
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23220
diff changeset
17 @c <https://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
9072
bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
22 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
23 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
24 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
25 Octave is built.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
26
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
27 @DOCSTRING(fft)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
28
17369
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
29 @DOCSTRING(ifft)
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
30
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
31 @DOCSTRING(fft2)
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
32
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
33 @DOCSTRING(ifft2)
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
34
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
35 @DOCSTRING(fftn)
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
36
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
37 @DOCSTRING(ifftn)
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
38
9072
bd8e388043c4 Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
39 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
40 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
41 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
42 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
43 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
44 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
45
7523742aa026 Add explanation on what wisdom is.
Francesco Potortì <pot@gnu.org>
parents: 7018
diff changeset
46 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
47 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
48 (@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
49 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
50
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
51 @DOCSTRING(fftw)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
52
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
53 @DOCSTRING(fftconv)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
54
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
55 @DOCSTRING(fftfilt)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
56
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
57 @DOCSTRING(filter)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
58
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
59 @DOCSTRING(filter2)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
60
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
61 @DOCSTRING(freqz)
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
62
3920
87db95b22f8f [project @ 2002-05-01 04:07:31 by jwe]
jwe
parents: 3449
diff changeset
63 @DOCSTRING(freqz_plot)
87db95b22f8f [project @ 2002-05-01 04:07:31 by jwe]
jwe
parents: 3449
diff changeset
64
3367
0748b03c3510 [project @ 1999-11-20 14:52:38 by jwe]
jwe
parents: 3294
diff changeset
65 @DOCSTRING(sinc)
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
66
3920
87db95b22f8f [project @ 2002-05-01 04:07:31 by jwe]
jwe
parents: 3449
diff changeset
67 @DOCSTRING(unwrap)
87db95b22f8f [project @ 2002-05-01 04:07:31 by jwe]
jwe
parents: 3449
diff changeset
68
17369
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
69 @c FIXME: someone needs to organize these ...
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
70
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
71 @DOCSTRING(arch_fit)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
72
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
73 @DOCSTRING(arch_rnd)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
74
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
75 @DOCSTRING(arch_test)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
76
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
77 @DOCSTRING(arma_rnd)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
78
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
79 @DOCSTRING(autoreg_matrix)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
80
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
81 @DOCSTRING(bartlett)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
82
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
83 @DOCSTRING(blackman)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
84
17369
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
85 @DOCSTRING(detrend)
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
86
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
87 @DOCSTRING(diffpara)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
88
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
89 @DOCSTRING(durbinlevinson)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
90
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
91 @DOCSTRING(fftshift)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
92
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
93 @DOCSTRING(ifftshift)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
94
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
95 @DOCSTRING(fractdiff)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
96
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
97 @DOCSTRING(hamming)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
98
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
99 @DOCSTRING(hanning)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
100
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
101 @DOCSTRING(hurst)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
102
6549
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
103 @DOCSTRING(pchip)
5a5a09d7deb8 [project @ 2007-04-20 06:55:29 by jwe]
jwe
parents: 6535
diff changeset
104
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
105 @DOCSTRING(periodogram)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
106
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
107 @DOCSTRING(sinetone)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
108
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
109 @DOCSTRING(sinewave)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
110
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
111 @DOCSTRING(spectral_adf)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
112
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
113 @DOCSTRING(spectral_xdf)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
114
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
115 @DOCSTRING(spencer)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
116
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
117 @DOCSTRING(stft)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
118
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
119 @DOCSTRING(synthesis)
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3367
diff changeset
120
17369
3e95b22f5287 doc: Remove private functions from signal documentation chapter (bug #39939).
Rik <rik@octave.org>
parents: 14138
diff changeset
121 @DOCSTRING(yulewalker)