Skip to content

Correct timedata doc comment for phase plot functions #1197

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

Open
FeldrinH wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Correct timedata doc comment for phase plot functions #1197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 15 additions & 9 deletions control/phaseplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,11 @@ def phase_plane_plot(
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.
timedata : int or list of int
Time to simulate each streamline. If a list is given, a different
time can be used for each initial condition in `pointdata`.
timedata : int, 1D array, or 2D array
Time to simulate each streamline. If a 1D array is given, then the
times at which to sample the simulation for all streamlines.
If a 2D array is given, then for each row the times at which
to sample the simulation for the corresponding streamline.
gridtype : str, optional
The type of grid to use for generating initial conditions:
'meshgrid' (default) generates a mesh of initial conditions within
Expand Down Expand Up @@ -544,9 +546,11 @@ def streamlines(
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.
timedata : int or list of int
Time to simulate each streamline. If a list is given, a different
time can be used for each initial condition in `pointdata`.
timedata : int, 1D array, or 2D array
Time to simulate each streamline. If a 1D array is given, then the
times at which to sample the simulation for all streamlines.
If a 2D array is given, then for each row the times at which
to sample the simulation for the corresponding streamline.
gridtype : str, optional
The type of grid to use for generating initial conditions:
'meshgrid' (default) generates a mesh of initial conditions within
Expand Down Expand Up @@ -765,9 +769,11 @@ def separatrices(
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.
timedata : int or list of int
Time to simulate each streamline. If a list is given, a different
time can be used for each initial condition in `pointdata`.
timedata : int, 1D array, or 2D array
Time to simulate each streamline. If a 1D array is given, then the
times at which to sample the simulation for all streamlines.
If a 2D array is given, then for each row the times at which
to sample the simulation for the corresponding streamline.
gridtype : str, optional
The type of grid to use for generating initial conditions:
'meshgrid' (default) generates a mesh of initial conditions within
Expand Down