Skip to content

Arrow head length and head width option is added in nyquist_plot function #379

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 7 commits into from
Mar 18, 2020
Merged

Arrow head length and head width option is added in nyquist_plot function #379

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b28e9ab
Nyquist_plot changed to accommodate arrow size
geekonloose Mar 4, 2020
a4f2d25
color option is added
geekonloose Mar 4, 2020
f5f05bd
formatting
geekonloose Mar 4, 2020
5de0899
formatting is retained
geekonloose Mar 5, 2020
8f8565b
line formatting corrected
geekonloose Mar 5, 2020
1f4885d
again line formatting
geekonloose Mar 5, 2020
7c96781
hl changed to arrowhead_width and hw changed to arrowhead_length
geekonloose Mar 5, 2020
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
line formatting corrected
  • Loading branch information
@geekonloose
geekonloose authored Mar 5, 2020
commit 8f8565b3b7d58544972ea2556fa6261ee1b31dc1
22 changes: 20 additions & 2 deletions control/freqplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,9 @@ def bode_plot(syslist, omega=None,
Plot=True, omega_limits=None, omega_num=None,
margins=None, *args, **kwargs):
"""Bode plot for a system

Plots a Bode plot for the system over a (optional) frequency range.

Parameters
----------
syslist : linsys
Expand Down Expand Up @@ -112,6 +114,7 @@ def bode_plot(syslist, omega=None,
Additional arguments for :func:`matplotlib.plot` (color, linestyle, etc)
**kwargs:
Additional keywords (passed to `matplotlib`)

Returns
-------
mag : array (list if len(syslist) > 1)
Expand All @@ -120,13 +123,15 @@ def bode_plot(syslist, omega=None,
phase in radians
omega : array (list if len(syslist) > 1)
frequency in rad/sec

Other Parameters
----------------
grid : bool
If True, plot grid lines on gain and phase plots. Default is set by
config.defaults['bode.grid'].
The default values for Bode plot configuration parameters can be reset
using the `config.defaults` dictionary, with module name 'bode'.

Notes
-----
1. Alternatively, you may use the lower-level method (mag, phase, freq)
Expand All @@ -136,10 +141,12 @@ def bode_plot(syslist, omega=None,
along the upper branch of the unit circle, using the mapping z = exp(j
\\omega dt) where omega ranges from 0 to pi/dt and dt is the discrete
timebase. If not timebase is specified (dt = True), dt is set to 1.

Examples
--------
>>> sys = ss("1. -2; 3. -4", "5.; 7", "6. 8", "9.")
>>> mag, phase, omega = bode(sys)

"""
# Make a copy of the kwargs dictonary since we will modify it
kwargs = dict(kwargs)
Expand Down Expand Up @@ -428,7 +435,9 @@ def nyquist_plot(syslist, omega=None, Plot=True,
labelFreq=0, hl=0.1, hw=0.1, color=None, *args, **kwargs):
"""
Nyquist plot for a system

Plots a Nyquist plot for the system over a (optional) frequency range.

Parameters
----------
syslist : list of LTI
Expand All @@ -441,12 +450,11 @@ def nyquist_plot(syslist, omega=None, Plot=True,
Used to specify the color of the plot
labelFreq : int
Label every nth frequency on the plot
hl : float (default 0.1), Head length of arrow
hw : float (default 0.1), Head width of arrow
*args
Additional arguments for :func:`matplotlib.plot` (color, linestyle, etc)
**kwargs:
Additional keywords (passed to `matplotlib`)

Returns
-------
real : array
Expand All @@ -455,10 +463,12 @@ def nyquist_plot(syslist, omega=None, Plot=True,
imaginary part of the frequency response array
freq : array
frequencies

Examples
--------
>>> sys = ss("1. -2; 3. -4", "5.; 7", "6. 8", "9.")
>>> real, imag, freq = nyquist_plot(sys)

"""
# If argument was a singleton, turn it into a list
if not getattr(syslist, '__iter__', False):
Expand Down Expand Up @@ -549,14 +559,17 @@ def nyquist_plot(syslist, omega=None, Plot=True,
# TODO: think about how (and whether) to handle lists of systems
def gangof4_plot(P, C, omega=None, **kwargs):
"""Plot the "Gang of 4" transfer functions for a system

Generates a 2x2 plot showing the "Gang of 4" sensitivity functions
[T, PS; CS, S]

Parameters
----------
P, C : LTI
Linear input/output systems (process and control)
omega : array
Range of frequencies (list or bounds) in rad/sec

Returns
-------
None
Expand Down Expand Up @@ -651,8 +664,10 @@ def default_frequency_range(syslist, Hz=None, number_of_samples=None,
feature_periphery_decades=None):
"""Compute a reasonable default frequency range for frequency
domain plots.

Finds a reasonable default frequency range by examining the features
(poles and zeros) of the systems in syslist.

Parameters
----------
syslist : list of LTI
Expand All @@ -669,15 +684,18 @@ def default_frequency_range(syslist, Hz=None, number_of_samples=None,
Defines how many decades shall be included in the frequency range on
both sides of features (poles, zeros). The default value is read from
``config.defaults['freqplot.feature_periphery_decades']``.

Returns
-------
omega : array
Range of frequencies in rad/sec

Examples
--------
>>> from matlab import ss
>>> sys = ss("1. -2; 3. -4", "5.; 7", "6. 8", "9.")
>>> omega = default_frequency_range(sys)

"""
# This code looks at the poles and zeros of all of the systems that
# we are plotting and sets the frequency range to be one decade above
Expand Down