From beb1fb37ede2d43162157c69b36f783883de04b7 Mon Sep 17 00:00:00 2001 From: Anders Wallin Date: Sat, 25 Nov 2023 12:10:26 +0200 Subject: [PATCH] documentation --- allantools/noise_kasdin.py | 31 +++++++++++++++---------------- docs/functions.rst | 4 ++++ 2 files changed, 19 insertions(+), 16 deletions(-) diff --git a/allantools/noise_kasdin.py b/allantools/noise_kasdin.py index 3521753..877e8f3 100644 --- a/allantools/noise_kasdin.py +++ b/allantools/noise_kasdin.py @@ -208,27 +208,26 @@ def c_mvar(self): return -3.0 def adev_from_qd(self, tau0=1.0, tau=1.0): - """ prefactor for Allan deviation for noise - type defined by (qd, b, tau0) + """ prefactor for Allan deviation for noise type defined by (qd, b, tau0) - Colored noise generated with (qd, b, tau0) parameters will - show an Allan variance of: + Colored noise generated with (qd, b, tau0) parameters will + show an Allan variance of: - AVAR = prefactor * h_a * tau^c + AVAR = prefactor * h_a * tau^c - where a = b + 2 is the slope of the frequency PSD. - and h_a is the frequency PSD prefactor S_y(f) = h_a * f^a + where a = b + 2 is the slope of the frequency PSD. + and h_a is the frequency PSD prefactor S_y(f) = h_a * f^a - The relation between a, b, c is: - a b c(AVAR) c(MVAR) - ----------------------- - -2 -4 1 1 - -1 -3 0 0 - 0 -2 -1 -1 - +1 -1 -2 -2 - +2 0 -2 -3 + The relation between a, b, c is: + a b c(AVAR) c(MVAR) + ----------------------- + -2 -4 1 1 + -1 -3 0 0 + 0 -2 -1 -1 + +1 -1 -2 -2 + +2 0 -2 -3 - Coefficients from [Dawkins2007]_. + Coefficients from [Dawkins2007]_. """ g_b = self.phase_psd_from_qd(tau0) diff --git a/docs/functions.rst b/docs/functions.rst index a46cd30..d4e7a74 100644 --- a/docs/functions.rst +++ b/docs/functions.rst @@ -63,6 +63,9 @@ Real-Time Statistics Noise Generation ---------------- +.. autoclass:: allantools.noise_kasdin.Noise + :members: + .. autofunction:: allantools.noise.white .. autofunction:: allantools.noise.brown .. autofunction:: allantools.noise.violet @@ -75,6 +78,7 @@ Utilities .. autofunction:: phase2frequency .. autofunction:: phase2radians .. autofunction:: psd2allan +.. autofunction:: tau_generator .. autofunction:: edf_simple .. autofunction:: edf_greenhall .. autofunction:: edf_totdev