forked from python-control/python-control
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtrdata_test.py
More file actions
362 lines (301 loc) · 13 KB
/
Copy pathtrdata_test.py
File metadata and controls
362 lines (301 loc) · 13 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
"""trdata_test.py - test return values from time response functions
RMM, 22 Aug 2021
This set of unit tests covers checks to make sure that the various time
response functions are returning the right sets of objects in the (new)
InputOutputResponse class.
"""
import pytest
import numpy as np
import control as ct
@pytest.mark.parametrize(
"nout, nin, squeeze", [
[1, 1, None],
[1, 1, True],
[1, 1, False],
[1, 2, None],
[1, 2, True],
[1, 2, False],
[2, 1, None],
[2, 1, True],
[2, 1, False],
[2, 3, None],
[2, 3, True],
[2, 3, False],
])
def test_trdata_shapes(nin, nout, squeeze):
# SISO, single trace
sys = ct.rss(4, nout, nin, strictly_proper=True)
T = np.linspace(0, 1, 10)
U = np.outer(np.ones(nin), np.sin(T) )
X0 = np.ones(sys.nstates)
#
# Initial response
#
res = ct.initial_response(sys, X0=X0)
ntimes = res.time.shape[0]
# Check shape of class members
assert len(res.time.shape) == 1
assert res.y.shape == (sys.noutputs, ntimes)
assert res.x.shape == (sys.nstates, ntimes)
assert res.u is None
# Check dimensions of the response
assert res.ntraces == 0 # single trace
assert res.ninputs == 0 # no input for initial response
assert res.noutputs == sys.noutputs
assert res.nstates == sys.nstates
# Check shape of class properties
if sys.issiso():
assert res.outputs.shape == (ntimes,)
assert res._legacy_states.shape == (sys.nstates, ntimes)
assert res.states.shape == (sys.nstates, ntimes)
assert res.inputs is None
elif res.squeeze is True:
assert res.outputs.shape == (ntimes, )
assert res._legacy_states.shape == (sys.nstates, ntimes)
assert res.states.shape == (sys.nstates, ntimes)
assert res.inputs is None
else:
assert res.outputs.shape == (sys.noutputs, ntimes)
assert res._legacy_states.shape == (sys.nstates, ntimes)
assert res.states.shape == (sys.nstates, ntimes)
assert res.inputs is None
#
# Impulse and step response
#
for fcn in (ct.impulse_response, ct.step_response):
res = fcn(sys, squeeze=squeeze)
ntimes = res.time.shape[0]
# Check shape of class members
assert len(res.time.shape) == 1
assert res.y.shape == (sys.noutputs, sys.ninputs, ntimes)
assert res.x.shape == (sys.nstates, sys.ninputs, ntimes)
assert res.u.shape == (sys.ninputs, sys.ninputs, ntimes)
# Check shape of class members
assert res.ntraces == sys.ninputs
assert res.ninputs == sys.ninputs
assert res.noutputs == sys.noutputs
assert res.nstates == sys.nstates
# Check shape of inputs and outputs
if sys.issiso() and squeeze is not False:
assert res.outputs.shape == (ntimes, )
assert res.states.shape == (sys.nstates, ntimes)
assert res.inputs.shape == (ntimes, )
elif res.squeeze is True:
assert res.outputs.shape == \
np.empty((sys.noutputs, sys.ninputs, ntimes)).squeeze().shape
assert res.states.shape == \
np.empty((sys.nstates, sys.ninputs, ntimes)).squeeze().shape
assert res.inputs.shape == \
np.empty((sys.ninputs, sys.ninputs, ntimes)).squeeze().shape
else:
assert res.outputs.shape == (sys.noutputs, sys.ninputs, ntimes)
assert res.states.shape == (sys.nstates, sys.ninputs, ntimes)
assert res.inputs.shape == (sys.ninputs, sys.ninputs, ntimes)
# Check legacy state space dimensions (not affected by squeeze)
if sys.issiso():
assert res._legacy_states.shape == (sys.nstates, ntimes)
else:
assert res._legacy_states.shape == \
(sys.nstates, sys.ninputs, ntimes)
#
# Forced response
#
res = ct.forced_response(sys, T, U, X0, squeeze=squeeze)
ntimes = res.time.shape[0]
# Check shape of class members
assert len(res.time.shape) == 1
assert res.y.shape == (sys.noutputs, ntimes)
assert res.x.shape == (sys.nstates, ntimes)
assert res.u.shape == (sys.ninputs, ntimes)
# Check dimensions of the response
assert res.ntraces == 0 # single trace
assert res.ninputs == sys.ninputs
assert res.noutputs == sys.noutputs
assert res.nstates == sys.nstates
# Check shape of inputs and outputs
if sys.issiso() and squeeze is not False:
assert res.outputs.shape == (ntimes,)
assert res.states.shape == (sys.nstates, ntimes)
assert res.inputs.shape == (ntimes,)
elif squeeze is True:
assert res.outputs.shape == \
np.empty((sys.noutputs, 1, ntimes)).squeeze().shape
assert res.states.shape == \
np.empty((sys.nstates, 1, ntimes)).squeeze().shape
assert res.inputs.shape == \
np.empty((sys.ninputs, 1, ntimes)).squeeze().shape
else: # MIMO or squeeze is False
assert res.outputs.shape == (sys.noutputs, ntimes)
assert res.states.shape == (sys.nstates, ntimes)
assert res.inputs.shape == (sys.ninputs, ntimes)
# Check state space dimensions (not affected by squeeze)
assert res.states.shape == (sys.nstates, ntimes)
def test_response_copy():
# Generate some initial data to use
sys_siso = ct.rss(4, 1, 1)
response_siso = ct.step_response(sys_siso)
siso_ntimes = response_siso.time.size
sys_mimo = ct.rss(4, 2, 1)
response_mimo = ct.step_response(sys_mimo)
mimo_ntimes = response_mimo.time.size
# Transpose
response_mimo_transpose = response_mimo(transpose=True)
assert response_mimo.outputs.shape == (2, 1, mimo_ntimes)
assert response_mimo_transpose.outputs.shape == (mimo_ntimes, 2, 1)
assert response_mimo.states.shape == (4, 1, mimo_ntimes)
assert response_mimo_transpose.states.shape == (mimo_ntimes, 4, 1)
# Squeeze
response_siso_as_mimo = response_siso(squeeze=False)
assert response_siso_as_mimo.outputs.shape == (1, 1, siso_ntimes)
assert response_siso_as_mimo.states.shape == (4, 1, siso_ntimes)
assert response_siso_as_mimo._legacy_states.shape == (4, siso_ntimes)
response_mimo_squeezed = response_mimo(squeeze=True)
assert response_mimo_squeezed.outputs.shape == (2, mimo_ntimes)
assert response_mimo_squeezed.states.shape == (4, mimo_ntimes)
assert response_mimo_squeezed._legacy_states.shape == (4, 1, mimo_ntimes)
# Squeeze and transpose
response_mimo_sqtr = response_mimo(squeeze=True, transpose=True)
assert response_mimo_sqtr.outputs.shape == (mimo_ntimes, 2)
assert response_mimo_sqtr.states.shape == (mimo_ntimes, 4)
assert response_mimo_sqtr._legacy_states.shape == (mimo_ntimes, 4, 1)
# Return_x
t, y = response_mimo
t, y = response_mimo()
t, y, x = response_mimo(return_x=True)
with pytest.raises(ValueError, match="too many"):
t, y = response_mimo(return_x=True)
with pytest.raises(ValueError, match="not enough"):
t, y, x = response_mimo
# Labels
assert response_mimo.output_labels is None
assert response_mimo.state_labels is None
assert response_mimo.input_labels is None
response = response_mimo(
output_labels=['y1', 'y2'], input_labels='u',
state_labels=["x[%d]" % i for i in range(4)])
assert response.output_labels == ['y1', 'y2']
assert response.state_labels == ['x[0]', 'x[1]', 'x[2]', 'x[3]']
assert response.input_labels == ['u']
# Unknown keyword
with pytest.raises(TypeError, match="unrecognized keywords"):
response_bad_kw = response_mimo(input=0)
def test_trdata_labels():
# Create an I/O system with labels
sys = ct.rss(4, 3, 2)
iosys = ct.LinearIOSystem(sys)
T = np.linspace(1, 10, 10)
U = [np.sin(T), np.cos(T)]
# Create a response
response = ct.input_output_response(iosys, T, U)
# Make sure the labels got created
np.testing.assert_equal(
response.output_labels, ["y[%d]" % i for i in range(sys.noutputs)])
np.testing.assert_equal(
response.state_labels, ["x[%d]" % i for i in range(sys.nstates)])
np.testing.assert_equal(
response.input_labels, ["u[%d]" % i for i in range(sys.ninputs)])
def test_trdata_multitrace():
#
# Output signal processing
#
# Proper call of multi-trace data w/ ambiguous 2D output
response = ct.TimeResponseData(
np.zeros(5), np.ones((2, 5)), np.zeros((3, 2, 5)),
np.ones((4, 2, 5)), multi_trace=True)
assert response.ntraces == 2
assert response.noutputs == 1
assert response.nstates == 3
assert response.ninputs == 4
# Proper call of single trace w/ ambiguous 2D output
response = ct.TimeResponseData(
np.zeros(5), np.ones((2, 5)), np.zeros((3, 5)),
np.ones((4, 5)), multi_trace=False)
assert response.ntraces == 0
assert response.noutputs == 2
assert response.nstates == 3
assert response.ninputs == 4
# Proper call of multi-trace data w/ ambiguous 1D output
response = ct.TimeResponseData(
np.zeros(5), np.ones(5), np.zeros((3, 5)),
np.ones((4, 5)), multi_trace=False)
assert response.ntraces == 0
assert response.noutputs == 1
assert response.nstates == 3
assert response.ninputs == 4
assert response.y.shape == (1, 5) # Make sure reshape occured
# Output vector not the right shape
with pytest.raises(ValueError, match="Output vector is the wrong shape"):
response = ct.TimeResponseData(
np.zeros(5), np.ones((1, 2, 3, 5)), None, None)
# Inconsistent output vector: different number of time points
with pytest.raises(ValueError, match="Output vector does not match time"):
response = ct.TimeResponseData(
np.zeros(5), np.ones(6), np.zeros(5), np.zeros(5))
#
# State signal processing
#
# For multi-trace, state must be 3D
with pytest.raises(ValueError, match="State vector is the wrong shape"):
response = ct.TimeResponseData(
np.zeros(5), np.ones((1, 5)), np.zeros((3, 5)), multi_trace=True)
# If not multi-trace, state must be 2D
with pytest.raises(ValueError, match="State vector is the wrong shape"):
response = ct.TimeResponseData(
np.zeros(5), np.ones(5), np.zeros((3, 1, 5)), multi_trace=False)
# State vector in the wrong shape
with pytest.raises(ValueError, match="State vector is the wrong shape"):
response = ct.TimeResponseData(
np.zeros(5), np.ones((1, 2, 5)), np.zeros((2, 1, 5)))
# Inconsistent state vector: different number of time points
with pytest.raises(ValueError, match="State vector does not match time"):
response = ct.TimeResponseData(
np.zeros(5), np.ones(5), np.zeros((1, 6)), np.zeros(5))
#
# Input signal processing
#
# Proper call of multi-trace data with 2D input
response = ct.TimeResponseData(
np.zeros(5), np.ones((2, 5)), np.zeros((3, 2, 5)),
np.ones((2, 5)), multi_trace=True)
assert response.ntraces == 2
assert response.noutputs == 1
assert response.nstates == 3
assert response.ninputs == 1
# Input vector in the wrong shape
with pytest.raises(ValueError, match="Input vector is the wrong shape"):
response = ct.TimeResponseData(
np.zeros(5), np.ones((1, 2, 5)), None, np.zeros((2, 1, 5)))
# Inconsistent input vector: different number of time points
with pytest.raises(ValueError, match="Input vector does not match time"):
response = ct.TimeResponseData(
np.zeros(5), np.ones(5), np.zeros((1, 5)), np.zeros(6))
def test_trdata_exceptions():
# Incorrect dimension for time vector
with pytest.raises(ValueError, match="Time vector must be 1D"):
ct.TimeResponseData(np.zeros((2,2)), np.zeros(2), None)
# Infer SISO system from inputs and outputs
response = ct.TimeResponseData(
np.zeros(5), np.ones(5), None, np.ones(5))
assert response.issiso
response = ct.TimeResponseData(
np.zeros(5), np.ones((1, 5)), None, np.ones((1, 5)))
assert response.issiso
response = ct.TimeResponseData(
np.zeros(5), np.ones((1, 2, 5)), None, np.ones((1, 2, 5)))
assert response.issiso
# Not enough input to infer whether SISO
with pytest.raises(ValueError, match="Can't determine if system is SISO"):
response = ct.TimeResponseData(
np.zeros(5), np.ones((1, 2, 5)), np.ones((4, 2, 5)), None)
# Not enough input to infer whether SISO
with pytest.raises(ValueError, match="Keyword `issiso` does not match"):
response = ct.TimeResponseData(
np.zeros(5), np.ones((2, 5)), None, np.ones((1, 5)), issiso=True)
# Unknown squeeze keyword value
with pytest.raises(ValueError, match="Unknown squeeze value"):
response=ct.TimeResponseData(
np.zeros(5), np.ones(5), None, np.ones(5), squeeze=1)
# Legacy interface index error
response[0], response[1], response[2]
with pytest.raises(IndexError):
response[3]