10000 DOC: update timebase explanations (#203) · uLipe/python-control@1039edd · GitHub
[go: up one dir, main page]

Skip to content

Commit 1039edd

Browse files
committed
DOC: update timebase explanations (python-control#203)
1 parent 4173dd5 commit 1039edd

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

control/freqplot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def bode_plot(syslist, omega=None, dB=None, Hz=None, deg=None,
106106
2. If a discrete time model is given, the frequency response is plotted
107107
along the upper branch of the unit circle, using the mapping z = exp(j
108108
\omega dt) where omega ranges from 0 to pi/dt and dt is the discrete
109-
time base. If not timebase is specified (dt = True), dt is set to 1.
109+
timebase. If not timebase is specified (dt = True), dt is set to 1.
110110
111111
Examples
112112
--------

doc/conventions.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,8 @@ performed.
7777

7878
Discrete time systems
7979
---------------------
80-
By default, all systems are considered to be continuous time systems. A
81-
discrete time system is created by specifying the 'time base' dt. The time
82-
base argument can be given when a system is constructed:
80+
A discrete time system is created by specifying a nonzero 'timebase', dt.
81+
The timebase argument can be given when a system is constructed:
8382

8483
* dt = None: no timebase specified
8584
* dt = 0: continuous time system
@@ -89,11 +88,16 @@ base argument can be given when a system is constructed:
8988
Only the :class:`StateSpace` and :class:`TransferFunction` classes allow
9089
explicit representation of discrete time systems.
9190

92-
Systems must have the same time base in order to be combined. For
93-
continuous time systems, the :func:`sample_system` function or the
94-
:meth:`StateSpace.sample` and :meth:`TransferFunction.sample` methods can be
95-
used to create a discrete time system from a continuous time system. See
96-
:ref:`utility-and-conversions`.
91+
Systems must have compatible timebases in order to be combined. A system
92+
with timebase `None` can be combined with a system having a specified
93+
timebase, and the result will have the timebase of the latter system.
94+
Similarly, a discrete time system with unspecified sampling time (`dt =
95+
True`) can be combined with a system having a specified sampling time, and
96+
the result will be a discrete time system with the sample time of the latter
97+
system. For continuous time systems, the :func:`sample_system` function or
98+
the :meth:`StateSpace.sample` and :meth:`TransferFunction.sample` methods
99+
can be used to create a discrete time system from a continuous time system.
100+
See :ref:`utility-and-conversions`.
97101

98102
Conversion between representations
99103
----------------------------------

0 commit comments

Comments
 (0)
0