Crate allan_tools

Allan-tools

This lib is a portage / equivalent package to Allantools (python) library to compute Allan & related statistics over some data.

This lib only implements basic (biased) error bar estimates at the moment.

url: https://github.com/gwbres/allan-tools
url: https://github.com/aewallin/allantools

Modules

noise

tools / utilities to generate noise distributions

tau

utils

tools / utilities to manipulate datasets & vectors

Structs

RealTime

Structure optimized for real time / rolling computation,
refer to dedicated documentation

Enums

Deviation

describes all known computations

Error

describes error related to deviation computations

Functions

deviation

Computes desired deviation over input data for desired tau values.
data: input vector
taus: desired tau offsets (s)
sample_rate: sampling rate (Hz)
is_fractional: true if input vector is made of fractional (n.a) data overlapping: true if using overlapping interval (increase confidence / errbar narrows down faster) returns: (dev, err) : deviation & statistical error bars for each feasible tau

three_cornered_hat

Computes desired statistics in Three Cornerned Hat fashion.
data_ab: A against B data
data_bc: B against C data
data_ca: C against A data
taus: desired tau offsets sample_rate: sampling rate (Hz)
is_fractional: true if measured data are fractional errors
overlapping: true if computing in overlapped fashion
deviation: which deviation to compute
returns ((dev_a,err_a),(dev_b,err_b),(dev_c,err_c))
where dev_a: deviation clock(a) and related error bar for all feasible tau offsets, same thing for clock(b) and (c)

variance

Computes desired variance over input data for desired tau values.
data: input vector
taus: desired tau offsets (s)
sample_rate: sampling rate (Hz)
is_fractional: true if input vector is made of fractional (n.a) data overlapping: true if using overlapping interval (increase confidence / errbar narrows down faster) returns: (var, err) : variance & statistical error bars for each feasible tau