octave: scripts/signal/blackman.m annotate

annotate scripts/signal/blackman.m @ 31706:597f3ee61a48 stable

update Octave Project Developers copyright for the new year

author	John W. Eaton <jwe@octave.org>
date	Fri, 06 Jan 2023 13:11:27 -0500
parents	5d3faba0342e
children	2e484f9f1f18

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
31706 597f3ee61a48 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 30875 diff changeset	3 ## Copyright (C) 1995-2023 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	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	7 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	8 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	11 ## 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	12 ## 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	13 ## (at your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	14 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3457 diff changeset	15 ## 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	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	19 ##
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	20 ## 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	21 ## 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	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	25
3449 858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	26 ## -- texinfo --
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	27 ## @deftypefn {} {@var{c} =} blackman (@var{m})
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	28 ## @deftypefnx {} {@var{c} =} blackman (@var{m}, "periodic")
5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	29 ## @deftypefnx {} {@var{c} =} blackman (@var{m}, "symmetric")
25003 2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24534 diff changeset	30 ## Return the filter coefficients of a @nospell{Blackman} window of length
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24534 diff changeset	31 ## @var{m}.
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	32 ##
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	33 ## 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	34 ## 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	35 ## @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	36 ## @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	37 ##
25003 2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24534 diff changeset	38 ## For a definition of the @nospell{Blackman} window, see, e.g.,
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17744 diff changeset	39 ## @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	40 ## @cite{Discrete-Time Signal Processing}.
3449 858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe] jwe parents: 3426 diff changeset	41 ## @end deftypefn
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	42
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	43 function c = blackman (m, opt)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	44
28789 28de41192f3c Eliminate unneeded verification of nargin, nargout in m-files. Rik <rik@octave.org> parents: 27984 diff changeset	45 if (nargin < 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	46 print_usage ();
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	47 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	48
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	49 if (! (isscalar (m) && m > 0 && m == fix (m)))
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	50 error ("blackman: 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	51 endif
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	52
20026 230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option Mike Miller <mtmiller@octave.org> parents: 20025 diff changeset	53 N = m - 1;
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	54 if (nargin == 2)
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	55 switch (opt)
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	56 case "periodic"
20026 230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option Mike Miller <mtmiller@octave.org> parents: 20025 diff changeset	57 N = m;
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	58 case "symmetric"
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	59 ## 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	60 otherwise
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	61 error ('blackman: 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	62 endswitch
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	63 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	64
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	65 if (m == 1)
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	66 c = 1;
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	67 else
20231 83792dd9bcc1 Use in-place operators in m-files where possible. Rik <rik@octave.org> parents: 20165 diff changeset	68 m -= 1;
20026 230c1e2a678d blackman, hamming, hanning: Simplify handling of periodic window option Mike Miller <mtmiller@octave.org> parents: 20025 diff changeset	69 k = (0 : m)' / N;
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	70 c = 0.42 - 0.5 * cos (2 * pi * k) + 0.08 * cos (4 * pi * k);
e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	71 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3191 diff changeset	72
3191 e4f4b2d26ee9 [project @ 1998-10-23 05:43:59 by jwe] jwe parents: diff changeset	73 endfunction
13068 542891ebfcdb codesprint: 9 tests for bartlett.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	74
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	75
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	76 %!assert (blackman (1), 1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	77 %!assert (blackman (2), zeros (2,1), 1e-6)
20025 d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	78 %!assert (blackman (15), flip (blackman (15)), 5*eps)
d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	79 %!assert (blackman (16), flip (blackman (16)), 5*eps)
13068 542891ebfcdb codesprint: 9 tests for bartlett.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	80 %!test
542891ebfcdb codesprint: 9 tests for bartlett.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	81 %! N = 9;
542891ebfcdb codesprint: 9 tests for bartlett.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	82 %! A = blackman (N);
20025 d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	83 %! assert (A(ceil (N/2)), 1, 1e-6);
d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	84 %! assert ([A(1), A(length (A))], zeros (1,2), 1e-6);
13068 542891ebfcdb codesprint: 9 tests for bartlett.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	85
21317 a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 20852 diff changeset	86 %!assert (blackman (15), blackman (15, "symmetric"))
a4faec57f4c8 maint: remove semicolon after %!assert tests to follow Octave conventions. Rik <rik@octave.org> parents: 20852 diff changeset	87 %!assert (blackman (16)(1:15), blackman (15, "periodic"))
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	88 %!test
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	89 %! N = 16;
26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	90 %! A = blackman (N, "periodic");
20025 d209fbae38ae Fix tests for bartlett, blackman, hamming, and hanning Mike Miller <mtmiller@octave.org> parents: 19826 diff changeset	91 %! assert (A(N/2 + 1), 1, 1e-6);
19826 26fb4bfa4193 blackman, hamming, hanning: Add periodic window option (bug #43305) Mike Miller <mtmiller@ieee.org> parents: 19697 diff changeset	92
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 28789 diff changeset	93 %!error <Invalid call> blackman ()
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	94 %!error blackman (0.5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	95 %!error blackman (-1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	96 %!error blackman (ones (1,4))
21581 6fab85c1538f maint: Follow Octave conventions for use of semicolon in BIST tests. Rik <rik@octave.org> parents: 21317 diff changeset	97 %!error blackman (1, "invalid")

Mercurial > octave

annotate scripts/signal/blackman.m @ 31706:597f3ee61a48 stable