Class to store the threshold efficiency (i.e. More...

#include <TOPCalChannelThresholdEff.h>

Inheritance diagram for TOPCalChannelThresholdEff:

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

Public Member Functions
	TOPCalChannelThresholdEff ()
	Default constructor.

void	setThrEff (int moduleID, unsigned channel, float ThrEff, short offlineThreshold)
	Sets the threshold efficiency and correspolding threshold for a single channel and switches status to calibrated (efficiency definition : ratio of integral of fit function over a range [threshold, +inf] to integral over the full range [0, +inf])

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

float	getThrEff (int moduleID, unsigned channel) const
	Returns the threshold efficiency of a single channel (1.0 if status is c_Default)

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.

short	getOfflineThreshold (int moduleID, unsigned channel) const
	Returns the threshold value used for efficiency evaluation.

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

Private Member Functions
	ClassDef (TOPCalChannelThresholdEff, 3)
	ClassDef.

Private Attributes
float	m_ThrEff [c_numModules][c_numChannels] = {{0}}
	threshold efficiency value.

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

short	m_offlineThreshold [c_numModules][c_numChannels] = {{0}}
	threshold value used for efficiency evaluation

Detailed Description

Class to store the threshold efficiency (i.e.

the efficiency for the pulse identification, function of the threshold being used in the CFD or template fit algorithm ) for all 512 channels of 16 modules. From laser scans.

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

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

Constructor & Destructor Documentation

◆ TOPCalChannelThresholdEff()

TOPCalChannelThresholdEff ( )

inline

Default constructor.

Threshold efficiencies are set to 0 by default.

Definition at line 42 of file TOPCalChannelThresholdEff.h.

42{}

Member Function Documentation

◆ getOfflineThreshold()

short getOfflineThreshold	(	int	moduleID,
		unsigned	channel
	)		const

inline

Returns the threshold value used for efficiency evaluation.

Parameters

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

Returns: offlineThreshold (in a unit of ADC counts)

Definition at line 156 of file TOPCalChannelThresholdEff.h.

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

◆ getThrEff()

float getThrEff	(	int	moduleID,
		unsigned	channel
	)		const

inline

Returns the threshold efficiency of a single channel (1.0 if status is c_Default)

Parameters

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

Returns: ThrEff

Definition at line 93 of file TOPCalChannelThresholdEff.h.

    {
      unsigned module = moduleID - 1;
      if (module >= c_numModules) {
        B2WARNING("Invalid module number, returning 0 (" << ClassName() << ")");
        return 0;
      }
      if (channel >= c_numChannels) {
        B2WARNING("Invalid channel number, returning 0 (" << ClassName() << ")");
        return 0;
      }
      if (m_status[module][channel] == c_Default) return 1.0;
      return m_ThrEff[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 114 of file TOPCalChannelThresholdEff.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 128 of file TOPCalChannelThresholdEff.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 142 of file TOPCalChannelThresholdEff.h.

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

◆ setThrEff()

void setThrEff	(	int	moduleID,
		unsigned	channel,
		float	ThrEff,
		short	offlineThreshold
	)

inline

Sets the threshold efficiency and correspolding threshold for a single channel and switches status to calibrated (efficiency definition : ratio of integral of fit function over a range [threshold, +inf] to integral over the full range [0, +inf])

Parameters

moduleID	module ID (1-based)
channel	hardware channel number (0-based)
ThrEff	channel threshold efficiency
offlineThreshold	threshold ADC counts used in efficiency evaluation

Definition at line 52 of file TOPCalChannelThresholdEff.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;
      }
      m_ThrEff[module][channel] = ThrEff;
      m_offlineThreshold[module][channel] = offlineThreshold;
      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 73 of file TOPCalChannelThresholdEff.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_offlineThreshold

short m_offlineThreshold[c_numModules][c_numChannels] = {{0}}

private

threshold value used for efficiency evaluation

Definition at line 182 of file TOPCalChannelThresholdEff.h.

◆ m_status

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

private

calibration status

Definition at line 181 of file TOPCalChannelThresholdEff.h.

◆ m_ThrEff

float m_ThrEff[c_numModules][c_numChannels] = {{0}}

private

threshold efficiency value.

0 by default.

Definition at line 180 of file TOPCalChannelThresholdEff.h.

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

top/dbobjects/include/TOPCalChannelThresholdEff.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ EStatus

Constructor & Destructor Documentation

◆ TOPCalChannelThresholdEff()

Member Function Documentation

◆ getOfflineThreshold()

◆ getThrEff()

◆ isCalibrated()

◆ isDefault()

◆ isUnusable()

◆ setThrEff()

◆ setUnusable()

Member Data Documentation

◆ m_offlineThreshold

◆ m_status

◆ m_ThrEff