Mercurial > hg > octave-nkf
annotate scripts/signal/stft.m @ 15107:03381a36f70d
generate convenience libraries for new parse-tree and interpfcn subdirectories
* src/Makefile.am (liboctinterp_la_SOURCES): Include octave.cc in the
list, not $(DIST_SRC).
(liboctinterp_la_LIBADD): Include octave-value/liboctave-value.la,
parse-tree/libparse-tree.la, interp-core/libinterp-core.la,
interpfcn/libinterpfcn.la, and corefcn/libcorefcn.la in the list.
* src/interp-core/module.mk (noinst_LTLIBRARIES): Add
interp-core/libinterp-core.la to the list.
(interp_core_libinterp_core_la_SOURCES): New variable.
* src/interpfcn/module.mk (noinst_LTLIBRARIES): Add
interpfcn/libinterpfcn.la to the list.
(interpfcn_libinterpfcn_la_SOURCES): New variable.
* src/parse-tree/module.mk (noinst_LTLIBRARIES): Add
parse-tree/libparse-tree.la to the list.
(parse_tree_libparse_tree_la_SOURCES): New variable.
* src/octave-value/module.mk (noinst_LTLIBRARIES): Add
octave-value/liboctave-value.la to the list.
(octave_value_liboctave_value_la_SOURCES): New variable.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Sun, 05 Aug 2012 09:04:30 -0400 |
| parents | 5d3a684236b0 |
| children | 049e8bbff782 |
| rev | line source |
|---|---|
|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
1 ## Copyright (C) 1995-2012 Andreas Weingessel |
| 3426 | 2 ## |
| 3922 | 3 ## This file is part of Octave. |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 3426 | 9 ## |
| 3922 | 10 ## Octave is distributed in the hope that it will be useful, but |
| 3191 | 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 3426 | 13 ## General Public License for more details. |
| 14 ## | |
| 3191 | 15 ## You should have received a copy of the GNU General Public License |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 3191 | 18 |
| 3449 | 19 ## -*- texinfo -*- |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
20 ## @deftypefn {Function File} {[@var{y}, @var{c}] =} stft (@var{x}, @var{win_size}, @var{inc}, @var{num_coef}, @var{win_type}) |
|
9072
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
21 ## Compute the short-time Fourier transform of the vector @var{x} with |
| 3449 | 22 ## @var{num_coef} coefficients by applying a window of @var{win_size} data |
| 23 ## points and an increment of @var{inc} points. | |
| 3191 | 24 ## |
| 25 ## Before computing the Fourier transform, one of the following windows | |
| 3449 | 26 ## is applied: |
| 27 ## | |
| 28 ## @table @asis | |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
9072
diff
changeset
|
29 ## @item @nospell{hanning} |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
30 ## win_type = 1 |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
31 ## |
|
10791
3140cb7a05a1
Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents:
9072
diff
changeset
|
32 ## @item @nospell{hamming} |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
33 ## win_type = 2 |
|
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10791
diff
changeset
|
34 ## |
| 3449 | 35 ## @item rectangle |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
36 ## win_type = 3 |
| 3449 | 37 ## @end table |
| 38 ## | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
39 ## The window names can be passed as strings or by the @var{win_type} number. |
| 3191 | 40 ## |
| 41 ## If not all arguments are specified, the following defaults are used: | |
| 3449 | 42 ## @var{win_size} = 80, @var{inc} = 24, @var{num_coef} = 64, and |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
43 ## @var{win_type} = 1. |
| 3191 | 44 ## |
| 3449 | 45 ## @code{@var{y} = stft (@var{x}, @dots{})} returns the absolute values |
| 46 ## of the Fourier coefficients according to the @var{num_coef} positive | |
| 47 ## frequencies. | |
| 48 ## | |
| 49 ## @code{[@var{y}, @var{c}] = stft (@code{x}, @dots{})} returns the | |
| 50 ## entire STFT-matrix @var{y} and a 3-element vector @var{c} containing | |
| 51 ## the window size, increment, and window type, which is needed by the | |
| 52 ## synthesis function. | |
| 53 ## @end deftypefn | |
| 3191 | 54 |
| 3457 | 55 ## Author: AW <Andreas.Weingessel@ci.tuwien.ac.at> |
|
9072
bd8e388043c4
Cleanup documentation for signal.texi, image.texi, audio.texi
Rik <rdrider0-list@yahoo.com>
parents:
8920
diff
changeset
|
56 ## Description: Short-Time Fourier Transform |
| 3191 | 57 |
|
14868
5d3a684236b0
maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
58 function [y, c] = stft (x, win_size, inc, num_coef, win_type) |
| 3426 | 59 |
| 8506 | 60 ## Default values of unspecified arguments. |
| 3191 | 61 if (nargin < 5) |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
62 win_type = 1; |
| 3191 | 63 if (nargin < 4) |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
64 num_coef = 64; |
| 3191 | 65 if (nargin < 3) |
| 3426 | 66 inc = 24; |
| 67 if (nargin < 2) | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
68 win_size = 80; |
| 3426 | 69 endif |
| 3191 | 70 endif |
| 71 endif | |
| 3426 | 72 elseif (nargin == 5) |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
73 if (ischar (win_type)) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
74 if (strcmp (win_type, "hanning")) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
75 win_type = 1; |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
76 elseif (strcmp (win_type, "hamming")) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
77 win_type = 2; |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
78 elseif (strcmp (win_type, "rectangle")) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
79 win_type = 3; |
| 3191 | 80 else |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
81 error ("stft: unknown window type `%s'", win_type); |
| 3191 | 82 endif |
| 83 endif | |
| 84 else | |
| 6046 | 85 print_usage (); |
| 3191 | 86 endif |
| 87 | |
| 8506 | 88 ## Check whether X is a vector. |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
89 [nr, nc] = size (x); |
| 3191 | 90 if (nc != 1) |
| 91 if (nr == 1) | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
92 x = x'; |
| 3191 | 93 nr = nc; |
| 94 else | |
| 3457 | 95 error ("stft: X must be a vector"); |
| 3191 | 96 endif |
| 97 endif | |
| 98 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
99 ncoef = 2 * num_coef; |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
100 if (win_size > ncoef) |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
101 win_size = ncoef; |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
102 printf ("stft: window size adjusted to %f\n", win_size); |
| 3191 | 103 endif |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
104 num_win = fix ((nr - win_size) / inc); |
| 3191 | 105 |
| 106 ## compute the window coefficients | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
107 if (win_type == 3) |
| 8506 | 108 ## Rectangular window. |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
109 win_coef = ones (win_size, 1); |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
110 elseif (win_type == 2) |
| 8506 | 111 ## Hamming window. |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
112 win_coef = hamming (win_size); |
| 8506 | 113 else |
| 114 ## Hanning window. | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
115 win_coef = hanning (win_size); |
| 3191 | 116 endif |
| 3426 | 117 |
| 8506 | 118 ## Create a matrix Z whose columns contain the windowed time-slices. |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
119 z = zeros (ncoef, num_win + 1); |
| 3191 | 120 start = 1; |
| 121 for i = 0:num_win | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
122 z(1:win_size, i+1) = x(start:start+win_size-1) .* win_coef; |
| 3191 | 123 start = start + inc; |
| 124 endfor | |
| 125 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
126 y = fft (z); |
| 3191 | 127 |
| 128 if (nargout == 1) | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
129 y = abs (y(1:num_coef, :)); |
| 3191 | 130 else |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10821
diff
changeset
|
131 c = [win_size, inc, win_type]; |
| 3191 | 132 endif |
| 133 | |
| 134 endfunction |