octave_packages/control-2.3.52/@lti/freqresp.m

   1 ## Copyright (C) 2009, 2010   Lukas F. Reichlin
   2 ##
   3 ## This file is part of LTI Syncope.
   4 ##
   5 ## LTI Syncope is free software: you can redistribute it and/or modify
   6 ## it under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation, either version 3 of the License, or
   8 ## (at your option) any later version.
   9 ##
  10 ## LTI Syncope is distributed in the hope that it will be useful,
  11 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 ## GNU General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with LTI Syncope.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 ## -*- texinfo -*-
  19 ## @deftypefn{Function File} {@var{H} =} freqresp (@var{sys}, @var{w})
  20 ## Evaluate frequency response at given frequencies.
  21 ##
  22 ## @strong{Inputs}
  23 ## @table @var
  24 ## @item sys
  25 ## LTI system.
  26 ## @item w
  27 ## Vector of frequency values.
  28 ## @end table
  29 ##
  30 ## @strong{Outputs}
  31 ## @table @var
  32 ## @item H
  33 ## Array of frequency response.  For a system with m inputs and p outputs, the array @var{H}
  34 ## has dimensions [p, m, length (w)].
  35 ## The frequency response at the frequency w(k) is given by H(:,:,k).
  36 ## @end table
  37 ##
  38 ## @seealso{dcgain}
  39 ## @end deftypefn
  40
  41 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  42 ## Created: October 2009
  43 ## Version: 0.2
  44
  45 function H = freqresp (sys, w)
  46
  47   if (nargin != 2)           # case freqresp () not possible
  48     print_usage ();
  49   endif
  50
  51   if (! is_real_vector (w))  # catches freqresp (sys, sys) and freqresp (w, sys) as well
  52     error ("freqresp: second argument must be a real vector");
  53   endif
  54
  55   H = __freqresp__ (sys, w);
  56
  57 endfunction