control.forced_response

control.forced_response(sys, T=None, U=0.0, X0=0.0, transpose=False, interpolate=False, return_x=None, squeeze=None)

Simulate the output of a linear system.

As a convenience for parameters U, X0: Numbers (scalars) are converted to constant arrays with the correct shape. The correct shape is inferred from arguments sys and T.

For information on the shape of parameters U, T, X0 and return values T, yout, xout, see Time series data.

Parameters
  • sys (StateSpace or TransferFunction) – LTI system to simulate

  • T (array_like, optional for discrete LTI sys) –

    Time steps at which the input is defined; values must be evenly spaced.

    If None, U must be given and len(U) time steps of sys.dt are simulated. If sys.dt is None or True (undetermined time step), a time step of 1.0 is assumed.

  • U (array_like or float, optional) – Input array giving input at each time T. If U is None or 0, T must be given, even for discrete time systems. In this case, for continuous time systems, a direct calculation of the matrix exponential is used, which is faster than the general interpolating algorithm used otherwise.

  • X0 (array_like or float, default=0.) – Initial condition.

  • transpose (bool, default=False) – If True, transpose all input and output arrays (for backward compatibility with MATLAB and scipy.signal.lsim()).

  • interpolate (bool, default=False) – If True and system is a discrete time system, the input will be interpolated between the given time steps and the output will be given at system sampling rate. Otherwise, only return the output at the times given in T. No effect on continuous time simulations.

  • return_x (bool, default=None) –

    • If False, return only the time and output vectors.

    • If True, also return the the state vector.

    • If None, determine the returned variables by config.defaults[‘forced_response.return_x’], which was True before version 0.9 and is False since then.

  • squeeze (bool, optional) – By default, if a system is single-input, single-output (SISO) then the output response is returned as a 1D array (indexed by time). If squeeze is True, remove single-dimensional entries from the shape of the output even if the system is not SISO. If squeeze is False, keep the output as a 2D array (indexed by the output number and time) even if the system is SISO. The default behavior can be overridden by config.defaults[‘control.squeeze_time_response’].

Returns

  • T (array) – Time values of the output.

  • yout (array) – Response of the system. If the system is SISO and squeeze is not True, the array is 1D (indexed by time). If the system is not SISO or squeeze is False, the array is 2D (indexed by the output number and time).

  • xout (array) – Time evolution of the state vector. Not affected by squeeze. Only returned if return_x is True, or return_x is None and config.defaults[‘forced_response.return_x’] is True.

Notes

For discrete time systems, the input/output response is computed using the scipy.signal.dlsim() function.

For continuous time systems, the output is computed using the matrix exponential exp(A t) and assuming linear interpolation of the inputs between time points.

Examples

>>> T, yout, xout = forced_response(sys, T, u, X0)

See Time series data and Package configuration parameters.