Plot phase plane diagram.
This function plots phase plane data, including vector fields, stream lines, equilibrium points, and contour curves. If none of plot_streamlines, plot_vectorfield, or plot_streamplot are set, then plot_streamplot is used by default.
NonlinearIOSystem
or callable(t, x, …)
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.
List of the form [xmin, xmax, ymin, ymax] describing the boundaries of the phase plot or an array of shape (N, 2) giving points of at which to plot the vector field.
Time to simulate each streamline. If a list is given, a different time can be used for each initial condition in pointdata
.
The type of grid to use for generating initial conditions: ‘meshgrid’ (default) generates a mesh of initial conditions within the specified boundaries, ‘boxgrid’ generates initial conditions along the edges of the boundary, ‘circlegrid’ generates a circle of initial conditions around each point in point data.
If the gridtype is ‘meshgrid’ and ‘boxgrid’, gridspec
gives the size of the grid in the x and y axes on which to generate points. If gridtype is ‘circlegrid’, then gridspec
is a 2-tuple specifying the radius and number of points around each point in the pointdata
array.
Parameters to pass to system. For an I/O system, params
should be a dict of parameters and values. For a callable, params
should be dict with key ‘args’ and value given by a tuple (passed to callable).
Plot all elements in the given color (use plot_<element>
= {‘color’: c} to set the color in one element of the phase plot (equilpoints, separatrices, streamlines, etc).
matplotlib.axes.Axes
, optional
The matplotlib axes to draw the figure on. If not specified and the current figure has a single axes, that axes is used. Otherwise, a new figure is created.
ControlPlot
object
Object containing the data that were plotted. See ControlPlot
for more detailed information.
matplotlib.lines.Line2D
Array of list of matplotlib.artist.Artist
objects:
lines[0] = list of Line2D objects (streamlines, separatrices).
lines[1] = Quiver object (vector field arrows).
lines[2] = list of Line2D objects (equilibrium points).
lines[3] = StreamplotSet object (lines with arrows).
matplotlib.axes.Axes
Axes for each subplot.
matplotlib.figure.Figure
Figure containing the plot.
Set the number of arrows to plot along the streamlines. The default value can be set in config.defaults['phaseplot.arrows']
.
Set the size of arrows to plot along the streamlines. The default value can be set in config.defaults['phaseplot.arrow_size']
.
Set the style of arrows to plot along the streamlines. The default value can be set in config.defaults['phaseplot.arrow_style']
.
Direction to draw streamlines: ‘forward’ to flow forward in time from the reference points, ‘reverse’ to flow backward in time, or ‘both’ to flow both forward and backward. The amount of time to simulate in each direction is given by the timedata
argument.
If True then plot streamlines based on the pointdata and gridtype. If set to a dict, pass on the key-value pairs in the dict as keywords to streamlines
.
If True then plot the vector field based on the pointdata and gridtype. If set to a dict, pass on the key-value pairs in the dict as keywords to phaseplot.vectorfield
.
If True then use matplotlib.axes.Axes.streamplot
function to plot the streamlines. If set to a dict, pass on the key-value pairs in the dict as keywords to phaseplot.streamplot
.
If True (default) then plot equilibrium points based in the phase plot boundary. If set to a dict, pass on the key-value pairs in the dict as keywords to phaseplot.equilpoints
.
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 phaseplot.separatrices
.
Override the default parameters used for generating plots. Default is set by config.defaults['ctrlplot.rcParams']
.
If set to True, suppress warning messages in generating trajectories.
Set the title of the plot. Defaults to plot type and system name(s).
Notes
The default method for producing streamlines is determined based on which keywords are specified, with plot_streamplot
serving as the generic default. If any of the arrows
, arrow_size
, arrow_style
, or dir
keywords are used and neither plot_streamlines
nor plot_streamplot
is set, then plot_streamlines
will be set to True. If neither plot_streamlines
nor plot_vectorfield
set set to True, then plot_streamplot
will be set to True.
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