File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -9,7 +9,7 @@ The classes listed below are used to represent models of input/output
99systems (both linear time-invariant and nonlinear). They are usually
1010created from factory functions such as :func: `tf ` and :func: `ss `, so the
1111user should normally not need to instantiate these directly.
12-
12+
1313.. autosummary ::
1414 :toctree: generated/
1515 :template: custom-class-template.rst
@@ -32,21 +32,34 @@ another:
3232
3333Additional classes
3434==================
35+
36+ .. todo :: Break these up into more useful sections
37+
3538.. autosummary ::
39+ :toctree: generated/
3640 :template: custom-class-template.rst
3741 :nosignatures:
3842
43+ ControlPlot
3944 DescribingFunctionNonlinearity
4045 DescribingFunctionResponse
4146 flatsys.BasisFamily
47+ flatsys.BezierFamily
48+ flatsys.BSplineFamily
4249 flatsys.FlatSystem
4350 flatsys.LinearFlatSystem
4451 flatsys.PolyFamily
4552 flatsys.SystemTrajectory
53+ FrequencyResponseList
54+ NyquistResponseData
55+ OperatingPoint
4656 optimal.OptimalControlProblem
4757 optimal.OptimalControlResult
4858 optimal.OptimalEstimationProblem
4959 optimal.OptimalEstimationResult
60+ PoleZeroData
61+ TimeResponseData
62+ TimeResponseList
5063
5164The use of these classes is described in more detail in the
5265:ref: `flatsys-module ` module and the :ref: `optimal-module ` module
Original file line number Diff line number Diff line change @@ -75,6 +75,15 @@ Time domain simulation
7575 phase_plane_plot
7676 step_response
7777 time_response_plot
78+ combine_time_responses
79+ phaseplot.boxgrid
80+ phaseplot.circlegrid
81+ phaseplot.equilpoints
82+ phaseplot.meshgrid
83+ phaseplot.separatrices
84+ phaseplot.streamlines
85+ phaseplot.vectorfield
86+
7887
7988Frequency response
8089==================
@@ -84,8 +93,11 @@ Frequency response
8493
8594 bode_plot
8695 describing_function_plot
96+ describing_function_response
8797 frequency_response
98+ nyquist_response
8899 nyquist_plot
100+ gangof4_response
89101 gangof4_plot
90102 nichols_plot
91103 nichols_grid
@@ -110,8 +122,13 @@ Control system analysis
110122 phase_crossover_frequencies
111123 poles
112124 zeros
113- pzmap
114- root_locus
125+ pole_zero_map
126+ pole_zero_plot
127+ pole_zero_subplots
128+ root_locus_map
129+ root_locus_plot
130+ singular_values_plot
131+ singular_values_response
115132 sisotool
116133 StateSpace.__call__
117134 TransferFunction.__call__
@@ -233,6 +250,7 @@ Utility functions
233250 issiso
234251 mag2db
235252 reset_defaults
253+ reset_rcParams
236254 sample_system
237255 set_defaults
238256 ssdata
Original file line number Diff line number Diff line change 4242
4343# Functons that we can skip
4444object_skiplist = [
45- control .NamedSignal , # users don't need to know about this
45+ control .NamedSignal , # np.ndarray members cause errors
4646 control .common_timebase , # mainly internal use
4747 control .cvxopt_check , # mainly internal use
4848 control .pandas_check , # mainly internal use
You can’t perform that action at this time.
0 commit comments