Home | Trees | Indices | Help |
---|
|
object --+ | list --+ | Monitor
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.
|
|||
|
__init__(self,
name='a_Monitor',
ylab='y',
tlab='t') x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
||
|
setHistogram(self,
name='',
low=0.0,
high=100.0,
nbins=10) Sets histogram parameters. |
||
|
observe(self,
y,
t=None) record y and t |
||
|
tally(self,
y) deprecated: tally for backward compatibility |
||
|
accum(self,
y,
t=None) deprecated: accum for backward compatibility |
||
|
reset(self,
t=None) reset the sums and counts for the monitored variable |
||
|
tseries(self) the series of measured times |
||
|
yseries(self) the series of measured values |
||
|
count(self) deprecated: the number of observations made |
||
|
total(self) the sum of the y |
||
|
mean(self) the simple average of the monitored variable |
||
|
var(self) the sample variance of the monitored variable |
||
|
timeAverage(self,
t=None) the time-average of the monitored variable. |
||
|
histogram(self,
low=0.0,
high=100.0,
nbins=10) A histogram of the monitored y data values. |
||
|
getHistogram(self) Returns a histogram based on the parameters provided in preceding call to setHistogram. |
||
|
printHistogram(self,
fmt="%s") Returns formatted frequency distribution table string from Monitor. |
||
Inherited from Inherited from |
|
|||
Inherited from |
|
|
|
|
|
|
|
|
|
|
|
|
|
the time-average of the monitored variable. If t is used it is assumed to be the current time, otherwise t = now() |
|
|
|
Home | Trees | Indices | Help |
---|
Generated by Epydoc 3.0alpha3 on Wed Jan 31 11:14:56 2007 | http://epydoc.sourceforge.net |