CFEL - ASG Software Suite  2.5.0
CASS
Public Member Functions | Protected Attributes | List of all members
cass::PreAverage Class Reference

short description More...

+ Inheritance diagram for cass::PreAverage:
+ Collaboration diagram for cass::PreAverage:

Public Member Functions

 PreAverage (float alpha)
 constructor. More...
 
float operator() (float currentValue, float Average_Nm1)
 operator. More...
 

Protected Attributes

float _alpha
 $\alpha$ for the average calculation More...
 

Detailed Description

short description

details

Author

Definition at line 36 of file partial_covariance.cpp.

Constructor & Destructor Documentation

cass::PreAverage::PreAverage ( float  alpha)
inlineexplicit

constructor.

initializes the $\alpha$ value

Parameters
alphaThe $\alpha$ value

Definition at line 45 of file partial_covariance.cpp.

Member Function Documentation

float cass::PreAverage::operator() ( float  currentValue,
float  Average_Nm1 
)
inline

operator.

the operator calculates the previous average using the function

where when $\alpha$ is equal to N it is a cumulative moving average.

Definition at line 56 of file partial_covariance.cpp.

Member Data Documentation

float cass::PreAverage::_alpha
protected

$\alpha$ for the average calculation

Definition at line 65 of file partial_covariance.cpp.


The documentation for this class was generated from the following file: