octave: scripts/signal/hamming.m annotate

annotate scripts/signal/hamming.m @ 20165:f1d0f506ee78 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed optimization, polynomial, signal script directories. * scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/lsqnonneg.m, scripts/optimization/pqpnonneg.m, scripts/optimization/qp.m, scripts/optimization/sqp.m, scripts/polynomial/compan.m, scripts/polynomial/mkpp.m, scripts/polynomial/mpoles.m, scripts/polynomial/pchip.m, scripts/polynomial/poly.m, scripts/polynomial/polyaffine.m, scripts/polynomial/polyder.m, scripts/polynomial/polyeig.m, scripts/polynomial/polyfit.m, scripts/polynomial/polygcd.m, scripts/polynomial/polyint.m, scripts/polynomial/polyout.m, scripts/polynomial/polyval.m, scripts/polynomial/ppder.m, scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m, scripts/polynomial/ppval.m, scripts/polynomial/residue.m, scripts/polynomial/roots.m, scripts/polynomial/spline.m, scripts/polynomial/splinefit.m, scripts/polynomial/unmkpp.m, scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m, scripts/signal/arma_rnd.m, scripts/signal/autoreg_matrix.m, scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/detrend.m, scripts/signal/diffpara.m, scripts/signal/durbinlevinson.m, scripts/signal/fftconv.m, scripts/signal/fftfilt.m, scripts/signal/fftshift.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/hamming.m, scripts/signal/hanning.m, scripts/signal/hurst.m, scripts/signal/ifftshift.m, scripts/signal/periodogram.m, scripts/signal/sinc.m, scripts/signal/sinetone.m, scripts/signal/sinewave.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/signal/spencer.m, scripts/signal/stft.m, scripts/signal/synthesis.m, scripts/signal/unwrap.m, scripts/signal/yulewalker.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Mon, 04 May 2015 21:50:57 -0700
parents	230c1e2a678d
children	83792dd9bcc1

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19040 diff changeset	1 ## Copyright (C) 1995-2015 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 --
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	20 ## @deftypefn {Function File} {} hamming (@var{m})
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	21 ## @deftypefnx {Function File} {} hamming (@var{m}, "periodic")
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	22 ## @deftypefnx {Function File} {} hamming (@var{m}, "symmetric")
3449 858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	23 ## Return the filter coefficients of a Hamming window of length @var{m}.
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	24 ##
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	25 ## If the optional argument @qcode{"periodic"} is given, the periodic form
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	26 ## of the window is returned. This is equivalent to the window of length
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	27 ## @var{m}+1 with the last coefficient removed. The optional argument
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	28 ## @qcode{"symmetric"} is equivalent to not specifying a second argument.
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	29 ##
20165 f1d0f506ee78 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 20026 diff changeset	30 ## For a definition of the Hamming window see, e.g.,
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17744 diff changeset	31 ## @nospell{A.V. Oppenheim & R. W. Schafer},
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17744 diff changeset	32 ## @cite{Discrete-Time Signal Processing}.
3449 858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	33 ## @end deftypefn
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	34
3457 e031284eea27 [project @ 2000-01-19 08:49:56 by jwe] jwe parents: 3449 diff changeset	35 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at>
e031284eea27 [project @ 2000-01-19 08:49:56 by jwe] jwe parents: 3449 diff changeset	36 ## Description: Coefficients of the Hamming window
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	37
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	38 function c = hamming (m, opt)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	39
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	40 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	41 print_usage ();
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	42 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	43
13279 984359717d71 Use common code idiom for checking whether a double value is an integer. Rik <octave@nomad.inbox5.com> parents: 13059 diff changeset	44 if (! (isscalar (m) && (m == fix (m)) && (m > 0)))
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	45 error ("hamming: M must be a positive integer");
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	46 endif
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	47
20026 230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option Mike Miller <mtmiller@octave.org> parents: 20025 diff changeset	48 N = m - 1;
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	49 if (nargin == 2)
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	50 switch (opt)
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	51 case "periodic"
20026 230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option Mike Miller <mtmiller@octave.org> parents: 20025 diff changeset	52 N = m;
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	53 case "symmetric"
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	54 ## Default option, same as no option specified.
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	55 otherwise
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	56 error ('hamming: window type must be either "periodic" or "symmetric"');
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	57 endswitch
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	58 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	59
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	60 if (m == 1)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	61 c = 1;
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	62 else
20026 230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option Mike Miller <mtmiller@octave.org> parents: 20025 diff changeset	63 m = m - 1;
230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option Mike Miller <mtmiller@octave.org> parents: 20025 diff changeset	64 c = 0.54 - 0.46 * cos (2 * pi * (0 : m)' / N);
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	65 endif
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	66
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	67 endfunction
13059 107651f79e06 codesprint: 9 tests for hamming.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	68
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	69
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	70 %!assert (hamming (1), 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	71 %!assert (hamming (2), (0.54 - 0.46)*ones (2,1))
20025 d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	72 %!assert (hamming (15), flip (hamming (15)), 5*eps)
d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	73 %!assert (hamming (16), flip (hamming (16)), 5*eps)
13059 107651f79e06 codesprint: 9 tests for hamming.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	74 %!test
107651f79e06 codesprint: 9 tests for hamming.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	75 %! N = 15;
107651f79e06 codesprint: 9 tests for hamming.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	76 %! A = hamming (N);
20025 d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	77 %! assert (A(ceil (N/2)), 1);
13059 107651f79e06 codesprint: 9 tests for hamming.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	78
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	79 %!assert (hamming (15), hamming (15, "symmetric"));
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	80 %!assert (hamming (16)(1:15), hamming (15, "periodic"));
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	81 %!test
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	82 %! N = 16;
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	83 %! A = hamming (N, "periodic");
20025 d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	84 %! assert (A(N/2 + 1), 1);
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	85
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	86 %!error hamming ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	87 %!error hamming (0.5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	88 %!error hamming (-1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	89 %!error hamming (ones (1,4))
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	90 %!error hamming (1, "invalid");
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	91

Mercurial > octave

annotate scripts/signal/hamming.m @ 20165:f1d0f506ee78 stable