Skip to content
Snippets Groups Projects
Verified Commit fa417b2b authored by Tobias Hangleiter's avatar Tobias Hangleiter
Browse files

Add doc note

parent bf91d895
No related branches found
No related tags found
1 merge request!68Bugfixes and improvements
...@@ -135,12 +135,21 @@ class Spectrometer: ...@@ -135,12 +135,21 @@ class Spectrometer:
Plot the cumulative data given by Plot the cumulative data given by
.. math:: .. math::
\int_{f_\mathrm{min}}^f\mathrm{d}f^\prime S(f^\prime) \mathrm{RMS}_S(f)^2 = \int_{f_\mathrm{min}}^f\mathrm{d}
f^\prime\,S(f^\prime)
on a new subplot. :math:`S(f)` is whatever is plotted in the with :math:`\mathrm{RMS}_S(f)` the root-mean-square of the PSD
main plot and therefore depends on :attr:`plot_density` and :math:`S(f^\prime)` up to frequency :math:`f^\prime` on a new
:attr:`plot_amplitude`. Can also be toggled dynamically by subplot. If :attr:`plot_density` is False, the spectrum instead
setting :attr:`plot_cumulative`. of the PSD is used, but note that this does not make a lot of
sense.
If :attr:`plot_dB_scale` is True, the log-ratio of
:math:`\mathrm{RMS}_S(f)` with that of the reference data is
plotted.
Can also be toggled dynamically by setting
:attr:`plot_cumulative`.
plot_negative_frequencies : bool, default True plot_negative_frequencies : bool, default True
Plot negative frequencies for two-sided spectra (in case the Plot negative frequencies for two-sided spectra (in case the
time-series data is complex). For ``matplotlib >= 3.6`` an time-series data is complex). For ``matplotlib >= 3.6`` an
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment