Skip to content

Commit

Permalink
minor doc format
Browse files Browse the repository at this point in the history
  • Loading branch information
aewallin committed Nov 28, 2023
1 parent d101e27 commit f5b0867
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions allantools/allantools.py
Original file line number Diff line number Diff line change
Expand Up @@ -1782,11 +1782,11 @@ def tau_generator(data, rate, taus=None, v=False, even=False, maximum_m=-1):
+----------+--------------------------------+
| "log10" | approx. 10 points per decade |
+----------+--------------------------------+
v:
v: bool
verbose output if True
even:
even: bool
require even m, where tau=m*tau0, for Theo1 statistic
maximum_m:
maximum_m: int
limit m, where tau=m*tau0, to this value.
used by mtotdev() and htotdev() to limit maximum tau.
Expand Down Expand Up @@ -1918,6 +1918,7 @@ def tau_reduction(ms, rate, n_per_decade):
Reduced list of m values
taus: np.array
Reduced list of tau values
"""
ms = np.int64(ms)
keep = np.bool8(np.rint(n_per_decade*np.log10(ms[1:])) -
Expand All @@ -1933,7 +1934,8 @@ def tau_reduction(ms, rate, n_per_decade):

def remove_small_ns(taus, devs, deverrs, ns):
""" Remove results with small number of samples.
If n is small (==1), reject the result
If n is small (==1), reject the result
Parameters
----------
Expand Down Expand Up @@ -2037,6 +2039,7 @@ def three_cornered_hat_phase(phasedata_ab, phasedata_bc, phasedata_ca, rate, tau
References
----------
* http://www.wriley.com/3-CornHat.htm
"""
(tau_ab, dev_ab, err_ab, ns_ab) = function(phasedata_ab,
data_type='phase',
Expand Down

0 comments on commit f5b0867

Please sign in to comment.