annotate scripts/control/base/pzmap.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 2110cc251779
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1996, 1998 Auburn University. All rights reserved.
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
2 ##
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
4 ##
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
8 ## your option) any later version.
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
9 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
13 ## General Public License for more details.
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
14 ##
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6448
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
18
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
20 ## @deftypefn {Function File} {[@var{zer}, @var{pol}] =} pzmap (@var{sys})
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
21 ## Plots the zeros and poles of a system in the complex plane.
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
22 ##
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
23 ## @strong{Input}
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
24 ## @table @var
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
25 ## @item sys
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
26 ## System data structure.
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
27 ## @end table
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
28 ##
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
29 ## @strong{Outputs}
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
30 ## @table @var
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
31 ## @item pol
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
32 ## @item zer
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
33 ## if omitted, the poles and zeros are plotted on the screen.
5016
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
34 ## otherwise, @var{pol} and @var{zer} are returned as the
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
35 ## system poles and zeros (see @command{sys2zp} for a preferable function call).
bdbee5282954 [project @ 2004-09-22 02:50:35 by jwe]
jwe
parents: 4460
diff changeset
36 ## @end table
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
37 ## @end deftypefn
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
38
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
39 function [zer, pol] = pzmap (sys)
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
40
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
41 if (nargin != 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5568
diff changeset
42 print_usage ();
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
43 elseif (! isstruct (sys));
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
44 error ("pzmap: sys must be in system format");
5568
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
45 endif
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
46
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
47 [zer, pol] = sys2zp (sys);
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
48
5568
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
49 ## force to column vectors, split into real, imaginary parts
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
50 zerdata = poldata = [];
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
51 if (length (zer))
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
52 zer = reshape (zer, length (zer), 1);
5568
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
53 zerdata = [real(zer(:,1)), imag(zer(:,1))];
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
54 endif
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
55 if (length (pol))
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
56 pol = reshape (pol, length (pol), 1);
5568
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
57 poldata = [real(pol(:,1)), imag(pol(:,1))];
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
58 endif
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
59
5568
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
60 ## determine continuous or discrete plane
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
61 vars = "sz";
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
62 varstr = vars(is_digital (sys) + 1);
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
63
5568
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
64 ## Plot the data
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
65
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
66 if (length (zer) == 0)
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
67 plot (poldata(:,1), poldata(:,2), "@12 ;poles (no zeros);");
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
68 elseif (length (pol) == 0)
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
69 plot (zerdata(:,1), zerdata(:,2), "@31 ;zeros (no poles);");
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
70 else
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
71 plot (zerdata(:,1), zerdata(:,2), "@31 ;zeros;",
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
72 poldata(:,1), poldata(:,2), "@12 ;poles;");
5568
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
73 endif
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
74
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
75 if (is_siso (sys))
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
76 title (sprintf ("Pole-zero map from %s to %s",
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
77 sysgetsignals (sys, "in", 1, 1),
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
78 sysgetsignals (sys, "out", 1, 1)));
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
79 endif
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
80
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
81 xlabel (sprintf ("Re(%s)", varstr));
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
82 ylabel (sprintf ("Im(%s)", varstr));
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
83 grid ("on");
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
84
5568
e9cde940b271 [project @ 2005-12-08 02:28:22 by jwe]
jwe
parents: 5307
diff changeset
85 ## compute axis limits
6448
2110cc251779 [project @ 2007-03-24 02:47:36 by jwe]
jwe
parents: 6046
diff changeset
86 axis (axis2dlim ([zerdata; poldata]));
3432
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
87
e39d90787668 [project @ 2000-01-14 04:22:59 by jwe]
jwe
parents:
diff changeset
88 endfunction