8000 Add eigensys_realization to __all__, change era to eigensys_realizati… · python-control/python-control@c5f0cbe · GitHub
[go: up one dir, main page]
Skip to content

Commit c5f0cbe

Browse files
KybernetikJoKybernetikJo
committed
Add eigensys_realization to __all__, change era to eigensys_realization in all files
1 parent bc21ec0 commit c5f0cbe

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

‎control/modelsimp.py‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
from .statefbk import gram
5151
from .timeresp import TimeResponseData
5252

53-
__all__ = ['hsvd', 'balred', 'modred', 'era', 'markov', 'minreal']
53+
__all__ = ['hsvd', 'balred', 'modred', 'eigensys_realization', 'markov', 'minreal','era']
5454

5555

5656
# Hankel Singular Value Decomposition
@@ -370,7 +370,7 @@ def minreal(sys, tol=None, verbose=True):
370370

371371

372372
def eigensys_realization(arg, r, m=None, n=None, dt=True, transpose=False):
373-
r"""era(YY, r)
373+
r"""eigensys_realization(YY, r)
374374
375375
Calculate an ERA model of order `r` based on the impulse-response data
376376
`YY`.
@@ -386,8 +386,8 @@ def eigensys_realization(arg, r, m=None, n=None, dt=True, transpose=False):
386386
387387
The function can be called with 2 arguments:
388388
389-
* ``sysd, S = era(data, r)``
390-
* ``sysd, S = era(YY, r)``
389+
* ``sysd, S = eigensys_realization(data, r)``
390+
* ``sysd, S = eigensys_realization(YY, r)``
391391
392392
where `response` is an `TimeResponseData` object, and `YY` is 1D or 3D
393393
array and r is an integer.
@@ -433,11 +433,11 @@ def eigensys_realization(arg, r, m=None, n=None, dt=True, transpose=False):
433433
--------
434434
>>> T = np.linspace(0, 10, 100)
435435
>>> _, YY = ct.impulse_response(ct.tf([1], [1, 0.5], True), T)
436-
>>> sysd, _ = ct.era(YY, r=1)
436+
>>> sysd, _ = ct.eigensys_realization(YY, r=1)
437437
438438
>>> T = np.linspace(0, 10, 100)
439439
>>> response = ct.impulse_response(ct.tf([1], [1, 0.5], True), T)
440-
>>> sysd, _ = ct.era(response, r=1)
440+
>>> sysd, _ = ct.eigensys_realization(response, r=1)
441441
"""
442442
def block_hankel_matrix(Y, m, n):
443443
"""Create a block hankel matrix from Impulse response"""

‎control/tests/modelsimp_test.py‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from control import StateSpace, impulse_response, step_response, forced_response, tf, rss, c2d
1111
from control.exception import ControlMIMONotImplemented
1212
from control.tests.conftest import slycotonly
13-
from control.modelsimp import balred, hsvd, markov, modred, era
13+
from control.modelsimp import balred, hsvd, markov, modred, eigensys_realization
1414

1515

1616
class TestModelsimp:
@@ -129,15 +129,15 @@ def testERASignature(self):
129129
ir_true = impulse_response(sysd_true,T=T)
130130

131131
# test TimeResponseData
132-
sysd_est, _ = era(ir_true,r=2)
132+
sysd_est, _ = eigensys_realization(ir_true,r=2)
133133
ir_est = impulse_response(sysd_est, T=T)
134134
_, H_est = ir_est
135135

136136
np.testing.assert_allclose(H_true, H_est, rtol=1e-6, atol=1e-8)
137137

138138
# test ndarray
139139
_, YY_true = ir_true
140-
sysd_est, _ = era(YY_true,r=2)
140+
sysd_est, _ = eigensys_realization(YY_true,r=2)
141141
ir_est = impulse_response(sysd_est, T=T)
142142
_, H_est = ir_est
143143

@@ -169,7 +169,7 @@ def testERASignature(self):
169169
ir_true = impulse_response(sysd_true, T=T)
170170

171171
# test TimeResponseData
172-
sysd_est, _ = era(ir_true,r=4,dt=dt)
172+
sysd_est, _ = eigensys_realization(ir_true,r=4,dt=dt)
173173

174174
step_true = step_response(s 8000 ysd_true)
175175
step_est = step_response(sysd_est)
@@ -180,7 +180,7 @@ def testERASignature(self):
180180

181181
# test ndarray
182182
_, YY_true = ir_true
183-
sysd_est, _ = era(YY_true,r=4,dt=dt)
183+
sysd_est, _ = eigensys_realization(YY_true,r=4,dt=dt)
184184

185185
step_true = step_response(sysd_true, T=T)
186186
step_est = step_response(sysd_est, T=T)

‎examples/era_msd.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
response.plot()
4848
plt.show()
4949

50-
sysd_est, _ = ct.era(response,r=4,dt=dt)
50+
sysd_est, _ = ct.eigensys_realization(response,r=4,dt=dt)
5151

5252
step_true = ct.step_response(sysd)
5353
step_true.sysname="H_true"

0 commit comments

Comments
 (0)
0