TkNoiseCalculator Class Reference

#include <TkNoiseCalculator.h>

Inheritance diagram for TkNoiseCalculator:

Public Member Functions
virtual void	newEvent ()
virtual ApvAnalysis::PedestalType	noise () const =0
virtual void	resetNoise ()=0
virtual void	setStripNoise (ApvAnalysis::PedestalType &in)=0
TkStateMachine *	status ()
virtual float	stripNoise (int) const =0
virtual void	updateNoise (ApvAnalysis::PedestalType &)=0
virtual void	updateStatus ()=0
virtual	~TkNoiseCalculator ()

Protected Attributes
TkStateMachine	theStatus

Detailed Description

The abstract class for noise calculation/subtraction.

Definition at line 10 of file TkNoiseCalculator.h.

Constructor & Destructor Documentation

~TkNoiseCalculator()

virtual TkNoiseCalculator::~TkNoiseCalculator ( )

inlinevirtual

Definition at line 12 of file TkNoiseCalculator.h.

{}

Member Function Documentation

newEvent()

virtual void TkNoiseCalculator::newEvent ( )

inlinevirtual

Tell noise calculator that a new event is available

Reimplemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

Definition at line 31 of file TkNoiseCalculator.h.

{}

noise()

virtual ApvAnalysis::PedestalType TkNoiseCalculator::noise ( ) const

pure virtual

Return reconstructed noise

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

Referenced by TT6CommonModeCalculator::calculateCommonMode().

resetNoise()

virtual void TkNoiseCalculator::resetNoise ( )

pure virtual

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

setStripNoise()

virtual void TkNoiseCalculator::setStripNoise ( ApvAnalysis::PedestalType &  in )

pure virtual

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

status()

TkStateMachine* TkNoiseCalculator::status ( )

inline

Return status flag indicating if noise values are usable

Definition at line 14 of file TkNoiseCalculator.h.

{ return &theStatus; }

References theStatus.

stripNoise()

virtual float TkNoiseCalculator::stripNoise ( int  ) const

pure virtual

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

updateNoise()

virtual void TkNoiseCalculator::updateNoise ( ApvAnalysis::PedestalType &  )

pure virtual

Update noise with current event

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

updateStatus()

virtual void TkNoiseCalculator::updateStatus ( )

pure virtual

Request that status flag be updated

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

Member Data Documentation

theStatus

TkStateMachine TkNoiseCalculator::theStatus

protected

Definition at line 34 of file TkNoiseCalculator.h.

Referenced by TT6NoiseCalculator::init(), status(), TT6NoiseCalculator::updateNoise(), SimpleNoiseCalculator::updateNoise(), SimpleNoiseCalculator::updateStatus(), and TT6NoiseCalculator::updateStatus().