Mercurial > octave
annotate scripts/signal/spectral_adf.m @ 27919:1891570abac8
update Octave Project Developers copyright for the new year
In files that have the "Octave Project Developers" copyright notice,
update for 2020.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Mon, 06 Jan 2020 22:29:51 -0500 |
parents | b442ec6dda5c |
children | bd51beb6205e |
rev | line source |
---|---|
27919
1891570abac8
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
27918
diff
changeset
|
1 ## Copyright (C) 1995-2020 The Octave Project Developers |
27918
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
2 ## |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
3 ## See the file COPYRIGHT.md in the top-level directory of this distribution |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
4 ## or <https://octave.org/COPYRIGHT.html/>. |
b442ec6dda5c
use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents:
26376
diff
changeset
|
5 ## |
3426 | 6 ## |
3922 | 7 ## This file is part of Octave. |
8 ## | |
24534
194eb4bd202b
maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents:
23220
diff
changeset
|
9 ## Octave is free software: you can redistribute it and/or modify it |
3922 | 10 ## 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
|
11 ## 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
|
12 ## (at your option) any later version. |
3426 | 13 ## |
3922 | 14 ## Octave is distributed in the hope that it will be useful, but |
3191 | 15 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
16 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22323
diff
changeset
|
17 ## GNU General Public License for more details. |
3426 | 18 ## |
3191 | 19 ## You should have received a copy of the GNU General Public License |
7016 | 20 ## 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
|
21 ## <https://www.gnu.org/licenses/>. |
3191 | 22 |
3449 | 23 ## -*- texinfo -*- |
20852
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20231
diff
changeset
|
24 ## @deftypefn {} {} spectral_adf (@var{c}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20231
diff
changeset
|
25 ## @deftypefnx {} {} spectral_adf (@var{c}, @var{win}) |
516bb87ea72e
2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents:
20231
diff
changeset
|
26 ## @deftypefnx {} {} spectral_adf (@var{c}, @var{win}, @var{b}) |
20165
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
27 ## Return the spectral density estimator given a vector of autocovariances |
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
28 ## @var{c}, window name @var{win}, and bandwidth, @var{b}. |
3426 | 29 ## |
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17231
diff
changeset
|
30 ## The window name, e.g., @qcode{"triangle"} or @qcode{"rectangle"} is |
17231
95a402f56b95
spectral_adf.m: Add input validation, add %!tests, and fix docstring
Mike Miller <mtmiller@ieee.org>
parents:
17229
diff
changeset
|
31 ## used to search for a function called @code{@var{win}_lw}. |
3426 | 32 ## |
20165
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
33 ## If @var{win} is omitted, the triangle window is used. |
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
34 ## |
f1d0f506ee78
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
35 ## If @var{b} is omitted, @code{1 / sqrt (length (@var{x}))} is used. |
17231
95a402f56b95
spectral_adf.m: Add input validation, add %!tests, and fix docstring
Mike Miller <mtmiller@ieee.org>
parents:
17229
diff
changeset
|
36 ## @seealso{spectral_xdf} |
3449 | 37 ## @end deftypefn |
3426 | 38 |
3457 | 39 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> |
40 ## Description: Spectral density estimation | |
3426 | 41 |
3191 | 42 function retval = spectral_adf (c, win, b) |
3426 | 43 |
17231
95a402f56b95
spectral_adf.m: Add input validation, add %!tests, and fix docstring
Mike Miller <mtmiller@ieee.org>
parents:
17229
diff
changeset
|
44 if (nargin < 1 || nargin > 3) |
95a402f56b95
spectral_adf.m: Add input validation, add %!tests, and fix docstring
Mike Miller <mtmiller@ieee.org>
parents:
17229
diff
changeset
|
45 print_usage (); |
95a402f56b95
spectral_adf.m: Add input validation, add %!tests, and fix docstring
Mike Miller <mtmiller@ieee.org>
parents:
17229
diff
changeset
|
46 endif |
95a402f56b95
spectral_adf.m: Add input validation, add %!tests, and fix docstring
Mike Miller <mtmiller@ieee.org>
parents:
17229
diff
changeset
|
47 |
3191 | 48 cr = length (c); |
3426 | 49 |
3191 | 50 if (columns (c) > 1) |
8507 | 51 c = c'; |
3191 | 52 endif |
53 | |
54 if (nargin < 3) | |
55 b = 1 / ceil (sqrt (cr)); | |
56 endif | |
57 | |
58 if (nargin == 1) | |
59 w = triangle_lw (cr, b); | |
17231
95a402f56b95
spectral_adf.m: Add input validation, add %!tests, and fix docstring
Mike Miller <mtmiller@ieee.org>
parents:
17229
diff
changeset
|
60 elseif (! ischar (win)) |
95a402f56b95
spectral_adf.m: Add input validation, add %!tests, and fix docstring
Mike Miller <mtmiller@ieee.org>
parents:
17229
diff
changeset
|
61 error ("spectral_adf: WIN must be a string"); |
3191 | 62 else |
17229
2736bc7bf8d9
Fix syntax error typos in spectral_adf and spectral_xdf (bug #39766)
Mike Miller <mtmiller@ieee.org>
parents:
16994
diff
changeset
|
63 win = str2func ([win "_lw"]); |
3191 | 64 w = feval (win, cr, b); |
65 endif | |
3426 | 66 |
20231
83792dd9bcc1
Use in-place operators in m-files where possible.
Rik <rik@octave.org>
parents:
20165
diff
changeset
|
67 c .*= w; |
3426 | 68 |
3191 | 69 retval = 2 * real (fft (c)) - c(1); |
3238 | 70 retval = [(zeros (cr, 1)), retval]; |
3374 | 71 retval(:, 1) = (0 : cr-1)' / cr; |
3426 | 72 |
3191 | 73 endfunction |
74 | |
17338
1c89599167a6
maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents:
17281
diff
changeset
|
75 |
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
76 ## Test input validation |
21581
6fab85c1538f
maint: Follow Octave conventions for use of semicolon in BIST tests.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
77 %!error spectral_adf () |
6fab85c1538f
maint: Follow Octave conventions for use of semicolon in BIST tests.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
78 %!error spectral_adf (1, 2, 3, 4) |
6fab85c1538f
maint: Follow Octave conventions for use of semicolon in BIST tests.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
79 %!error spectral_adf (1, 2) |
6fab85c1538f
maint: Follow Octave conventions for use of semicolon in BIST tests.
Rik <rik@octave.org>
parents:
20852
diff
changeset
|
80 %!error spectral_adf (1, "invalid") |