Bases: NonlinearIOSystem
Base class for representing a differentially flat system.
The FlatSystem class is used as a base class to describe differentially flat systems for trajectory generation. The output of the system does not need to be the differentially flat output. Flat systems are usually created with the flatsys
factory function.
A function to compute the flat flag given the states and input.
A function to compute the states and input given the flat flag.
System timebase.
Number of input, output and state variables.
shape
tuple
2-tuple of I/O system dimension, (noutputs, ninputs).
Names for the input, output, and state variables.
System name.
Notes
The class must implement two functions:
zflag = flatsys.forward(x, u, params)
This function computes the flag (derivatives) of the flat output. The inputs to this function are the state
x
and inputsu
(both 1D arrays). The output should be a 2D array with the first dimension equal to the number of system inputs and the second dimension of the length required to represent the full system dynamics (typically the number of states)
x, u = flatsys.reverse(zflag, params)
This function system state and inputs give the the flag (derivatives) of the flat output. The input to this function is an 2D array whose first dimension is equal to the number of system inputs and whose second dimension is of length required to represent the full system dynamics (typically the number of states). The output is the state
x
and inputsu
(both 1D arrays).
A flat system is also an input/output system supporting simulation, composition, and linearization. In the current implementation, the update function must be given explicitly, but the output function defaults to the flat outputs. If the output method is given, it is used in place of the flat outputs.
Attributes
Methods
Evaluate a (static) nonlinearity at a given input value.
Make a copy of an input/output system.
Dynamics of a differential or difference equation.
Feedback interconnection between two I/O systems.
Find the index for an input given its name (None if not found).
Return list of indices matching input spec (None if not found).
Find the index for a output given its name (None if not found).
Return list of indices matching output spec (None if not found).
Find the index for a state given its name (None if not found).
Return list of indices matching state spec (None if not found).
Compute the flat flag given the states and input.
Check to see if a system is a continuous-time system.
Check to see if a system is a discrete-time system.
Check to see if a system is single input, single output.
Linearize an input/output system at a given state and input.
Compute the output of the system.
Compute the states and input given the flat flag.
Set the number/names of the system inputs.
Set the number/names of the system outputs.
Set the number/names of the system states.
Update signal and system names for an I/O system.
Add two input/output systems (parallel interconnection)
Evaluate a (static) nonlinearity at a given input value.
If a nonlinear I/O system has no internal state, then evaluating the system at an input u
gives the output y = F(u)
, determined by the output function.
Parameter values for the system. Passed to the evaluation function for the system as default values, overriding internal defaults.
If True and if the system has a single output, return the system output as a 1D array rather than a 2D array. If False, return the system output as a 2D array even if the system is SISO. Default value set by config.defaults['control.squeeze_time_response']
.
Multiply two input/output systems (series interconnection)
Negate an input/output system (rescale)
Parallel addition of input/output system to a compatible object.
Pre-multiply an input/output systems by a scalar/matrix
Parallel subtraction of I/O system to a compatible object.
Subtract two input/output systems (parallel interconnection)
Division of input/output system (by scalar or array)
Make a copy of an input/output system.
A copy of the system is made, with a new name. The name
keyword can be used to specify a specific name for the system. If no name is given and use_prefix_suffix
is True, the name is constructed by prepending config.defaults['iosys.duplicate_system_name_prefix']
and appending config.defaults['iosys.duplicate_system_name_suffix']
. Otherwise, a generic system name of the form ‘sys[<id>]’ is used, where ‘<id>’ is based on an internal counter.
Name of the newly created system.
If True and name
is None, set the name of the new system to the name of the original system with prefix config.defaults['duplicate_system_name_prefix']
and suffix config.defaults['duplicate_system_name_suffix']
.
InputOutputSystem
System timebase.
Dynamics of a differential or difference equation.
Given time t
, input u
and state x
, returns the value of the right hand side of the dynamical system. If the system is a continuous-time system, returns the time derivative:
dx/dt = updfcn(t, x, u[, params])
where updfcn
is the system’s (possibly nonlinear) update function. If the system is discrete time, returns the next value of x
:
x[t+dt] = updfcn(t, x[t], u[t][, params])
where t
is a scalar.
The inputs x
and u
must be of the correct length. The params
argument is an optional dictionary of parameter values.
Time at which to evaluate.
Current state.
Current input.
System parameter values.
Feedback interconnection between two I/O systems.
InputOutputSystem
System in the feedback path.
Gain to use in feedback path. Defaults to -1.
Parameter values for the overall system. Passed to the evaluation functions for the system as default values, overriding defaults for the individual systems.
NonlinearIOSystem
Find the index for an input given its name (None if not found).
Signal name for the desired input.
Index of the named input.
Return list of indices matching input spec (None if not found).
List of signal specifications for the desired inputs. A signal can be described by its name or by a slice-like description of the form ‘start:end` where ‘start’ and ‘end’ are signal names. If either is omitted, it is taken as the first or last signal, respectively.
List of indices for the specified inputs.
Find the index for a output given its name (None if not found).
Signal name for the desired output.
Index of the named output.
Return list of indices matching output spec (None if not found).
List of signal specifications for the desired outputs. A signal can be described by its name or by a slice-like description of the form ‘start:end` where ‘start’ and ‘end’ are signal names. If either is omitted, it is taken as the first or last signal, respectively.
List of indices for the specified outputs.
Find the index for a state given its name (None if not found).
Signal name for the desired state.
Index of the named state.
Return list of indices matching state spec (None if not found).
List of signal specifications for the desired states. A signal can be described by its name or by a slice-like description of the form ‘start:end` where ‘start’ and ‘end’ are signal names. If either is omitted, it is taken as the first or last signal, respectively.
List of indices for the specified states..
Compute the flat flag given the states and input.
Given the states and inputs for a system, compute the flat outputs and their derivatives (the flat “flag”) for the system.
The state of the system.
The input to the system.
Parameter values for the system. Passed to the evaluation functions for the system as default values, overriding internal defaults.
For each flat output , zflag[i]
should be an ndarray of length that contains the flat output and its first derivatives.
List of labels for the input signals.
Check to see if a system is a continuous-time system.
If strict is True, make sure that timebase is not None. Default is False.
Check to see if a system is a discrete-time system.
If strict is True, make sure that timebase is not None. Default is False.
Check to see if a system is single input, single output.
Linearize an input/output system at a given state and input.
Return the linearization of an input/output system at a given operating point (or state and input value) as a StateSpace
system. See linearize
for complete documentation.
Number of system inputs.
Number of system outputs.
Number of system states.
Compute the output of the system.
Given time t
, input u
and state x
, returns the output of the system:
y = outfcn(t, x, u[, params])
The inputs x
and u
must be of the correct length.
The time at which to evaluate.
Current state.
Current input.
System parameter values.
List of labels for the output signals.
String representation format.
Format used in creating the representation for the system:
‘info’ : <IOSystemType sysname: [inputs] -> [outputs]>
‘eval’ : system specific, loadable representation
‘latex’ : HTML/LaTeX representation of the object
The default representation for an input/output is set to ‘eval’. This value can be changed for an individual system by setting the repr_format
parameter when the system is created or by setting the repr_format
property after system creation. Set config.defaults['iosys.repr_format']
to change for all I/O systems or use the repr_format
parameter/attribute for a single system.
Compute the states and input given the flat flag.
For each flat output , zflag[i] should be an ndarray of length that contains the flat output and its first derivatives.
Parameter values for the system. Passed to the evaluation functions for the system as default values, overriding internal defaults.
The state of the system corresponding to the flat flag.
The input to the system corresponding to the flat flag.
Set the number/names of the system inputs.
Description of the system inputs. This can be given as an integer count or as a list of strings that name the individual signals. If an integer count is specified, the names of the signal will be of the form ‘u[i]’ (where the prefix ‘u’ can be changed using the optional prefix parameter).
If inputs
is an integer, create the names of the states using the given prefix (default = ‘u’). The names of the input will be of the form ‘prefix[i]’.
Set the number/names of the system outputs.
Description of the system outputs. This can be given as an integer count or as a list of strings that name the individual signals. If an integer count is specified, the names of the signal will be of the form ‘y[i]’ (where the prefix ‘y’ can be changed using the optional prefix parameter).
If outputs
is an integer, create the names of the states using the given prefix (default = ‘y’). The names of the input will be of the form ‘prefix[i]’.
Set the number/names of the system states.
Description of the system states. This can be given as an integer count or as a list of strings that name the individual signals. If an integer count is specified, the names of the signal will be of the form ‘x[i]’ (where the prefix ‘x’ can be changed using the optional prefix parameter).
If states
is an integer, create the names of the states using the given prefix (default = ‘x’). The names of the input will be of the form ‘prefix[i]’.
2-tuple of I/O system dimension, (noutputs, ninputs).
List of labels for the state signals.
Update signal and system names for an I/O system.
New system name.
List of strings that name the individual input signals. If given as an integer or None, signal names default to the form ‘u[i]’. See InputOutputSystem
for more information.
Description of output signals; defaults to ‘y[i]’.
Description of system states; defaults to ‘x[i]’.
Set the prefix for input signals. Default = ‘u’.
Set the prefix for output signals. Default = ‘y’.
Set the prefix for state signals. Default = ‘x’.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4