ENH: Updates to doxygen docs

This commit is contained in:
andy
2012-07-27 18:06:24 +01:00
parent 0f302e2912
commit db306003ab
4 changed files with 45 additions and 31 deletions

View File

@ -34,13 +34,14 @@ Description
the calculation. The current options include:
- \c mean: arithmetic mean:
\f[
\overline{x} = \frac{\Sigma x i}{\Sigma i}
\overline{x} = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N x_i
\f]
- \c prime2Mean: prime-squared mean
\f[
\overline{x'}^2 = \frac{\Sigma (x - \overline{x}) i}{\Sigma i}
\overline{x'}^2 = \frac{1}{N}\displaystyle\sum\limits_{i=0}^N
(x_i - \overline{x})^2
\f]
- base: average over 'time', or 'iteration' (\f$i\f$ in the above)
- base: average over 'time', or 'iteration' (\f$N\f$ in the above)
- window: optional averaging window, specified in 'base' units
\note