NotificationsYou must be signed in to change notification settings
Fork445
Star1.9k

Allow signal names to be used for time/freq responses and subsystem indexing#1069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

murrayrm merged 12 commits intopython-control:mainfrommurrayrm:named_signals-29Nov2024

Dec 4, 2024

Merged

Allow signal names to be used for time/freq responses and subsystem indexing#1069

murrayrm merged 12 commits intopython-control:mainfrommurrayrm:named_signals-29Nov2024

Dec 4, 2024

Conversation

Copy link

Member

murrayrm commentedDec 1, 2024•
edited
Loading

This PR adds the ability to access response signals and subsystem inputs and outputs using signal names. As described in the documentation:

Time signal indexing:

The input, output, and state elements of the response can be access using signal names in place of integer offsets::
plt.plot(response. time, response.states['x[1]']
For multi-trace systems generated by :func:step_response and :func:impulse_response, the input name used to generate the trace can be used to access the appropriate input output pair::
plt.plot(response.time, response.outputs['y[0]', 'u[1]'])

Frequency response indexing:

Frequency response objects are also available as named properties of theresponse object:response.magnitude,response.phase, andresponse.response (for the complex response). For MIMO systems, these elements of the frequency response can be accessed using the names of the inputs and outputs::
response.magnitude['y[0]', 'u[1]']
where the signal names are based on the system that generated the frequency response.

Subsystem indexing:

Subsets of input/output pairs for LTI systems can be obtained by indexing the system using either numerical indices (including slices) or signal names::
subsys = sys[[0, 2], 0:2]subsys = sys[['y[0]', 'y[2]'], ['u[0]', 'u[1]']]
Signal names for an indexed subsystem are preserved from the original system and the subsystem name is set according to the values ofcontrol.config.defaults['iosys.indexed_system_name_prefix'] andcontrol.config.defaults['iosys.indexed_system_name_suffix']`. The default subsystem name is the original system name with '$indexed' appended.

Summary of changes:

Signals are now returned as aNamedSignal object, which is a subclass ofnp.ndarray that overrides the__getitem__ method to allow processing of signal names via the_parse_key method.
All signal/subsystem indexing now allows integers, strings (new), lists of integers or strings (new), or slices.
Refactored code for processing signal names to make everything consistent across time and frequency domain signals as well as state and input/output vectors. Seeiosys.NamedSignal._parse_key and changes infrdata.py andtimeresp.py.
Refactored code for processing subsystem indices and made index processing consistent forStateSpace,TransferFunction, andFrequencyResponseData systems. Seeiosys._process_subsys_index and changes infrdata.py,statesp.py, andxferfcn.py.
Unit tests, docstrings, and user documentation updated to cover new functiionality.

murrayrm added11 commits

November 30, 2024 08:53

clean up _process_time_response

5d7fb42

implement NamedSignal's for time responses

5df6fb7

implement NamedSignal's for frequency responses

b382abf

add string-based indexing of state space systems

58922ce

add string-based indexing of transfer functions

e52fca6

add string-based indexing of FRD systems

cca4d13

fix NamedSignal.__getitem__ for new versions of NumPy + unit tests/sl…

944b6a2

…ycot

update index checking + docstrings

cd3d315

add documentation for indexing by name + update docstrings

df33002

use common processing for state response

1903055

TRV: typo in documentation

fba414d

Copy link

coveralls commentedDec 1, 2024•
edited
Loading

coverage: 94.721% (+0.02%) from 94.697%
when pulling7ef09a0 on murrayrm:named_signals-29Nov2024
into57b5307 on python-control:main.

slivingston self-requested a review

December 1, 2024 22:26

slivingston reviewed

Dec 3, 2024

View reviewed changes

Copy link

Member

slivingston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Almost done with review; it will be done tomorrow. For now, I am sending minor style comments.

control/iosys.py Outdated


		def__array_finalize__(self,obj):
		# See https://numpy.org/doc/stable/user/basics.subclassing.html
		ifobjisNone:return

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	ifobjisNone:return
	ifobjisNone:
	return

return should go on the next line to make it more obvious what is in the if-block. Also,this is consistent with PEP 8:

Compound statements (multiple statements on the same line) are generally discouraged

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Theexample in the NumPy docs hasobj is None: return (on 1 line), but my style comment remains. I do not know why the example there has this 1-line style, but I suspect it is to keep examples short, which would also justify there being only 1 blank line afterimport in those examples.

control/iosys.py Outdated

		idx=idx[0]

		# Convert int to slice so that numpy doesn't drop dimension
		ifisinstance(idx,int):idx=slice(idx,idx+1,1)

Copy link

Member

slivingstonDec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	ifisinstance(idx,int):idx=slice(idx,idx+1,1)
	ifisinstance(idx,int):
	idx=slice(idx,idx+1,1)

Similar to my other comment, statements should be on separate lines for clarity of style (as per PEP 8).

control/iosys.py Outdated

		#
		def_process_subsys_index(idx,sys_labels,slice_to_list=False):
		ifnotisinstance(idx, (slice,list,int)):
		raiseTypeError(f"system indices must be integers, slices, or lists")

Copy link

Member

slivingstonDec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

This string does not need thef prefix, but OK to keep it if you anticipate expressions being added to it later.

control/tests/lti_test.py Outdated

		sys=ct.rss(4,3,3)
		subsys=sys[key]

		# Construct the system to be test

Copy link

Member

slivingstonDec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	# Construct the system to betest
	# Construct the system to betested

control/timeresp.py Outdated

		response(tranpose=True).input

		See :meth:`TimeResponseData.__call__` for more information.
		See :meth:`TimeResponseData.__call__` for more information.

Copy link

Member

slivingstonDec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	See :meth:`TimeResponseData.__call__`formoreinformation.
	See :meth:`TimeResponseData.__call__`formoreinformation.

doc/conventions.rst Outdated

		which will compute the step response for each input/output pair. See
		:class:`TimeResponseData` for more details.

		The input, output, and state elements of the response can be access using

Copy link

Member

slivingstonDec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	The input, output, and state elements of the response can beaccess using
	The input, output, and state elements of the response can beaccessed using

doc/plotting.rst Outdated

		Access to frequency response data is available via the attributes
		``omega``, ``magnitude``,` `phase``, and ``response``, where ``response``
		represents the complex value of the frequency response at each frequency.
		The ``magnitude``,` `phase``, and ``response`` arrays can be indexed using

Copy link

Member

slivingstonDec 2, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	The ``magnitude``,``phase``, and ``response`` arrays can be indexed using
	The ``magnitude``, ``phase``, and ``response`` arrays can be indexed using

doc/conventions.rst Outdated

Comment on lines 160 to 161

		`control.config.defaults['iosys.indexed_system_name_prefix']` and
		`control.config.defaults['iosys.indexed_system_name_suffix']`. The default

Copy link

Member

slivingstonDec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	`control.config.defaults['iosys.indexed_system_name_prefix']` and
	`control.config.defaults['iosys.indexed_system_name_suffix']`. The default
	``control.config.defaults['iosys.indexed_system_name_prefix']`` and
	``control.config.defaults['iosys.indexed_system_name_suffix']``. The default

rst files built withSphinx require double backtick (``) to render as in-line code.

doc/conventions.rst Outdated

Comment on lines 112 to 113

		Note: The `fresp` data member is stored as a NumPy array and cannot be
		accessed with signal names. Use `response.response` to access the complex

Copy link

Member

slivingstonDec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	Note: The `fresp` data member is stored as a NumPy array and cannot be
	accessed with signal names. Use `response.response` to access the complex
	Note: The ``fresp`` data member is stored as a NumPy array and cannot be
	accessed with signal names. Use ``response.response`` to access the complex

doc/conventions.rst Outdated

Comment on lines 102 to 103

		`response` object: `response.magnitude`, `response.phase`, and
		`response.response` (for the complex response). For MIMO systems, these

Copy link

Member

slivingstonDec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Suggested change

	`response` object: `response.magnitude`, `response.phase`, and
	`response.response` (for the complex response). For MIMO systems, these
	``response`` object: ``response.magnitude``, ``response.phase``, and
	``response.response`` (for the complex response). For MIMO systems, these

address initial@slivingstoncomments

7ef09a0

slivingston approved these changes

Dec 4, 2024

View reviewed changes

murrayrm merged commit12dda4e intopython-control:main

Dec 4, 2024

23 checks passed

murrayrm added this to the0.10.2 milestone

Feb 19, 2025

Labels

None yet

Movatterモバイル変換

Allow signal names to be used for time/freq responses and subsystem indexing#1069

Allow signal names to be used for time/freq responses and subsystem indexing#1069

Uh oh!

Conversation

murrayrm commentedDec 1, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

coveralls commentedDec 1, 2024• editedLoading Uh oh!There was an error while loading.Please reload this page.

Uh oh!

Uh oh!

slivingston left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

murrayrm commentedDec 1, 2024•
edited
Loading

coveralls commentedDec 1, 2024•
edited
Loading