Skip to content

Reimplementation of 2D phase plots #980

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
murrayrm merged 4 commits into from
Mar 31, 2024
Merged

Reimplementation of 2D phase plots #980

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3ca12ff
initial reimplementation of phase plots
murrayrm Mar 21, 2024
c41d472
address @sliivingston, @sawyerbfuller comments
murrayrm Mar 30, 2024
edb444e
small updates to address @sawyerbfuller comments on updfcn
murrayrm Mar 30, 2024
748e36a
fix typos + other small fixes from @slivingston
murrayrm Mar 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix typos + other small fixes from @slivingston
  • Loading branch information
@murrayrm
murrayrm committed Mar 31, 2024
commit 748e36ab9dd561ab81d719c95ad6de7788abd15f
11 changes: 4 additions & 7 deletions control/phaseplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
phase plots. The base function for creating phase plane portraits is
:func:`~control.phase_plane_plot`, which generates a phase plane portrait
for a 2 state I/O system (with no inputs). In addition, several other
functions are available to creat ecustomize phase plane plots:
functions are available to create customized phase plane plots:

* boxgrid: Generate a list of points along the edge of a box
* circlegrid: Generate list of points around a circle
Expand Down Expand Up @@ -103,7 +103,7 @@ def phase_plane_plot(
plot_separatrices : bool or dict
If `True` (default) then plot separatrices starting from each
equilibrium point. If set to a dict, pass on the key-value pairs
in the dict as keywords to :func:`~control.phaseplot.streamlines`.
in the dict as keywords to :func:`~control.phaseplot.separatrices`.
color : str
Plot all elements in the given color (use `plot_<fcn>={'color': c}`
to set the color in one element of the phase plot.
Expand Down Expand Up @@ -397,7 +397,7 @@ def equilpoints(
Parameters
----------
sys : NonlinearIOSystem or callable(t, x, ...)
I/O systems or function used to generate phase plane data. If a
I/O system or function used to generate phase plane data. If a
function is given, the remaining arguments are drawn from the
`params` keyword.
pointdata : list or 2D array
Expand Down Expand Up @@ -702,7 +702,7 @@ def circlegrid(centers, radius, num):
# Internal utility functions
#

# Create a system form a callable
# Create a system from a callable
def _create_system(sys, params):
if isinstance(sys, NonlinearIOSystem):
if sys.nstates != 2:
Expand Down Expand Up @@ -789,9 +789,6 @@ def _make_points(pointdata, gridspec, gridtype):

# Utility function to parse (and check) input arguments
def _parse_args(defsize):
# if not isinstance(pointdata, (list, tuple)) or len(pointdata) != 4:
# raise ValueError("invalid grid data specification")

if gridspec is None:
return defsize

Expand Down
2 changes: 1 addition & 1 deletion doc/plotting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ The following helper functions are available:
The :func:`~control.phase_plane_plot` function calls these helper functions
based on the options it is passed.

Note that unlike other plotting function, phase plane plots do not involve
Note that unlike other plotting functions, phase plane plots do not involve
computing a response and then plotting the result via a `plot()` method.
Instead, the plot is generated directly be a call to the
:func:`~control.phase_plane_plot` function (or one of the
Expand Down
2 changes: 1 addition & 1 deletion examples/phase_plane_plots.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# RMM, 25 Mar 2024
#
# This file contains a number of examples of phase plane plots generated
# using the phaseplot module. Most of these figures lines up with examples
# using the phaseplot module. Most of these figures line up with examples
# in FBS2e, with different display options shown as different subplots.

import time
Expand Down