octave: scripts/signal/spectral

annotate scripts/signal/spectral_xdf.m @ 21581:6fab85c1538f

maint: Follow Octave conventions for use of semicolon in BIST tests. * testfun.txi: Document Octave conventions for use of semicolon in BIST tests. * cellfun.cc, ellipj.cc, file-io.cc, gcd.cc, hash.cc, nproc.cc, utils.cc, fftw.cc, ov-usr-fcn.cc, oct-parse.in.yy, md5sum.m, wavread.m, wavwrite.m, cplxpair.m, rat.m, im2double.m, rref.m, stem3.m, rotate.m, pchip.m, blackman.m, hamming.m, hanning.m, spectral_adf.m, spectral_xdf.m, assert.m, fail.m, etime.m, build-sparse-tests.sh, classes.tst, ctor-vs-method.tst, index.tst, io.tst, struct.tst: Follow Octave conventions for use of semicolon in BIST tests.

author	Rik <rik@octave.org>
date	Fri, 01 Apr 2016 18:16:01 -0700
parents	516bb87ea72e
children	bac0d6f07a3e

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1995-2015 Friedrich Leisch
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	2 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 5307 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 5307 diff changeset	8 ## your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	9 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	14 ##
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 5307 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 5307 diff changeset	17 ## <http://www.gnu.org/licenses/>.
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	18
3449 858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	19 ## -- texinfo --
20852 516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20231 diff changeset	20 ## @deftypefn {} {} spectral_xdf (@var{x})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20231 diff changeset	21 ## @deftypefnx {} {} spectral_xdf (@var{x}, @var{win})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files. Rik <rik@octave.org> parents: 20231 diff changeset	22 ## @deftypefnx {} {} spectral_xdf (@var{x}, @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	23 ## Return the spectral density estimator given a data vector @var{x}, window
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	24 ## name @var{win}, and bandwidth, @var{b}.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	25 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## The window name, e.g., @qcode{"triangle"} or @qcode{"rectangle"} is used to
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	27 ## search for a function called @code{@var{win}_sw}.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	28 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	29 ## 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	30 ##
f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	31 ## If @var{b} is omitted, @code{1 / sqrt (length (@var{x}))} is used.
17230 86c45a04990f spectral_xdf.m: Add input validation, add %!tests, and fix docstring Mike Miller <mtmiller@ieee.org> parents: 17229 diff changeset	32 ## @seealso{spectral_adf}
3449 858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	33 ## @end deftypefn
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	34
3457 e031284eea27 [project @ 2000-01-19 08:49:56 by jwe] jwe parents: 3449 diff changeset	35 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at>
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe] jwe parents: 3449 diff changeset	36 ## Description: Spectral density estimation
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	37
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	38 function retval = spectral_xdf (x, win, b)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	39
17230 86c45a04990f spectral_xdf.m: Add input validation, add %!tests, and fix docstring Mike Miller <mtmiller@ieee.org> parents: 17229 diff changeset	40 if (nargin < 1 \|\| nargin > 3)
86c45a04990f spectral_xdf.m: Add input validation, add %!tests, and fix docstring Mike Miller <mtmiller@ieee.org> parents: 17229 diff changeset	41 print_usage ();
86c45a04990f spectral_xdf.m: Add input validation, add %!tests, and fix docstring Mike Miller <mtmiller@ieee.org> parents: 17229 diff changeset	42 endif
86c45a04990f spectral_xdf.m: Add input validation, add %!tests, and fix docstring Mike Miller <mtmiller@ieee.org> parents: 17229 diff changeset	43
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	44 xr = length (x);
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	45
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	46 if (columns (x) > 1)
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	47 x = x';
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	48 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	49
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	50 if (nargin < 3)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	51 b = 1 / ceil (sqrt (xr));
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	52 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	53
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	54 if (nargin == 1)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	55 w = triangle_sw (xr, b);
17230 86c45a04990f spectral_xdf.m: Add input validation, add %!tests, and fix docstring Mike Miller <mtmiller@ieee.org> parents: 17229 diff changeset	56 elseif (! ischar (win))
86c45a04990f spectral_xdf.m: Add input validation, add %!tests, and fix docstring Mike Miller <mtmiller@ieee.org> parents: 17229 diff changeset	57 error ("spectral_xdf: WIN must be a string");
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	58 else
17229 2736bc7bf8d9 Fix syntax error typos in spectral_adf and spectral_xdf (bug #39766) Mike Miller <mtmiller@ieee.org> parents: 16994 diff changeset	59 win = str2func ([win "_sw"]);
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	60 w = feval (win, xr, b);
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	61 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	62
20231 83792dd9bcc1 Use in-place operators in m-files where possible. Rik <rik@octave.org> parents: 20165 diff changeset	63 x -= sum (x) / xr;
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	64
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 8920 diff changeset	65 retval = (abs (fft (x)) / xr).^2;
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	66 retval = real (ifft (fft (retval) .* fft (w)));
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	67
3238 041ea33fbbf4 [project @ 1999-03-26 17:48:16 by jwe] jwe parents: 3191 diff changeset	68 retval = [(zeros (xr, 1)), retval];
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	69 retval(:, 1) = (0 : xr-1)' / xr;
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3238 diff changeset	70
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	71 endfunction
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	72
17338 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 17281 diff changeset	73
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	74 ## Test input validation
21581 6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 20852 diff changeset	75 %!error spectral_xdf ()
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 20852 diff changeset	76 %!error spectral_xdf (1, 2, 3, 4)
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 20852 diff changeset	77 %!error spectral_xdf (1, 2)
6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 20852 diff changeset	78 %!error spectral_xdf (1, "invalid")
17338 1c89599167a6 maint: End m-files with 1 blank line. Rik <rik@octave.org> parents: 17281 diff changeset	79

Mercurial > octave

annotate scripts/signal/spectral_xdf.m @ 21581:6fab85c1538f