octave_packages/signal-1.1.3/rectpuls.m

   1 ## Copyright (C) 2000 Paul Kienzle <pkienzle@users.sf.net>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## usage: y = rectpuls(t, w)
  17 ##
  18 ## Generate a rectangular pulse over the interval [-w/2,w/2), sampled at
  19 ## times t.  This is useful with the function pulstran for generating a
  20 ## series pulses.
  21 ##
  22 ## Example
  23 ##   fs = 11025;  # arbitrary sample rate
  24 ##   f0 = 100;    # pulse train sample rate
  25 ##   w = 0.3/f0;  # pulse width 3/10th the distance between pulses
  26 ##   auplot(pulstran(0:1/fs:4/f0, 0:1/f0:4/f0, 'rectpuls', w), fs);
  27 ##
  28 ## See also: pulstran
  29
  30 function y = rectpuls(t, w = 1)
  31
  32   if nargin<1 || nargin>2,
  33     print_usage;
  34   endif
  35
  36   y = zeros(size(t));
  37   idx = find(t>=-w/2 & t < w/2);
  38   try wfi = warning("off", "Octave:fortran-indexing");
  39   catch wfi = 0;
  40   end
  41   unwind_protect
  42     y(idx) = ones(size(idx));
  43   unwind_protect_cleanup
  44     warning(wfi);
  45   end_unwind_protect
  46 endfunction
  47
  48 %!assert(rectpuls(0:1/100:0.3,.1), rectpuls([0:1/100:0.3]',.1)');
  49 %!assert(isempty(rectpuls([],.1)));
  50 %!demo
  51 %! fs = 11025;  # arbitrary sample rate
  52 %! f0 = 100;    # pulse train sample rate
  53 %! w = 0.3/f0;  # pulse width 1/10th the distance between pulses
  54 %! ylabel("amplitude"); xlabel("time (ms)");
  55 %! title("graph shows 3 ms pulses at 0,10,20,30 and 40 ms");
  56 %! auplot(pulstran(0:1/fs:4/f0, 0:1/f0:4/f0, 'rectpuls', w), fs);
  57 %! title(""); xlabel(""); ylabel("");