octave-nkf: scripts/signal/hanning.m annotate

annotate scripts/signal/hanning.m @ 14138:72c96de7a403 stable

maint: update copyright notices for 2012

author	John W. Eaton <jwe@octave.org>
date	Mon, 02 Jan 2012 14:25:41 -0500
parents	984359717d71
children	f3d52523cde1

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13279 diff changeset	1 ## Copyright (C) 1995-2012 Andreas Weingessel
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 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: 6046 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: 6046 diff changeset	8 ## your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 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: 3191 diff changeset	13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 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: 6046 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: 6046 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 --
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	20 ## @deftypefn {Function File} {} hanning (@var{m})
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	21 ## Return the filter coefficients of a Hanning window of length @var{m}.
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	22 ##
9051 1bf0ce0930be Grammar check TexInfo in all .m files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	23 ## For a definition of this window type, see e.g., A. V. Oppenheim &
8484 895d49a7e36a [docs] "Discrete-Time Signal Processing" => @cite{Discrete-Time Signal Processing} Brian Gough <bjg@gnu.org> parents: 7017 diff changeset	24 ## R. W. Schafer, @cite{Discrete-Time Signal Processing}.
3449 858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	25 ## @end deftypefn
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	26
3457 e031284eea27 [project @ 2000-01-19 08:49:56 by jwe] jwe parents: 3449 diff changeset	27 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe] jwe parents: 3449 diff changeset	28 ## Description: Coefficients of the Hanning window
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	29
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	30 function c = hanning (m)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	31
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	32 if (nargin != 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	33 print_usage ();
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	34 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	35
13279 984359717d71 Use common code idiom for checking whether a double value is an integer. Rik <octave@nomad.inbox5.com> parents: 13055 diff changeset	36 if (! (isscalar (m) && (m == fix (m)) && (m > 0)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 9051 diff changeset	37 error ("hanning: M has to be an integer > 0");
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	38 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	39
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	40 if (m == 1)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	41 c = 1;
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	42 else
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	43 m = m - 1;
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	44 c = 0.5 - 0.5 * cos (2 * pi * (0 : m)' / m);
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	45 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	46
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	47 endfunction
13055 4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	48
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	49 %!assert (hanning (1), 1);
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	50 %!assert (hanning (2), zeros(2,1));
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	51 %!assert (hanning (16), fliplr (hanning (16)));
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	52 %!assert (hanning (15), fliplr (hanning (15)));
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	53 %!test
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	54 %! N = 15;
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	55 %! A = hanning (N);
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	56 %! assert (A (ceil (N/2)), 1);
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	57
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	58 %!error hanning ();
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	59 %!error hanning (0.5);
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	60 %!error hanning (-1);
4e95529cbc51 codesprint: 9 tests for hanning.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	61 %!error hanning (ones(1,4));

Mercurial > octave-nkf

annotate scripts/signal/hanning.m @ 14138:72c96de7a403 stable