Monitored variables
A Class for monitored variables, that is, variables that allow one
to gather simple statistics. A Monitor is a subclass of list and
list operations can be performed on it. An object is established
using m= Monitor(name = .. ). It can be given a
unique name for use in debugging and in tracing and ylab and tlab
strings for labelling graphs.
Methods
|
|
|
|
__init__
|
__init__ (
self,
name='',
ylab='y',
tlab='t',
)
|
|
accum
|
accum (
self,
y,
t=None,
)
deprecated: accum for backward compatibility
|
|
count
|
count ( self )
deprecated: the number of observations made
|
|
histogram
|
histogram (
self,
low=0.0,
high=100.0,
nbins=10,
)
A histogram of the monitored y data values.
|
|
mean
|
mean ( self )
the simple average of the monitored variable
|
|
observe
|
observe (
self,
y,
t=None,
)
record y and t
|
|
reset
|
reset ( self, t=None )
reset the sums and counts for the monitored variable
|
|
tally
|
tally ( self, y )
deprecated: tally for backward compatibility
|
|
timeAverage
|
timeAverage ( self, t=None )
the time-average of the monitored variable.
If t is used it is assumed to be the current time,
otherwise t = now()
|
|
total
|
total ( self )
the sum of the y
|
|
tseries
|
tseries ( self )
the series of measured times
|
|
var
|
var ( self )
the sample variance of the monitored variable
|
|
yseries
|
yseries ( self )
the series of measured values
|
|