annotate scripts/control/system/sysout.m @ 7156:77de8319c337 ss-2-9-17

[project @ 2007-11-10 06:16:59 by jwe]
author jwe
date Sat, 10 Nov 2007 06:17:00 +0000
parents 8aa770b6c5bf
children 5545c1ae9a83
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 1996, 2000, 2002, 2005, 2006, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
2 ## Auburn University. All rights reserved.
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
3 ##
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
5 ##
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
6 ## 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: 6046
diff changeset
7 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
9 ## your option) any later version.
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
10 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
14 ## General Public License for more details.
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
15 ##
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
16 ## 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: 6046
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
18 ## <http://www.gnu.org/licenses/>.
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
19
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
3500
7923abdeb4e5 [project @ 2000-01-31 06:35:00 by jwe]
jwe
parents: 3439
diff changeset
21 ## @deftypefn {Function File} {} sysout (@var{sys}, @var{opt})
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
22 ## print out a system data structure in desired format
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
23 ## @table @var
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
24 ## @item sys
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
25 ## system data structure
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
26 ## @item opt
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
27 ## Display option
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
28 ## @table @code
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
29 ## @item []
3439
3234a698073a [project @ 2000-01-14 09:51:14 by jwe]
jwe
parents: 3438
diff changeset
30 ## primary system form (default)
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
31 ## @item "ss"
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
32 ## state space form
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
33 ## @item "tf"
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
34 ## transfer function form
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
35 ## @item "zp"
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
36 ## zero-pole form
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
37 ## @item "all"
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
38 ## all of the above
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
39 ## @end table
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
40 ## @end table
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
41 ## @end deftypefn
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
42
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
43 ## Author: A. S. Hodel <a.s.hodel@eng.auburn.edu>
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
44 ## Created: 1995-1996
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
45
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
46 function retsys = sysout (sys, opt)
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
47
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
48 if (nargin < 1 || nargin > 2)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5307
diff changeset
49 print_usage ();
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
50 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
51
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
52 if (isempty (sys))
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
53 retsys = sys;
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
54 error ("sysout: empty system")
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
55 return;
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
56 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
57
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
58 if (! isstruct (sys))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
59 error ("sysout: input must be a system structure")
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
60 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
61
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
62 ## set up output type array
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
63 if (nargin == 1)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
64 opt = sysgettype (sys);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
65 elseif (! (strcmp (opt, "ss") || strcmp (opt, "tf")
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
66 || strcmp (opt, "zp") || strcmp (opt, "all")))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
67 error ("opt must be one of [], \"ss\", \"tf\", \"zp\", or \"all\"");
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
68 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
69
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
70 ## now check output for each form:
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
71 [nn, nz, mm, pp] = sysdimensions(sys);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
72 if (mm > 0)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
73 disp ("Input(s)")
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
74 disp (__outlist__ (sysgetsignals (sys, "in"), " "));
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
75 else
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
76 disp ("Input(s): none");
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
77 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
78 if (pp > 0)
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
79 disp ("Output(s):")
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
80 disp (__outlist__ (sysgetsignals (sys, "out"),
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
81 " ", sysgetsignals (sys, "yd")) );
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
82 else
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
83 disp ("Output(s): none");
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
84 endif
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
85 if (sysgettsam (sys) > 0)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
86 disp ("Sampling interval: %g", sysgettsam (sys));
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
87 str = "z";
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
88 else
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
89 str = "s";
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
90 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
91
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
92 ## transfer function form
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
93 if (strcmp (opt, "tf") || strcmp (opt, "all"))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
94 sys = sysupdate (sys, "tf"); #make sure tf is up to date
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
95 disp ("transfer function form:")
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
96 [num, den] = sys2tf (sys);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
97 tfout (num, den, str);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
98 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
99
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
100 if (strcmp(opt, "zp") || strcmp(opt, "all"))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
101 sys = sysupdate (sys, "zp"); #make sure zp is up to date
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
102 disp("zero-pole form:")
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
103 [zer, pol, kk] = sys2zp (sys);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
104 zpout (zer, pol, kk, str)
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
105 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
106
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
107 if (strcmp(opt, "ss") || strcmp(opt, "all"))
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
108 sys = sysupdate (sys, "ss");
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
109 disp ("state-space form:");
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
110 disp ("%d continuous states, %d discrete states", nn, nz);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
111 if (nn+nz > 0)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
112 disp ("State(s):")
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
113 xi = (nn+1):(nn+nz);
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
114 xd = zeros (1, nn+nz);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
115 if (! isempty (xi))
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
116 xd(xi) = 1;
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
117 endif
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
118 disp (__outlist__ (sysgetsignals (sys, "st"), " ", xd));
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
119 else
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
120 disp ("State(s): none");
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
121 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
122
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
123 ## display matrix values?
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
124 dmat = (max ([nn+nz, mm, pp]) <= 32);
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
125
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
126 printf ("A matrix: %d x %d\n", sysdimensions (sys, "st"),
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
127 sysdimensions (sys, "st"));
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
128 [aa, bb, cc, dd] = sys2ss (sys);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
129 if (dmat)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
130 disp (aa);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
131 endif
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
132
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
133 printf ("B matrix: %d x %d\n", sysdimensions (sys, "st"),
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
134 sysdimensions (sys, "in"));
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
135 if (dmat)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
136 disp (bb);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
137 endif
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
138
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
139 printf ("C matrix: %d x %d\n", sysdimensions (sys, "out"),
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
140 sysdimensions (sys, "st"));
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
141 if (dmat)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
142 disp (cc);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
143 endif
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
144
7135
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
145 printf("D matrix: %d x %d\n", sysdimensions (sys, "out"),
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
146 sysdimensions (sys, "in"));
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
147 if (dmat)
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
148 disp (dd);
8aa770b6c5bf [project @ 2007-11-08 18:54:10 by jwe]
jwe
parents: 7133
diff changeset
149 endif
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
150 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
151
7133
1d0d7be2d0f8 [project @ 2007-11-08 16:25:44 by jwe]
jwe
parents: 7017
diff changeset
152 if (nargout >= 1)
3430
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
153 retsys = sys;
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
154 endif
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
155
65b3519ac3a1 [project @ 2000-01-14 03:44:03 by jwe]
jwe
parents:
diff changeset
156 endfunction