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
complete documentation of default_frequency_range
  • Loading branch information
martinup committed Sep 5, 2015
commit f07ef5a0029c92e50bedf43302af917c2b27b8f9
16 changes: 13 additions & 3 deletions control/freqplot.py
Original file line number Diff line number Diff line change
Expand Up @@ -386,13 +386,23 @@ def default_frequency_range(syslist, Hz=None, number_of_samples=None, feature_pe
----------
syslist : list of LTI
List of linear input/output systems (single system is OK)

Hz: boolean
If True, the limits (first and last value) of the frequencies
are set to full decades in Hz so it fits plotting with logarithmic
scale in Hz otherwise in rad/s. Omega is always returned in rad/sec.
number_of_samples: int
Number of samples to generate
feature_periphery_decade: float
Defines how many decades shall be included in the frequency range on
both sides of features (poles, zeros).
Example: If there is a feature, e.g. a pole, at 1Hz and feature_periphery_decade=1.
then the range of frequencies shall span 0.1 .. 10 Hz.
The default value is read from config.bode_feature_periphery_decade.

Returns
-------
omega : array
Range of frequencies in rad/sec
number_of_samples: int
Number of samples to generate

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

args Hz, feature_periphery_decade not documented

Examples
--------
Expand Down