Mercurial > hg > octave-nkf
annotate scripts/signal/sinetone.m @ 11542:695141f1c05c ss-3-3-55
snapshot 3.3.55
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Sat, 15 Jan 2011 04:53:04 -0500 |
| parents | fd0a3ac60b0e |
| children | 72c96de7a403 |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 1995-2011 Friedrich Leisch |
| 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 -*- |
| 20 ## @deftypefn {Function File} {} sinetone (@var{freq}, @var{rate}, @var{sec}, @var{ampl}) | |
| 21 ## Return a sinetone of frequency @var{freq} with length of @var{sec} | |
| 22 ## seconds at sampling rate @var{rate} and with amplitude @var{ampl}. | |
| 23 ## The arguments @var{freq} and @var{ampl} may be vectors of common size. | |
| 3191 | 24 ## |
| 3449 | 25 ## Defaults are @var{rate} = 8000, @var{sec} = 1 and @var{ampl} = 64. |
| 26 ## @end deftypefn | |
| 3426 | 27 |
| 3457 | 28 ## Author: FL <Friedrich.Leisch@ci.tuwien.ac.at> |
| 29 ## Description: Compute a sine tone | |
| 3426 | 30 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
31 function retval = sinetone (freq, rate, sec, ampl) |
| 3426 | 32 |
| 3191 | 33 if (nargin == 1) |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
34 rate = 8000; |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
35 sec = 1; |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
36 ampl = 64; |
| 3191 | 37 elseif (nargin == 2) |
|
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 sec = 1; |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
39 ampl = 64; |
| 3191 | 40 elseif (nargin == 3) |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
41 ampl = 64; |
| 3191 | 42 elseif ((nargin < 1) || (nargin > 4)) |
| 6046 | 43 print_usage (); |
| 3191 | 44 endif |
| 3426 | 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 [err, freq, ampl] = common_size (freq, ampl); |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
47 if (err || ! isvector (freq)) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11469
diff
changeset
|
48 error ("sinetone: FREQ and AMPL must be vectors of common size"); |
| 3191 | 49 endif |
| 3426 | 50 |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
51 if (! (isscalar (rate) && isscalar (sec))) |
|
11472
1740012184f9
Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents:
11469
diff
changeset
|
52 error ("sinetone: RATE and SEC must be scalars"); |
| 3191 | 53 endif |
| 54 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
55 n = length (freq); |
|
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
56 ns = round (rate * sec); |
| 3191 | 57 |
| 7610 | 58 retval = zeros (ns, n); |
| 59 | |
| 3191 | 60 for k = 1:n |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
61 retval (:, k) = ampl(k) * sin (2 * pi * (1:ns) / rate * freq(k))'; |
| 3191 | 62 endfor |
| 3426 | 63 |
| 3191 | 64 endfunction |
| 65 | |
|
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
66 |
| 7610 | 67 %!assert (size (sinetone (18e6, 150e6, 19550/150e6, 1)), [19550, 1]); |