---

cmEstimator Class Template Reference

#include <cmEstimator.h>

List of all members.

Public Types
typedef std::vector< TYPE >	contType
typedef contType::iterator	iter_type
Public Methods
	cmEstimator (TYPE outlier=TYPE(3), unsigned int iter=1u)
virtual	~cmEstimator ()
TYPE	outlierCut () const
contType	calculate (contType &input)
int	reject () const
Private Methods
void	initMask (unsigned int contSize)
TYPE	mean (contType &input) const
TYPE	variance (contType &input) const
void	subtractMean (contType &input, TYPE mean) const
void	cmSubtraction (contType &input, TYPE slope) const
TYPE	slope (contType &input) const
void	setToZero (contType &input, TYPE s)
Private Attributes
TYPE	m_outlier
std::vector< unsigned int >	m_mask
unsigned int	m_iter
int	m_reject

---

Detailed Description

template<typename TYPE>
class cmEstimator< TYPE >

class for emulating Common noise subtraction a la the Tell1 board M. Needham 1/03/2004

---

Member Typedef Documentation

template<typename TYPE> typedef std::vector<TYPE> cmEstimator::contType

template<typename TYPE> typedef contType::iterator cmEstimator::iter_type

---

Constructor & Destructor Documentation

template<typename TYPE> cmEstimator< TYPE >::cmEstimator (  TYPE    outlier = TYPE(3), unsigned int    iter = 1u )  [inline]

constructer. Parameters: outlier  cut. number  of iterations.

template<typename TYPE> virtual cmEstimator< TYPE >::~cmEstimator (    )  [inline, virtual]

destructer

---

Member Function Documentation

template<typename TYPE> std::vector< TYPE > cmEstimator< TYPE >::calculate (  contType &    input )  [inline]

apply the common mode correction. Parameters: input  uncorrected data. Returns: corrected data.

template<typename TYPE> void cmEstimator< TYPE >::cmSubtraction (  contType &    input, TYPE    slope )  const [inline, private]

common mode subtraction

template<typename TYPE> void cmEstimator< TYPE >::initMask (  unsigned int    contSize )  [private]

masks

template<typename TYPE> TYPE cmEstimator< TYPE >::mean (  contType &    input )  const [inline, private]

average

template<typename TYPE> TYPE cmEstimator< TYPE >::outlierCut (    )  const [inline]

Returns: outlier threshold

template<typename TYPE> int cmEstimator< TYPE >::reject (    )  const [inline]

Returns: number of outliers

template<typename TYPE> void cmEstimator< TYPE >::setToZero (  contType &    input, TYPE    s )  [inline, private]

remocve outliers

template<typename TYPE> TYPE cmEstimator< TYPE >::slope (  contType &    input )  const [inline, private]

slope calculation

template<typename TYPE> void cmEstimator< TYPE >::subtractMean (  contType &    input, TYPE    mean )  const [private]

subtract the mean

template<typename TYPE> TYPE cmEstimator< TYPE >::variance (  contType &    input )  const [inline, private]

variance

---

Member Data Documentation

template<typename TYPE> unsigned int cmEstimator::m_iter [private]

template<typename TYPE> std::vector<unsigned int> cmEstimator::m_mask [private]

template<typename TYPE> TYPE cmEstimator::m_outlier [private]

template<typename TYPE> int cmEstimator::m_reject [private]

---

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

• cmEstimator.h

---