Pulse height parameterizations for all 512 channels of 16 modules. More...

#include <TOPCalChannelPulseHeight.h>

Inheritance diagram for TOPCalChannelPulseHeight:

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

Public Member Functions
	TOPCalChannelPulseHeight ()
	Default constructor.

void	setParameters (int moduleID, unsigned channel, double x0, double p1, double p2)
	Sets calibration for a single channel and switches status to calibrated.

void	setUnusable (int moduleID, unsigned channel)
	Switches calibration status to unusable to flag badly calibrated constant.

const TOPPulseHeightPar &	getParameters (int moduleID, unsigned channel) const
	Returns pulse height parameters for a given slot and channel.

bool	isCalibrated (int moduleID, unsigned channel) const
	Returns calibration status.

bool	isDefault (int moduleID, unsigned channel) const
	Returns calibration status.

bool	isUnusable (int moduleID, unsigned channel) const
	Returns calibration status.

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

Private Member Functions
	ClassDef (TOPCalChannelPulseHeight, 3)
	ClassDef.

Private Attributes
TOPPulseHeightPar	m_par [c_numModules][c_numChannels]
	calibration constants

EStatus	m_status [c_numModules][c_numChannels] = {{c_Default}}
	calibration status

Detailed Description

Pulse height parameterizations for all 512 channels of 16 modules.

Parameterization is: P(x) = (x/x0)^p1 * exp(-(x/x0)^p2), x0 > 0, p1 >= 0, p2 > 0 From channel gain/efficiency calibration

Definition at line 26 of file TOPCalChannelPulseHeight.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 181 of file TOPCalChannelPulseHeight.h.

         {
      c_numModules = 16,  
      c_numChannels = 512 
    };

◆ 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 32 of file TOPCalChannelPulseHeight.h.

                 {
      c_Default = 0,    
      c_Calibrated = 1, 
      c_Unusable = 2    
    };

Constructor & Destructor Documentation

◆ TOPCalChannelPulseHeight()

TOPCalChannelPulseHeight ( )

inline

Default constructor.

Definition at line 41 of file TOPCalChannelPulseHeight.h.

42 {}

Member Function Documentation

◆ getParameters()

const TOPPulseHeightPar & getParameters	(	int	moduleID,
		unsigned	channel
	)		const

inline

Returns pulse height parameters for a given slot and channel.

Parameters

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

Returns: parameters of pulse heigth distribution

Definition at line 115 of file TOPCalChannelPulseHeight.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) {
        B2WARNING("Invalid slot number, "
                  "returning parameters of slot 1 channel 0 (" << ClassName() << ")"
                  << LogVar("slot", moduleID));
        return m_par[0][0];
      }
      if (channel >= c_numChannels) {
        B2WARNING("Invalid channel, "
                  "returning parameters of channel 0 (" << ClassName() << ")"
                  << LogVar("channel", channel));
        return m_par[module][0];
      }
      return m_par[module][channel];
    }

◆ 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 139 of file TOPCalChannelPulseHeight.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) return false;
      if (channel >= c_numChannels) return false;
      return m_status[module][channel] == c_Calibrated;
    }

◆ 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 153 of file TOPCalChannelPulseHeight.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) return false;
      if (channel >= c_numChannels) return false;
      return m_status[module][channel] == c_Default;
    }

◆ 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 167 of file TOPCalChannelPulseHeight.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) return false;
      if (channel >= c_numChannels) return false;
      return m_status[module][channel] == c_Unusable;
    }

◆ setParameters()

void setParameters	(	int	moduleID,
		unsigned	channel,
		double	x0,
		double	p1,
		double	p2
	)

inline

Sets calibration for a single channel and switches status to calibrated.

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)
x0	distribution parameter (x0 > 0)
p1	distribution parameter (p1 >= 0)
p2	distribution parameter (p2 > 0)

Definition at line 52 of file TOPCalChannelPulseHeight.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) {
        B2ERROR("Invalid module number, constant not set (" << ClassName() << ")");
        return;
      }
      if (channel >= c_numChannels) {
        B2ERROR("Invalid channel number, constant not set (" << ClassName() << ")");
        return;
      }
      if (x0 <= 0) {
        B2ERROR("Invalid parameter value x0, constant not set (" << ClassName() << ")."
                << LogVar("x0", x0)
                << LogVar("slot", moduleID)
                << LogVar("channel", channel));
        return;
      }
      if (p1 < 0) {
        B2ERROR("Invalid parameter value p1, constant not set (" << ClassName() << ")."
                << LogVar("p1", p1)
                << LogVar("slot", moduleID)
                << LogVar("channel", channel));
        return;
      }
      if (p2 <= 0) {
        B2ERROR("Invalid parameter value p2, constant not set (" << ClassName() << ")."
                << LogVar("p2", p2)
                << LogVar("slot", moduleID)
                << LogVar("channel", channel));
        return;
      }
      m_par[module][channel].x0 = x0;
      m_par[module][channel].p1 = p1;
      m_par[module][channel].p2 = p2;
      m_status[module][channel] = c_Calibrated;
    }

◆ 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 95 of file TOPCalChannelPulseHeight.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) {
        B2ERROR("Invalid module number, status not set (" << ClassName() << ")");
        return;
      }
      if (channel >= c_numChannels) {
        B2ERROR("Invalid channel number, status not set (" << ClassName() << ")");
        return;
      }
      m_status[module][channel] = c_Unusable;
    }

Member Data Documentation

◆ m_par

TOPPulseHeightPar m_par[c_numModules][c_numChannels]

private

calibration constants

Definition at line 186 of file TOPCalChannelPulseHeight.h.

◆ m_status

EStatus m_status[c_numModules][c_numChannels] = {{c_Default}}

private

calibration status

Definition at line 187 of file TOPCalChannelPulseHeight.h.

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

top/dbobjects/include/TOPCalChannelPulseHeight.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ EStatus

Constructor & Destructor Documentation

◆ TOPCalChannelPulseHeight()

Member Function Documentation

◆ getParameters()

◆ isCalibrated()

◆ isDefault()

◆ isUnusable()

◆ setParameters()

◆ setUnusable()

Member Data Documentation

◆ m_par

◆ m_status