Skip to content
Merged
Changes from 1 commit
Commits
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
Next Next commit
add documentation on scaled portions of Nyquist plot
  • Loading branch information
murrayrm committed Mar 31, 2023
commit 423744aea70cd0243b55546938f76aa06710a3ee
21 changes: 14 additions & 7 deletions control/freqplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -558,21 +558,21 @@ def nyquist_plot(
List of linear input/output systems (single system is OK). Nyquist
curves for each system are plotted on the same graph.

plot : boolean
If True, plot magnitude

omega : array_like
omega : array_like, optional
Set of frequencies to be evaluated, in rad/sec.

omega_limits : array_like of two values
omega_limits : array_like of two values, optional
Limits to the range of frequencies. Ignored if omega is provided, and
auto-generated if omitted.

omega_num : int
omega_num : int, optional
Number of frequency samples to plot. Defaults to
config.defaults['freqplot.number_of_samples'].

color : string
plot : boolean, optional
If True (default), plot the Nyquist plot.

color : string, optional
Used to specify the color of the line and arrowhead.

return_contour : bool, optional
Expand Down Expand Up @@ -690,6 +690,13 @@ def nyquist_plot(
to `none` will turn off indentation. If `return_contour` is True, the
exact contour used for evaluation is returned.

3. For those portions of the Nyquist plot in which the contour is
indented to avoid poles, resuling in a scaling of the Nyquist plot,
the line styles are according to the settings of the `primary_style`
and `mirror_style` keywords. By default the scaled portions of the
primary curve use a dotted line style and the scaled portion of the
mirror image use a dashdot line style.

Examples
--------
>>> G = ct.zpk([], [-1, -2, -3], gain=100)
Expand Down