TOPCalChannelNoise Class Reference

r.m.s. More...

#include <TOPCalChannelNoise.h>

Inheritance diagram for TOPCalChannelNoise:

Collaboration diagram for TOPCalChannelNoise:

Public Types
enum	EStatus {   c_Default = 0,   c_Calibrated = 1,   c_Unusable = 2 }
	Calibration status of a constant. More...

Public Member Functions
	TOPCalChannelNoise ()
	Default constructor. More...
void	setNoise (int moduleID, unsigned channel, double rmsNoise)
	Sets the noise r.m.s for a single channel and switches status to calibrated. More...
void	setUnusable (int moduleID, unsigned channel)
	Switches calibration status to unusable to flag badly calibrated constant. More...
double	getNoise (int moduleID, unsigned channel) const
	Returns the noise r.m.s of a single channel (0 or negative: data not available) More...
bool	isCalibrated (int moduleID, unsigned channel) const
	Returns calibration status. More...
bool	isDefault (int moduleID, unsigned channel) const
	Returns calibration status. More...
bool	isUnusable (int moduleID, unsigned channel) const
	Returns calibration status. More...

Private Types
enum	{   c_numModules = 16,   c_numChannels = 512 }
	Sizes. More...

Private Member Functions
	ClassDef (TOPCalChannelNoise, 2)
	ClassDef.

Private Attributes
float	m_rmsNoise [c_numModules][c_numChannels] = {{0}}
	noise [ADC counts]
EStatus	m_status [c_numModules][c_numChannels] = {{c_Default}}
	calibration status

Detailed Description

r.m.s.

of noise for all 512 channels of 16 modules.

The noise for masked channels is undefined. It is the caller's responsibility to check for masked channels

Definition at line 36 of file TOPCalChannelNoise.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Sizes.

Enumerator
c_numModules	number of modules
c_numChannels	number of channels per module

Definition at line 162 of file TOPCalChannelNoise.h.

EStatus

enum EStatus

Calibration status of a constant.

Enumerator
c_Default	uncalibrated default value
c_Calibrated	good calibrated value
c_Unusable	bad calibrated value

Definition at line 42 of file TOPCalChannelNoise.h.

Constructor & Destructor Documentation

TOPCalChannelNoise()

TOPCalChannelNoise ( )

inline

Default constructor.

Noises are set to 0 by default.

Definition at line 52 of file TOPCalChannelNoise.h.

Member Function Documentation

getNoise()

double getNoise ( int  moduleID, unsigned  channel  ) const

inline

Returns the noise r.m.s of a single channel (0 or negative: data not available)

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Returns

r.m.s. of noise [ADC counts]

Definition at line 101 of file TOPCalChannelNoise.h.

isCalibrated()

bool isCalibrated ( int  moduleID, unsigned  channel  ) const

inline

Returns calibration status.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Returns

true, if good calibrated

Definition at line 121 of file TOPCalChannelNoise.h.

isDefault()

bool isDefault ( int  moduleID, unsigned  channel  ) const

inline

Returns calibration status.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Returns

true, if default (not calibrated)

Definition at line 135 of file TOPCalChannelNoise.h.

isUnusable()

bool isUnusable ( int  moduleID, unsigned  channel  ) const

inline

Returns calibration status.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Returns

true, if bad calibrated

Definition at line 149 of file TOPCalChannelNoise.h.

setNoise()

void setNoise ( int  moduleID, unsigned  channel, double  rmsNoise  )

inline

Sets the noise r.m.s for a single channel and switches status to calibrated.

If data for a given channel not available set noise to 0 (or just skip the call)

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)
rmsNoise	r.m.s. of noise [ADC counts]

Definition at line 61 of file TOPCalChannelNoise.h.

setUnusable()

void setUnusable ( int  moduleID, unsigned  channel  )

inline

Switches calibration status to unusable to flag badly calibrated constant.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)

Definition at line 81 of file TOPCalChannelNoise.h.

---

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

• top/dbobjects/include/TOPCalChannelNoise.h