class TrendAcc

Trend data accumulator.

Inheritance:

Public Fields

typedef unsigned int	count_t Data type for data counts
typedef double	math_t Arithmetic data type

Public Methods

	TrendAcc (void) Default constructor
	~TrendAcc () Destructor
math_t	getAverage (void) const Running average.
math_t	getMinimum (void) const Running minimum.
math_t	getMaximum (void) const Running maximum.
count_t	getNSample (void) const Running average.
math_t	getRMS (void) const Running RMS.
math_t	getSigma (void) const Running standard deviation.
math_t	getSumSq (void) const Running sum of values squared.
void	addData (math_t point) add a single point.
void	addData (const double* vector, count_t nData) add a single point.
void	addData (const float* vector, count_t nData) add a single point.
void	addData (const int* vector, count_t nData) add a single point.
void	addData (const short* vector, count_t nData) add a single point.
void	reset (void) add a single point.

typedef unsigned int count_t

Data type for data counts

typedef double math_t

Arithmetic data type

TrendAcc(void)

Default constructor

~TrendAcc()

Destructor

math_t getAverage(void) const

Return the current running average. The running average is an average of all data points that have not been added into a trend frame.

Returns:

Average of points not entered into a Trend frame TSeries.

math_t getMinimum(void) const

Return the current running Minimum. The running minimum is the smallest of all data points after the last trend calculation.

Returns:

Minimum point not entered into a Trend frame TSeries.

math_t getMaximum(void) const

Return the current running Maximum. The running minimum is the smallest of all data points after the last trend calculation.

Returns:

Maximum point not entered into a Trend frame TSeries.

count_t getNSample(void) const

Return the current running average. The running average is calculated from all data points after te last trend calculation.

Returns:

Average of points not entered into a Trend frame TSeries.

math_t getRMS(void) const

Return the current running RMS. The running RMS is calculated from all data points after the last point added to the trend series.

Returns:

Average of points not entered into a Trend frame TSeries.

math_t getSigma(void) const

Return the current running standard deviation. The running standard deviation is calculated from all data points after the last point added to the trend series.

Returns:

Standard deviation of points not entered into a Trend TSeries.

math_t getSumSq(void) const

Return the current running sum of the values squared. The running sum squared is calculated from all data points after the last point added to the trend series.

Returns:

Average of point

void addData(math_t point)

Add a data point to the trend running average.

Parameters:

point - The value of the next element of a series.

void addData(const double* vector, count_t nData)

Add a vector of data points to the trend running average.

Parameters:

point - The value of the next element of a series.

void addData(const float* vector, count_t nData)

Add a vector of data points to the trend running average.

Parameters:

point - The value of the next element of a series.

void addData(const int* vector, count_t nData)

Add a vector of data points to the trend running average.

Parameters:

point - The value of the next element of a series.

void addData(const short* vector, count_t nData)

Add a vector of data points to the trend running average.

Parameters:

point - The value of the next element of a series.

void reset(void)

Reset the running average.

Parameters:

point - The value of the next element of a series.

alphabetic index hierarchy of classes

Please send questions and comments to zweizig_j@ligo.caltech.edu

generated by doc++