Bases: object
Base class for input/output systems.
The InputOutputSystem
class allows (possibly nonlinear) input/output systems to be represented in Python. It is used as a parent class for a set of subclasses that are used to implement specific structures and operations for different types of input/output dynamical systems.
The timebase for the system, dt
, is used to specify whether the system is operating in continuous or discrete time. It can have the following values:
Description of the system inputs. This can be given as an integer count or 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 ‘s[i]’ (where ‘s’ is given by the input_prefix
parameter and has default value ‘u’). If this parameter is not given or given as None, the relevant quantity will be determined when possible based on other information provided to functions using the system.
Description of the system outputs. Same format as inputs
, with the prefix given by output_prefix
(defaults to ‘y’).
Description of the system states. Same format as inputs
, with the prefix given by state_prefix
(defaults to ‘x’).
System timebase. 0 (default) indicates continuous time, True indicates discrete time with unspecified sampling time, positive number is discrete time with specified sampling time, None indicates unspecified timebase (either continuous or discrete time).
System name (used for specifying signals). If unspecified, a generic name ‘sys[id]’ is generated with a unique integer id.
Parameter values for the system. Passed to the evaluation functions for the system as default values, overriding internal defaults.
Number of input, output, and state variables.
Dictionary of signal names for the inputs, outputs, and states and the index of the corresponding array.
List of signal names for inputs, outputs, and states.
shape
tuple
2-tuple of I/O system dimension, (noutputs, ninputs).
Set the prefix for input signals. Default = ‘u’.
Set the prefix for output signals. Default = ‘y’.
Set the prefix for state signals. Default = ‘x’.
String representation format. See control.iosys_repr
.
Attributes
Methods
Make a copy of an input/output system.
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).
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.
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.
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.
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..
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.
Number of system inputs.
Number of system outputs.
Number of system states.
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.
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