---

TkNoiseCalculator Class Reference

The abstract class for noise calculation/subtraction. More...

#include <CalibTracker/SiStripAPVAnalysis/interface/TkNoiseCalculator.h>

Inheritance diagram for TkNoiseCalculator:

List of all members.

Public Member Functions
virtual void	newEvent ()
	Tell noise calculator that a new event is available.
virtual ApvAnalysis::PedestalType	noise () const =0
	Return reconstructed noise.
virtual void	resetNoise ()=0
virtual void	setStripNoise (ApvAnalysis::PedestalType &in)=0
TkStateMachine *	status ()
	Return status flag indicating if noise values are usable.
virtual float	stripNoise (int) const =0
virtual void	updateNoise (ApvAnalysis::PedestalType &)=0
	Update noise with current event.
virtual void	updateStatus ()=0
	Request that status flag be updated.
Protected Attributes
TkStateMachine	theStatus

---

Detailed Description

The abstract class for noise calculation/subtraction.

Definition at line 10 of file TkNoiseCalculator.h.

---

Member Function Documentation

virtual void TkNoiseCalculator::newEvent

(

)

[inline, virtual]

Tell noise calculator that a new event is available.

Reimplemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

Definition at line 30 of file TkNoiseCalculator.h.

Referenced by ApvAnalysis::newEvent().

{}

virtual ApvAnalysis::PedestalType TkNoiseCalculator::noise

(

)

const [pure virtual]

Return reconstructed noise.

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

Referenced by TT6CommonModeCalculator::calculateCommonMode(), and ApvAnalysis::updateCalibration().

virtual void TkNoiseCalculator::resetNoise

(

)

[pure virtual]

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

virtual void TkNoiseCalculator::setStripNoise

(

ApvAnalysis::PedestalType &

in

)

[pure virtual]

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

Referenced by ApvAnalysis::updateCalibration().

TkStateMachine* TkNoiseCalculator::status

(

)

[inline]

Return status flag indicating if noise values are usable.

Definition at line 13 of file TkNoiseCalculator.h.

References theStatus.

{return &theStatus;}

virtual float TkNoiseCalculator::stripNoise

(

int

)

const [pure virtual]

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

virtual void TkNoiseCalculator::updateNoise

(

ApvAnalysis::PedestalType &

)

[pure virtual]

Update noise with current event.

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

Referenced by ApvAnalysis::updateCalibration().

virtual void TkNoiseCalculator::updateStatus

(

)

[pure virtual]

Request that status flag be updated.

Implemented in SimpleNoiseCalculator, and TT6NoiseCalculator.

---

Member Data Documentation

TkStateMachine TkNoiseCalculator::theStatus [protected]

Definition at line 33 of file TkNoiseCalculator.h.

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

---

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

• CalibTracker/SiStripAPVAnalysis/interface/TkNoiseCalculator.h

---