octave_packages/control-2.3.52/pzmap.m

   1 ## Copyright (C) 2009   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} pzmap (@var{sys})
  20 ## @deftypefnx {Function File} {[@var{p}, @var{z}] =} pzmap (@var{sys})
  21 ## Plot the poles and zeros of an LTI system in the complex plane.
  22 ## If no output arguments are given, the result is plotted on the screen.
  23 ## Otherwise, the poles and zeros are computed and returned.
  24 ##
  25 ## @strong{Inputs}
  26 ## @table @var
  27 ## @item sys
  28 ## LTI model.
  29 ## @end table
  30 ##
  31 ## @strong{Outputs}
  32 ## @table @var
  33 ## @item p
  34 ## Poles of @var{sys}.
  35 ## @item z
  36 ## Transmission zeros of @var{sys}.
  37 ## @end table
  38 ## @end deftypefn
  39
  40 ## Author: Lukas Reichlin <lukas.reichlin@gmail.com>
  41 ## Created: November 2009
  42 ## Version: 0.1
  43
  44 function [pol_r, zer_r] = pzmap (sys)
  45
  46   ## TODO: multiplot feature:   pzmap (sys1, "b", sys2, "r", ...)
  47
  48   if (nargin != 1)
  49     print_usage ();
  50   endif
  51
  52   if (! isa (sys, "lti"))
  53     error ("pzmap: argument must be an LTI system");
  54   endif
  55
  56   pol = pole (sys);
  57   zer = zero (sys);
  58
  59   if (! nargout)
  60     pol_re = real (pol);
  61     pol_im = imag (pol);
  62     zer_re = real (zer);
  63     zer_im = imag (zer);
  64
  65     plot (pol_re, pol_im, "xb", zer_re, zer_im, "or")
  66     grid ("on")
  67     title (["Pole-Zero Map of ", inputname(1)])
  68     xlabel ("Real Axis")
  69     ylabel ("Imaginary Axis")
  70   else
  71     pol_r = pol;
  72     zer_r = zer;
  73   endif
  74
  75 endfunction