Add eigensys_realization to __all__, change era to eigensys_realization in all files

KybernetikJo · KybernetikJo · commit c5f0cbe629b1 · 2024-07-11T12:57:13.000+02:00
diff --git a/control/modelsimp.py b/control/modelsimp.py
@@ -50,7 +50,7 @@
 from .statefbk import gram
 from .timeresp import TimeResponseData
 
-__all__ = ['hsvd', 'balred', 'modred', 'era', 'markov', 'minreal']
+__all__ = ['hsvd', 'balred', 'modred', 'eigensys_realization', 'markov', 'minreal','era']
 
 
 # Hankel Singular Value Decomposition
@@ -370,7 +370,7 @@ def minreal(sys, tol=None, verbose=True):
 
 
 def eigensys_realization(arg, r, m=None, n=None, dt=True, transpose=False):
-    r"""era(YY, r)
+    r"""eigensys_realization(YY, r)
 
     Calculate an ERA model of order `r` based on the impulse-response data
     `YY`.
@@ -386,8 +386,8 @@ def eigensys_realization(arg, r, m=None, n=None, dt=True, transpose=False):
 
     The function can be called with 2 arguments:
 
-    * ``sysd, S = era(data, r)``
-    * ``sysd, S = era(YY, r)``
+    * ``sysd, S = eigensys_realization(data, r)``
+    * ``sysd, S = eigensys_realization(YY, r)``
 
     where `response` is an `TimeResponseData` object, and `YY` is 1D or 3D
     array and r is an integer.
@@ -433,11 +433,11 @@ def eigensys_realization(arg, r, m=None, n=None, dt=True, transpose=False):
     --------
     >>> T = np.linspace(0, 10, 100)
     >>> _, YY = ct.impulse_response(ct.tf([1], [1, 0.5], True), T)
-    >>> sysd, _ = ct.era(YY, r=1)
+    >>> sysd, _ = ct.eigensys_realization(YY, r=1)
 
     >>> T = np.linspace(0, 10, 100)
     >>> response = ct.impulse_response(ct.tf([1], [1, 0.5], True), T)
-    >>> sysd, _ = ct.era(response, r=1)
+    >>> sysd, _ = ct.eigensys_realization(response, r=1)
     """
     def block_hankel_matrix(Y, m, n):
         """Create a block hankel matrix from Impulse response"""
diff --git a/control/tests/modelsimp_test.py b/control/tests/modelsimp_test.py
@@ -10,7 +10,7 @@
 from control import StateSpace, impulse_response, step_response, forced_response, tf, rss, c2d
 from control.exception import ControlMIMONotImplemented
 from control.tests.conftest import slycotonly
-from control.modelsimp import balred, hsvd, markov, modred, era
+from control.modelsimp import balred, hsvd, markov, modred, eigensys_realization
 
 
 class TestModelsimp:
@@ -129,15 +129,15 @@ def testERASignature(self):
         ir_true = impulse_response(sysd_true,T=T)
 
         # test TimeResponseData
-        sysd_est, _  = era(ir_true,r=2)
+        sysd_est, _  = eigensys_realization(ir_true,r=2)
         ir_est = impulse_response(sysd_est, T=T)
         _, H_est = ir_est
     
         np.testing.assert_allclose(H_true, H_est, rtol=1e-6, atol=1e-8)
 
         # test ndarray
         _, YY_true = ir_true
-        sysd_est, _  = era(YY_true,r=2)
+        sysd_est, _  = eigensys_realization(YY_true,r=2)
         ir_est = impulse_response(sysd_est, T=T)
         _, H_est = ir_est
     
@@ -169,7 +169,7 @@ def testERASignature(self):
         ir_true = impulse_response(sysd_true, T=T)
 
         # test TimeResponseData
-        sysd_est, _ = era(ir_true,r=4,dt=dt)
+        sysd_est, _ = eigensys_realization(ir_true,r=4,dt=dt)
 
         step_true = step_response(sysd_true)
         step_est = step_response(sysd_est)
@@ -180,7 +180,7 @@ def testERASignature(self):
         
         # test ndarray
         _, YY_true = ir_true
-        sysd_est, _  = era(YY_true,r=4,dt=dt)
+        sysd_est, _  = eigensys_realization(YY_true,r=4,dt=dt)
 
         step_true = step_response(sysd_true, T=T)
         step_est = step_response(sysd_est, T=T)
diff --git a/examples/era_msd.py b/examples/era_msd.py
@@ -47,7 +47,7 @@
 response.plot()
 plt.show()
 
-sysd_est, _ = ct.era(response,r=4,dt=dt)
+sysd_est, _ = ct.eigensys_realization(response,r=4,dt=dt)
 
 step_true = ct.step_response(sysd)
 step_true.sysname="H_true"
