8000 add documentation on system class structure · python-control/python-control@dc5a392 · GitHub
[go: up one dir, main page]
Skip to content

Commit dc5a392

Browse files
murrayrmmurrayrm
committed
add documentation on system class structure
1 parent e2f76df commit dc5a392

File tree

5 files changed

+154
-7
lines changed

5 files changed

+154
-7
lines changed

‎doc/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.fig.bak

‎doc/Makefile‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ help:
1414

1515
.PHONY: help Makefile
1616

17+
# Rules to create figures
18+
FIGS = classes.pdf
19+
classes.pdf: classes.fig; fig2dev -Lpdf $< $@
20+
1721
# Catch-all target: route all unknown targets to Sphinx using the new
1822
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19-
%: Makefile
20-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
23+
html pdf: Makefile $(FIGS)
24+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎doc/classes.fig‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
#FIG 3.2 Produced by xfig version 3.2.8b
2+
Landscape
3+
Center
4+
Inches
5+
Letter
6+
100.00
7+
Single
8+
-2
9+
1200 2
10+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
11+
5400 3375 6600 3375 6600 3825 5400 3825 5400 3375
12+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
13+
6900 2175 8100 2175 8100 2625 6900 2625 6900 2175
14+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
15+
7275 3375 8925 3375 8925 3825 7275 3825 7275 3375
16+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
17+
9750 3375 12075 3375 12075 4725 9750 4725 9750 3375
18+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
19+
9750 6000 12075 6000 12075 7350 9750 7350 9750 6000
20+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
21+
4425 975 6525 975 6525 1425 4425 1425 4425 975
22+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
23+
7875 2550 10875 3450
24+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
25+
5850 6075 5850 6975
26+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
27+
4350 6075 5625 6975
28+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
29+
5925 3750 5925 5775
30+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 0 2
31+
1 1 1.00 60.00 120.00
32+
8925 3600 9750 3600
33+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 0 2
34+
1 1 1.00 60.00 120.00
35+
10875 3750 10875 4350
36+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 0 2
37+
1 1 1.00 60.00 120.00
38+
6375 3750 9975 6150
39+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 0 2
40+
1 1 1.00 60.00 120.00
41+
10875 6375 10875 6975
42+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 0 2
43+
1 1 1.00 60.00 120.00
44+
6750 6225 9975 6225
45+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 0 2
46+
1 1 1.00 60.00 120.00
47+
6000 6075 6000 6975
48+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 0 2
49+
1 1 1.00 60.00 120.00
50+
2700 5400 3075 5850
51+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
52+
4125 4875 5400 5775
53+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
54+
1650 4500 6750 4500 6750 7425 1650 7425 1650 4500
55+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
56+
1650 7950 6150 7950 6150 8550 1650 8550 1650 7950
57+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 -1 0 0 2
58+
2400 5400 2400 8025
59+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
60+
5250 1350 3825 4575
61+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
62+
3300 4875 3000 5100
63+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 0 2
64+
1 1 1.00 60.00 120.00
65+
4350 4875 5625 5775
66+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 -1 1 0 2
67+
1 1 1.00 60.00 120.00
68+
2775 8175 4200 8175
69+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
70+
7575 2550 8025 3450
71+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 -1 0 0 2
72+
9075 7800 9675 7800
73+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 -1 1 0 2
74+
1 1 1.00 60.00 120.00
75+
9075 8100 9675 8100
76+
2 2 1 1 0 7 50 -1 -1 4.000 0 0 -1 0 0 5
77+
9075 8250 9675 8250 9675 8550 9075 8550 9075 8250
78+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 0 1 2
79+
1 1 1.00 60.00 120.00
80+
4725 5925 5175 5925
81+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
82+
7350 2550 6225 3450
83+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
84+
5775 1350 7575 2250
85+
2 1 0 2 4 7 50 -1 -1 0.000 0 0 7 1 1 2
86+
1 1 1.00 60.00 120.00
87+
1 1 1.00 60.00 120.00
88+
6525 3600 7275 3600
89+
2 1 0 2 1 7 50 -1 -1 0.000 0 0 7 0 0 2
90+
3825 4875 3825 5775
91+
4 0 0 50 -1 0 12 0.0000 4 165 885 5400 3300 statesp.py\001
92+
4 0 0 50 -1 0 12 0.0000 4 195 420 8175 2325 lti.py\001
93+
4 2 0 50 -1 0 12 0.0000 4 195 885 8925 3300 xferfcn.py\001
94+
4 2 0 50 -1 0 12 0.0000 4 195 780 12075 3300 frdata.py\001
95+
4 2 0 50 -1 0 12 0.0000 4 195 780 12075 5925 trdata.py\001
96+
4 1 1 50 -1 0 12 0.0000 4 150 345 7575 2475 LTI\001
97+
4 1 1 50 -1 0 12 0.0000 4 195 1440 5925 6000 LinearIOSystem\001
98+
4 0 0 50 -1 0 12 0.0000 4 195 615 1650 7875 flatsys/\001
99+
4 0 0 50 -1 0 12 0.0000 4 195 705 1650 4425 iosys.py\001
100+
4 0 0 50 -1 0 12 0.0000 4 195 720 8700 7575 Legend:\001
101+
4 1 1 50 -1 16 12 0.0000 4 210 1590 5475 1275 NamedIOSystem\001
102+
4 1 1 50 -1 16 12 0.0000 4 210 1770 3975 4800 InputOutputSystem\001
103+
4 1 1 50 -1 16 12 0.0000 4 210 1830 2625 5325 NonlinearIOSystem\001
104+
4 0 0 50 -1 0 12 0.0000 4 195 1005 6600 1125 namedio.py\001
105+
4 0 4 50 -1 16 12 0.0000 4 210 945 4800 5100 linearize()\001
106+
4 1 1 50 -1 16 12 0.0000 4 210 2115 3750 6000 InterconnectedSystem\001
107+
4 0 4 50 -1 16 12 0.0000 4 210 1875 3000 6750 ic() = interconnect()\001
108+
4 1 1 50 -1 16 12 0.0000 4 210 1500 5925 7200 LinearICSystem\001
109+
4 1 1 50 -1 16 12 0.0000 4 210 1035 2250 8250 FlatSystem\001
110+
4 1 4 50 -1 16 12 0.0000 4 210 1500 3525 8400 point_to_point()\001
111+
4 1 1 50 -1 16 12 0.0000 4 210 1095 6000 3675 StateSpace\001
112+
4 1 1 50 -1 16 12 0.0000 4 165 1605 8100 3675 TransferFunction\001
113+
4 1 1 50 -1 16 12 0.0000 4 210 2400 10875 3675 FrequencyResponseData\001
114+
4 0 4 50 -1 16 12 0.0000 4 210 1155 10950 4050 to_pandas()\001
115+
4 1 1 50 -1 16 12 0.0000 4 210 1800 10875 4575 pandas.DataFrame\001
116+
4 0 4 50 -1 16 12 0.0000 4 210 1560 7950 4725 step_response()\001
117+
4 0 4 50 -1 16 12 0.0000 4 210 1635 8400 5025 initial_response()\001
118+
4 0 4 50 -1 16 12 0.0000 4 210 1755 8850 5325 forced_response()\001
119+
4 1 1 50 -1 16 12 0.0000 4 210 1875 10875 6300 TimeResponseData\001
120+
4 0 4 50 -1 16 12 0.0000 4 210 1155 10950 6675 to_pandas()\001
121+
4 1 1 50 -1 16 12 0.0000 4 210 1800 10875 7200 pandas.DataFrame\001
122+
4 1 4 50 -1 16 12 0.0000 4 210 2295 8325 6450 input_output_response()\001
123+
4 0 1 50 -1 16 12 0.0000 4 210 1755 9750 7875 Class dependency\001
124+
4 0 4 50 -1 16 12 0.0000 4 210 2475 9750 8175 Conversion [via function()]\001
125+
4 0 0 50 -1 0 12 0.0000 4 150 1380 9750 8475 Source code file\001
126+
4 1 4 50 -1 16 12 0.0000 4 210 300 3150 5625 ic()\001
127+
4 0 4 50 -1 16 12 0.0000 4 210 300 6075 6600 ic()\001
128+
4 1 1 50 -1 16 12 0.0000 4 210 1650 4950 8250 SystemTrajectory\001
129+
4 1 4 50 -1 16 12 0.0000 4 210 945 9375 3825 freqresp()\001
130+
4 1 4 50 -1 16 12 0.0000 4 210 600 6975 3825 tf2ss()\001
131+
4 1 4 50 -1 16 12 0.0000 4 210 600 6975 3450 ss2tf()\001
132+
4 1 4 50 -1 16 12 0.0000 4 210 300 5025 6150 ic()\001

‎doc/classes.pdf‎

11.8 KB
Binary file not shown.

‎doc/classes.rst‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,30 @@
55
Control system classes
66
**********************
77

8-
The classes listed below are used to represent models of linear time-invariant
9-
(LTI) systems. They are usually created from factory functions such as
10-
:func:`tf` and :func:`ss`, so the user should normally not need to instantiate
11-
these directly.
8+
The classes listed below are used to represent models of input/output
9+
systems (both linear time-invariant and nonlinear). They are usually
10+
created from factory functions such as :func:`tf` and :func:`ss`, so the
11+
user should normally not need to instantiate these directly.
1212

1313
.. autosummary::
1414
:toctree: generated/
1515
:template: custom-class-template.rst
1616

17-
TransferFunction
1817
StateSpace
18+
TransferFunction
19+
InputOutputSystem
1920
FrequencyResponseData
2021
TimeResponseData
2122

23+
The following figure illustrates the relationship between the classes and
24+
some of the functions that can be used to convert objects from one class to
25+
another:
26+
27+
.. image:: classes.pdf
28+
:width: 800
29+
30+
|
31+
2232
Input/output system subclasses
2333
==============================
2434
Input/output systems are accessed primarily via a set of subclasses

0 commit comments

Comments
 (0)
0