Commit 6e5efd5e authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Runstat: docu update

parent b525e00d
......@@ -279,8 +279,10 @@ Operator catalog:
Runstat runsum Running sum
Runstat runmean Running mean
Runstat runavg Running average
Runstat runvar Running variance
Runstat runstd Running standard deviation
Runstat runstd1 Running standard deviation
Runstat runvar Running variance
Runstat runvar1 Running variance
Runpctl runpctl Running percentiles
Timstat timmin Time minimum
Timstat timmax Time maximum
......
@BeginModule
@NewPage
@Name = Runpctl
@Title = Running percentile values
@Section = Statistical values
......
......@@ -5,7 +5,7 @@
@Section = Statistical values
@Class = Statistic
@Arguments = ifile ofile
@Operators = runmin runmax runsum runmean runavg runvar runstd
@Operators = runmin runmax runsum runmean runavg runstd runstd1 runvar runvar1
@BeginDescription
This module computes running statistical values over a selected number
......@@ -107,12 +107,33 @@ o(t+(nts-1)/2,x) = \mbox{\bf avg}\{i(t,x), i(t+1,x), ..., i(t+nts-1,x)\}
@Parameter = nts
@BeginDescription
Divisor is n.
@IfMan
o(t+(nts-1)/2,x) = var{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}
@EndifMan
@IfDoc
@BeginMath
o(t+(nts-1)/2,x) = \mbox{\bf std}\{i(t,x), i(t+1,x), ..., i(t+nts-1,x)\}
o(t+(nts-1)/2,x) = \mbox{\bf var}\{i(t,x), i(t+1,x), ..., i(t+nts-1,x)\}
@EndMath
@EndifDoc
@EndDescription
@EndOperator
@BeginOperator_runvar1
@Title = Running variance
@Parameter = nts
@BeginDescription
Divisor is (n-1).
@IfMan
o(t+(nts-1)/2,x) = var1{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}
@EndifMan
@IfDoc
@BeginMath
o(t+(nts-1)/2,x) = \mbox{\bf var1}\{i(t,x), i(t+1,x), ..., i(t+nts-1,x)\}
@EndMath
@EndifDoc
@EndDescription
......@@ -124,6 +145,8 @@ o(t+(nts-1)/2,x) = \mbox{\bf std}\{i(t,x), i(t+1,x), ..., i(t+nts-1,x)\}
@Parameter = nts
@BeginDescription
Divisor is n.
@IfMan
o(t+(nts-1)/2,x) = std{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}
@EndifMan
......@@ -136,6 +159,25 @@ o(t+(nts-1)/2,x) = \mbox{\bf std}\{i(t,x), i(t+1,x), ..., i(t+nts-1,x)\}
@EndOperator
@BeginOperator_runstd1
@Title = Running standard deviation
@Parameter = nts
@BeginDescription
Divisor is (n-1).
@IfMan
o(t+(nts-1)/2,x) = std1{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}
@EndifMan
@IfDoc
@BeginMath
o(t+(nts-1)/2,x) = \mbox{\bf std1}\{i(t,x), i(t+1,x), ..., i(t+nts-1,x)\}
@EndMath
@EndifDoc
@EndDescription
@EndOperator
@BeginParameter
@Item = nts
INTEGER Number of timesteps
......
......@@ -1901,7 +1901,7 @@ static char *TimselpctlHelp[] = {
static char *RunstatHelp[] = {
"NAME",
" runmin, runmax, runsum, runmean, runavg, runvar, runstd - ",
" runmin, runmax, runsum, runmean, runavg, runstd, runstd1, runvar, runvar1 - ",
" Running statistical values",
"",
"SYNOPSIS",
......@@ -1925,10 +1925,22 @@ static char *RunstatHelp[] = {
" o(t+(nts-1)/2,x) = mean{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}",
" runavg Running average",
" o(t+(nts-1)/2,x) = avg{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}",
" runvar Running variance",
" o(t+(nts-1)/2,x) = var{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}",
" runstd Running standard deviation",
" Divisor is n. ",
" ",
" o(t+(nts-1)/2,x) = std{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}",
" runstd1 Running standard deviation",
" Divisor is (n-1). ",
" ",
" o(t+(nts-1)/2,x) = std1{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}",
" runvar Running variance",
" Divisor is n. ",
" ",
" o(t+(nts-1)/2,x) = var{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}",
" runvar1 Running variance",
" Divisor is (n-1). ",
" ",
" o(t+(nts-1)/2,x) = var1{i(t,x), i(t+1,x), ..., i(t+nts-1,x)}",
"",
"PARAMETER",
" nts INTEGER Number of timesteps",
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment