Condition object to keep calibration factors of TileCal channels. More...

#include <TileEMScale.h>

Collaboration diagram for TileEMScale:

Public Member Functions
	TileEMScale ()

virtual	~TileEMScale ()

bool	initialize ()

float	calibrateChannel (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude, TileRawChannelUnit::UNIT rawDataUnitIn, TileRawChannelUnit::UNIT rawDataUnitOut) const
	Calibrate a Tile channel. More...

float	applyEMScaleCalibration (unsigned int drawerIdx, unsigned int channel, float amplitude) const
	Calibrate a Tile channel to EM scale: Equalized pC -> MeV. More...

float	applyCesiumCalibration (unsigned int drawerIdx, unsigned int channel, float amplitude, bool applyLasCorr=true) const
	Apply cesium calibration constant. More...

float	applyLaserCalibration (unsigned int drawerIdx, unsigned int channel, float amplitude) const
	Apply laser correction. More...

float	applyLaserLinearCalibration (unsigned int drawerIdx, unsigned int channel, float amplitude) const
	Apply laser (PMT linearity) correction. More...

float	applyLaserNonLinearCalibration (unsigned int drawerIdx, unsigned int channel, float amplitude) const
	Apply laser (PMT nonlinearity) correction. More...

float	applyChargeCalibration (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude) const
	Apply CIS calibration: ADC counts -> pC. More...

float	applyChargLinearCalibration (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude) const
	Apply CIS linear calibration: ADC counts -> pC. More...

float	applyChargeNonLinearCalibration (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude) const
	Apply CIS non-linear calibration: ADC counts -> pC. More...

float	calibrateOnlineChannel (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude, TileRawChannelUnit::UNIT onlUnit) const
	Calibrate an online Tile channel from OnlineADCcounts to an arbitrary Online unit, no non-linear corrections are applied. More...

float	applyOnlineEMScaleCalibration (unsigned int drawerIdx, unsigned int channel, float amplitude) const
	Calibrate online chnnel to EM scale: Equalized pC -> MeV. More...

float	applyOnlineCesiumCalibration (unsigned int drawerIdx, unsigned int channel, float amplitude, bool applyLasCorr=true) const
	Apply online cesium calibration constant. More...

float	applyOnlineLaserCalibration (unsigned int drawerIdx, unsigned int channel, float amplitude) const
	Apply online laser (PMT linearity) correction. More...

float	applyOnlineChargeCalibration (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude) const
	Apply online CIS calibration: ADC counts -> pC. More...

float	undoOnlineChannelCalibration (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude, TileRawChannelUnit::UNIT onlUnit) const
	Undo the calibration applied in ROD signal reconstruction. More...

float	getCesiumReferenceLaserGain (unsigned int drawerIdx, unsigned int channel, unsigned int adc) const
	Return the PMT gain reference as measured by the laser system. More...

float	getCesiumReferenceHV (unsigned int drawerIdx, unsigned int channel) const
	Return the reference PMT HV set in last cesium calibration. More...

float	getCesiumReferenceTemperature (unsigned int drawerIdx, unsigned int channel) const
	Return the drawer temperature as measured during last cesium equalization. More...

float	getLaserFiberVariation (unsigned int drawerIdx, unsigned int channel) const
	Return laser fiber relative variation. More...

float	getLaserPartitionVariation (unsigned int drawerIdx) const
	Return laser partition relative variation. More...

float	getLaserReferenceHV (unsigned int drawerIdx, unsigned int channel) const
	Returns the reference PMT HV from appropriate laser calibration. More...

TileRawChannelUnit::UNIT	getOnlineCacheUnit () const
	Return the unit of cached online calibration constants. More...

void	setOnlineCacheUnit (TileRawChannelUnit::UNIT onlCacheUnit)
	Set online cache unit. More...

void	setCalibOflCisLin (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOflCisNln (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOflLasLin (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOflLasNln (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOflLasFib (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOflCes (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOflEms (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOnlCis (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOnlLas (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOnlCes (std::unique_ptr< TileCalibDataFlt > calibData)

void	setCalibOnlEms (std::unique_ptr< TileCalibDataFlt > calibData)

void	setMaxChannels (unsigned int maxChannels)

void	setMaxGains (unsigned int maxGains)

Protected Member Functions
void	resetOnlineCache ()
	Recache the total online calibration constant applied in ROD. More...

float	getOnlineCalibration (unsigned int drawerIdx, unsigned int channel, unsigned int adc, TileRawChannelUnit::UNIT onlUnit) const
	Return the calibration constant applied in the DSP. More...

bool	checkIfOflLaserLinearCalibrationUsed () const
	Check if offline linear laser calibration will be used. More...

bool	checkIfOflLaserNonLinearCalibrationUsed () const
	Check if offline nonlinear laser calibration will be used. More...

unsigned int	getCacheIndex (unsigned int drawerIdx, unsigned int channel, unsigned int adc) const
	Return cache index used for online calibration constants. More...

Protected Attributes
TileRawChannelUnit::UNIT	m_onlCacheUnit

std::vector< float >	m_onlCache

bool	m_isOflLasLinUsed

bool	m_isOflLasNlnUsed

std::unique_ptr< TileCalibDataFlt >	m_calibOflCisLin

std::unique_ptr< TileCalibDataFlt >	m_calibOflCisNln

std::unique_ptr< TileCalibDataFlt >	m_calibOflLasLin

std::unique_ptr< TileCalibDataFlt >	m_calibOflLasNln

std::unique_ptr< TileCalibDataFlt >	m_calibOflLasFib

std::unique_ptr< TileCalibDataFlt >	m_calibOflCes

std::unique_ptr< TileCalibDataFlt >	m_calibOflEms

std::unique_ptr< TileCalibDataFlt >	m_calibOnlCis

std::unique_ptr< TileCalibDataFlt >	m_calibOnlLas

std::unique_ptr< TileCalibDataFlt >	m_calibOnlCes

std::unique_ptr< TileCalibDataFlt >	m_calibOnlEms

bool	m_useOflLasFib

unsigned int	m_maxChannels

unsigned int	m_maxGains

unsigned int	m_drawerCacheSize

const float	m_epsilon = 1.e-5

Detailed Description

Condition object to keep calibration factors of TileCal channels.

Author: Nils Gollub nils..nosp@m.goll.nosp@m.ub@ce.nosp@m.rn.c.nosp@m.h

In order to calibrate signals from TileCal to the electromagnetic (EM) scale, a set of calibration constants need to be applied. They are obtained by the independent CIS, Laser and Cesium calibration system. The final calibration constant from pC to the EM scale is determinded in dedicated electron and muon testbeam analyses. This AlgTool provides access to the calibration constants stored in the COOL database and functions to perform the actual calibrations.

The central function of this AlgTool is calibrateChannel(), which enables the user to calibrate any TileCal channel from a given input unit (usually ADC counts or the online unit stored in the bytestream) to the desired output unit (usually MeV). In addition, functions performing the individual calibration steps are provided. They also give access to the calibration constants stored in the COOL DB by using unit amplitude as input.

A first "online" calibration is already applied during the signal reconstruction in the ROD. The used calibration constants are preserved in special database folders that do not allow to modify calibration constants for runs already taken. This ensures that the calibrations applied online in a given run can always be undone later in order to apply updated calibration constants in a reprocessing step. In addition, CIS and Laser calibrations might contain non-linear parts which are only applied during the offline calibration using this AlgTool.

Configuration

TileCalibEms needs the following TileCalibData input data set up via corresponding methods

setCalibOflCisLin(): Linear part of the the CIS calibration
setCalibOflCisNln(): Non-linear part of the the CIS calibration
setCalibOflLasLin(): Linear part of the the Laser calibration
setCalibOflLasNln(): Non-linear part of the the Laser calibration
setCalibOflCes(): Cesim calibration constants (inlcuding Laser, HV and temperature references)
setCalibOflEms(): pC to MeV calibration constants

The calibration constants applied in the ROD reconstruction have to be supplied through the "online" TileCalibData:

setCalibOnlCis(): Linear part of CIS calibration applied in ROD
setCalibOnlLas(): Linear part of Laser calibration applied in ROD
setCalibOnlCes(): Cesium factor applied in ROD
setCalibOnlEms(): EM calibration factor applied in ROD

Since the calibration factor applied in the ROD is the product of up to four numbers, associated to the four calibration steps listed above, the total ROD calibration factor is cached. The unit of the cache is set up by setOnlCacheUnit() method and should be set to the ROD output unit present in the bytestream (otherwise the total factor will be recomputed event by event). The following online cache units can be used here:

If the ROD calibration should not be undone (or is not available as for simulated data), online cache unit should be set to "Invalid" (which is the default).

Definition at line 87 of file TileEMScale.h.

Constructor & Destructor Documentation

◆ TileEMScale()

TileEMScale::TileEMScale ( )

Definition at line 15 of file TileEMScale.cxx.

                          :
   m_onlCacheUnit( TileRawChannelUnit::Invalid),
   m_onlCache(std::vector<float>(0)),
   m_isOflLasLinUsed(true),
   m_isOflLasNlnUsed(true),
   m_useOflLasFib(false),
   m_maxChannels(0),
   m_maxGains(0),
   m_drawerCacheSize(0)
 {
  
 }

◆ ~TileEMScale()

TileEMScale::~TileEMScale ( )

virtual

Definition at line 30 of file TileEMScale.cxx.

30 {

31 }

Member Function Documentation

◆ applyCesiumCalibration()

float TileEMScale::applyCesiumCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude,
		bool	applyLasCorr = `true`
	)		const

Apply cesium calibration constant.

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
amplitude	Input ampitude in pC
applyLasCorr	Apply the (not yet implemented) relative laser correction

Definition at line 208 of file TileEMScale.cxx.

                                                                                                                                 {
  
   amplitude = m_calibOflCes->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
  
   if (applyLasCorr) {
     //=== At some point a correction relative to the mono-energy laser reference
     //=== taken with each Cesium calibration run needs to be implemented here.
   }
  
   return amplitude;
 }

◆ applyChargeCalibration()

float TileEMScale::applyChargeCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude
	)		const

Apply CIS calibration: ADC counts -> pC.

Apply both the linear and non-linear part of the CIS calibration

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain
amplitude	Input ampitude in units of ADC counts

Definition at line 264 of file TileEMScale.cxx.

                                                                                                                                {
  
   //=== Linear correction
   amplitude = m_calibOflCisLin->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
  
   //=== Non-linear correction
   return m_calibOflCisNln->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
 }

◆ applyChargeNonLinearCalibration()

float TileEMScale::applyChargeNonLinearCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude
	)		const

Apply CIS non-linear calibration: ADC counts -> pC.

Apply only the non-linear part of the CIS calibration

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain
amplitude	Input ampitude in units of ADC counts

Definition at line 284 of file TileEMScale.cxx.

                                                                                                                                         {
  
   //=== Non-linear correction
   return m_calibOflCisNln->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
 }

◆ applyChargLinearCalibration()

float TileEMScale::applyChargLinearCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude
	)		const

Apply CIS linear calibration: ADC counts -> pC.

Apply only the linear part of the CIS calibration

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain
amplitude	Input ampitude in units of ADC counts

Definition at line 275 of file TileEMScale.cxx.

                                                                                                                                     {
  
   //=== Linear correction
   return m_calibOflCisLin->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
  
 }

◆ applyEMScaleCalibration()

float TileEMScale::applyEMScaleCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Calibrate a Tile channel to EM scale: Equalized pC -> MeV.

Apply the pC to MeV calibration constant

Returns: The input amplitude after calibration [MeV]

Parameters

drawerIdx	Drawer index
channel	Tile channel
amplitude	Input ampitude in pC

Definition at line 201 of file TileEMScale.cxx.

                                                                                                               {
  
   return m_calibOflEms->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
 }

◆ applyLaserCalibration()

float TileEMScale::applyLaserCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Apply laser correction.

Apply both the linear and non-linear part of the laser calibration

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
amplitude	Input ampitude in pC

Definition at line 222 of file TileEMScale.cxx.

                                                                                                             {
  
   //=== Linear correction
   if (m_isOflLasLinUsed) {
     amplitude = m_calibOflLasLin->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
   }
  
   //=== Non-linear correction
   if (m_isOflLasNlnUsed) {
     amplitude = m_calibOflLasNln->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
   }
  
   return amplitude;
 }

◆ applyLaserLinearCalibration()

float TileEMScale::applyLaserLinearCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Apply laser (PMT linearity) correction.

Apply only the linear part of the laser calibration

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
amplitude	Input ampitude in pC

Definition at line 239 of file TileEMScale.cxx.

                                                                                                                   {
  
   //=== Linear correction
   if (m_isOflLasLinUsed) {
     amplitude = m_calibOflLasLin->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
   }
  
   return amplitude;
 }

◆ applyLaserNonLinearCalibration()

float TileEMScale::applyLaserNonLinearCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Apply laser (PMT nonlinearity) correction.

Apply only the non-linear part of the laser calibration

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
amplitude	Input ampitude in pC

Definition at line 251 of file TileEMScale.cxx.

                                                                                                                      {
  
   //=== Non-linear correction
   if (m_isOflLasNlnUsed) {
     amplitude = m_calibOflLasNln->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
   }
  
   return amplitude;
 }

◆ applyOnlineCesiumCalibration()

float TileEMScale::applyOnlineCesiumCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude,
		bool	applyLasCorr = `true`
	)		const

Apply online cesium calibration constant.

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
amplitude	Input ampitude in pC
applyLasCorr	Apply the (not yet implemented) relative laser correction

Definition at line 327 of file TileEMScale.cxx.

                                                                             {
  
   amplitude = m_calibOnlCes->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
   if (applyLasCorr) {
     //=== At some point a correction relative to the mono-energy laser reference
     //=== taken with each Cesium calibration run needs to be implemented here.
   }
  
   return amplitude;
 }

◆ applyOnlineChargeCalibration()

float TileEMScale::applyOnlineChargeCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude
	)		const

Apply online CIS calibration: ADC counts -> pC.

Apply only the linear part of the CIS calibration

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain
amplitude	Input ampitude in units of ADC counts

Definition at line 349 of file TileEMScale.cxx.

                                                                                                                                      {
  
  
   //=== Linear correction only
   return m_calibOnlCis->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
 }

◆ applyOnlineEMScaleCalibration()

float TileEMScale::applyOnlineEMScaleCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Calibrate online chnnel to EM scale: Equalized pC -> MeV.

Apply the pC to MeV calibration constant

Returns: The input amplitude after calibration [MeV]

Parameters

drawerIdx	Drawer index
channel	Tile channel
amplitude	Input ampitude in pC

Definition at line 320 of file TileEMScale.cxx.

                                                                                                                     {
  
   return m_calibOnlEms->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
 }

◆ applyOnlineLaserCalibration()

float TileEMScale::applyOnlineLaserCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Apply online laser (PMT linearity) correction.

Apply only the linear part of the laser calibration

Returns: The input amplitude after calibration [pC]

Parameters

drawerIdx	Drawer index
channel	Tile channel
amplitude	Input ampitude in pC

Definition at line 341 of file TileEMScale.cxx.

                                                                                                                   {
  
   //=== Linear correction only
   return m_calibOnlLas->getCalibDrawer(drawerIdx)->getCalib(channel, 0, amplitude);
 }

◆ calibrateChannel()

float TileEMScale::calibrateChannel	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude,
		TileRawChannelUnit::UNIT	rawDataUnitIn,
		TileRawChannelUnit::UNIT	rawDataUnitOut
	)		const

Calibrate a Tile channel.

Transforms the input amplitude with unit rawDataUnitIn to output amplitude with unit rawDataUnitOut. Note that "upstream" calibrations are not supported, i.e. calibration requests from eg. MeV to ADC counts will result in an exception being thrown.

Returns: The input amplitude after calibration

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain
amplitude	Input ampitude in units of rawDataUnitIn
rawDataUnitIn	Input unit, see TileIdentifier/TileRawChannelUnit.h
rawDataUnitOut	Output unit, see TileIdentifier/TileRawChannelUnit.h

Definition at line 136 of file TileEMScale.cxx.

                                                                               {
  
   //=== Undo online calibration, result is offline ADC counts
   if (rawDataUnitIn >= TileRawChannelUnit::OnlineADCcounts) {
     if (rawDataUnitIn > TileRawChannelUnit::OnlineMegaElectronVolts) {
       throw TileCalib::InvalidRawChanUnit("TileCalibEms::channelCalib(onl)", rawDataUnitIn);
     } else if (rawDataUnitIn > TileRawChannelUnit::OnlineADCcounts) {
       amplitude = undoOnlineChannelCalibration(drawerIdx, channel, adc, amplitude, rawDataUnitIn);
     }
     rawDataUnitIn = TileRawChannelUnit::ADCcounts;
   }
  
   //=== Allow only "forward" calibration from here on
   if (rawDataUnitOut < rawDataUnitIn || rawDataUnitOut > TileRawChannelUnit::MegaElectronVolts) {
     throw TileCalib::InvalidRawChanUnit("TileCalibEms::channelCalib(out)", rawDataUnitOut);
   }
  
   //=== decide which calibrations to apply
   switch (rawDataUnitIn) {
  
     case TileRawChannelUnit::ADCcounts:
     case TileRawChannelUnit::OnlineADCcounts:
       if (rawDataUnitOut > TileRawChannelUnit::ADCcounts) {
         amplitude = applyChargeCalibration(drawerIdx, channel, adc, amplitude);
         if (rawDataUnitOut > TileRawChannelUnit::PicoCoulombs) {
           amplitude = applyLaserCalibration(drawerIdx, channel, amplitude);
           amplitude = applyCesiumCalibration(drawerIdx, channel, amplitude);
           if (rawDataUnitOut > TileRawChannelUnit::CesiumPicoCoulombs) {
             amplitude = applyEMScaleCalibration(drawerIdx, channel, amplitude);
           }
         }
       }
       break;
  
     case TileRawChannelUnit::PicoCoulombs:
       if (rawDataUnitOut > TileRawChannelUnit::PicoCoulombs) {
         amplitude = applyLaserCalibration(drawerIdx, channel, amplitude);
         amplitude = applyCesiumCalibration(drawerIdx, channel, amplitude);
         if (rawDataUnitOut > TileRawChannelUnit::CesiumPicoCoulombs) {
           amplitude = applyEMScaleCalibration(drawerIdx, channel, amplitude);
         }
       }
       break;
  
     case TileRawChannelUnit::CesiumPicoCoulombs:
       if (rawDataUnitOut > TileRawChannelUnit::CesiumPicoCoulombs) {
         amplitude = applyEMScaleCalibration(drawerIdx, channel, amplitude);
       }
       break;
  
     case TileRawChannelUnit::MegaElectronVolts:
       break;
  
     default:
       throw TileCalib::InvalidRawChanUnit("TileCalibEms::channelCalib", rawDataUnitIn);
  
   }
  
   return amplitude;
 }

◆ calibrateOnlineChannel()

float TileEMScale::calibrateOnlineChannel	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude,
		TileRawChannelUnit::UNIT	onlUnit
	)		const

Calibrate an online Tile channel from OnlineADCcounts to an arbitrary Online unit, no non-linear corrections are applied.

Transforms the input amplitude with unit rawDataUnitIn to output amplitude with unit rawDataUnitOut. Note that "upstream" calibrations are not supported, i.e. calibration requests from eg. MeV to ADC counts will result in an exception being thrown.

Returns: The total online calibration constant

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain
amplitude	Input amplitude in OnlineADCcounts unit
onlUnit	Output online unit, see TileIdentifier/TileRawChannelUnit.h

Definition at line 292 of file TileEMScale.cxx.

                                                                                            {
  
   //=== CIS calibration
   if (onlUnit > TileRawChannelUnit::OnlineADCcounts) {
     amplitude = m_calibOnlCis->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
  
     //=== LAS+CES calibration
     if (onlUnit > TileRawChannelUnit::OnlinePicoCoulombs) {
       amplitude = m_calibOnlLas->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
       amplitude = m_calibOnlCes->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
     }
  
     //=== EMSCALE calibration
     if (onlUnit > TileRawChannelUnit::OnlineCesiumPicoCoulombs) {
       amplitude = m_calibOnlEms->getCalibDrawer(drawerIdx)->getCalib(channel, adc, amplitude);
     }
   }
  
   //=== convert float to 16 bit fixed point DSP precision
   amplitude = TileCalibUtils::fixedPointPrecision(amplitude);
  
   return amplitude;
  
 }

◆ checkIfOflLaserLinearCalibrationUsed()

bool TileEMScale::checkIfOflLaserLinearCalibrationUsed ( ) const

protected

Check if offline linear laser calibration will be used.

This callback is called if offline linear laser of the proxies callback function has been called due to an updated COOL DB IOV. TileEMScale::m_isOflLasLinUsed property.

Definition at line 454 of file TileEMScale.cxx.

                                                              {
  
   const float defval = 1.0;
   const float epsilon = defval * m_epsilon;
   float val(defval);
   for (unsigned int drawerIdx = 0; drawerIdx < TileCalibUtils::MAX_DRAWERIDX; ++drawerIdx) {
     for (unsigned int chn = 0; chn < TileCalibUtils::MAX_CHAN; ++chn) {
       val = m_calibOflLasLin->getCalibDrawer(drawerIdx)->getCalib(chn, 0, defval);
       if (std::abs(val - defval) > epsilon) {
         return true;
       }
     }
   }
  
   return false;
 }

◆ checkIfOflLaserNonLinearCalibrationUsed()

bool TileEMScale::checkIfOflLaserNonLinearCalibrationUsed ( ) const

protected

Check if offline nonlinear laser calibration will be used.

This callback is called if offline nonlinear laser of the proxies callback function has been called due to an updated COOL DB IOV.TileEMScale::m_isOflLasNlnUsed property.

Definition at line 471 of file TileEMScale.cxx.

                                                                 {
  
   const float defval = 100.0;
   const float epsilon = defval * m_epsilon;
   float val(defval);
  
   for (unsigned int drawerIdx = 0; drawerIdx < TileCalibUtils::MAX_DRAWERIDX; ++drawerIdx) {
     for (unsigned int chn = 0; chn < TileCalibUtils::MAX_CHAN; ++chn) {
       val = m_calibOflLasNln->getCalibDrawer(drawerIdx)->getCalib(chn, 0, defval);
       if (std::abs(val - defval) > epsilon) {
         return true;
       }
     }
   }
  
   return false;
 }

◆ getCacheIndex()

unsigned int TileEMScale::getCacheIndex	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc
	)		const

inlineprotected

Return cache index used for online calibration constants.

Return cache index used for the calibration constant applied in the DSP

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain

Definition at line 460 of file TileEMScale.h.

                                                                                                             {
   return m_drawerCacheSize * drawerIdx + m_maxChannels * adc + channel;
 }

◆ getCesiumReferenceHV()

float TileEMScale::getCesiumReferenceHV	(	unsigned int	drawerIdx,
		unsigned int	channel
	)		const

Return the reference PMT HV set in last cesium calibration.

Returns: The PMT HV applied as result of last cesium calibration

Parameters

drawerIdx	Drawer index
channel	Tile channel

Definition at line 365 of file TileEMScale.cxx.

                                                                                           {
  
   return m_calibOflCes->getCalibDrawer(drawerIdx)->getData(channel, 0, 2);
 }

◆ getCesiumReferenceLaserGain()

float TileEMScale::getCesiumReferenceLaserGain	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc
	)		const

Return the PMT gain reference as measured by the laser system.

Continous PMT gain measurements with the laser system enable to correct for PMT gain drifts between cesium calibration runs. Corrections are applied relative to the PMT gain measured by the laser system directly after the last cesium equalization.

Returns: The PMT gain reference at the last cesium scan.

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain

Definition at line 358 of file TileEMScale.cxx.

                                                                                                                    {
  
   return m_calibOflCes->getCalibDrawer(drawerIdx)->getData(channel, adc, 1);
 }

◆ getCesiumReferenceTemperature()

float TileEMScale::getCesiumReferenceTemperature	(	unsigned int	drawerIdx,
		unsigned int	channel
	)		const

Return the drawer temperature as measured during last cesium equalization.

Returns: The drawer temperature during last cesium equalization

Parameters

drawerIdx	Drawer index
channel	Tile channel

Definition at line 372 of file TileEMScale.cxx.

                                                                                                    {
  
   return m_calibOflCes->getCalibDrawer(drawerIdx)->getData(channel, 0, 3);
 }

◆ getLaserFiberVariation()

float TileEMScale::getLaserFiberVariation	(	unsigned int	drawerIdx,
		unsigned int	channel
	)		const

Return laser fiber relative variation.

Parameters

drawerIdx	Drawer index
channel	Tile channel

Definition at line 379 of file TileEMScale.cxx.

                                                                                             {
  
   return m_calibOflLasFib->getCalibDrawer(drawerIdx)->getData(channel, 0, 0);
 }

◆ getLaserPartitionVariation()

float TileEMScale::getLaserPartitionVariation ( unsigned int drawerIdx ) const

Return laser partition relative variation.

The partition is defined by the drawerIdx which belongs to this partition. The relative partition variation values are stored in the first drawer of each partition at tile channel LAS_PART_CHAN (it is 43), which is empty both in barrel and in extended barrel tile modules. Hence its value is not useful for getLasFiber, which reads from the same source.

Parameters

drawerIdx Drawer index

Definition at line 386 of file TileEMScale.cxx.

                                                                           {
  
   unsigned int firstDrawerIdx = TileCalibUtils::getFirstDrawerInPartitionIdx(drawerIdx);
   return m_calibOflLasFib->getCalibDrawer(firstDrawerIdx)->getData( TileCalibUtils::LAS_PART_CHAN, 0, 0);
 }

◆ getLaserReferenceHV()

float TileEMScale::getLaserReferenceHV	(	unsigned int	drawerIdx,
		unsigned int	channel
	)		const

Returns the reference PMT HV from appropriate laser calibration.

Returns: The PMT HV applied as result of laser calibration

Parameters

drawerIdx	Drawer index
channel	Tile channel

Definition at line 394 of file TileEMScale.cxx.

                                                                                          {
  
   float val = -4.;
  
   const TileCalibDrawerFlt* calibDrawer = m_calibOflLasLin->getCalibDrawer(drawerIdx);
   int size = calibDrawer->getObjSizeUint32();
   if (size > 1) {
     val = m_calibOflLasLin->getCalibDrawer(drawerIdx)->getData(channel, 0, 1);
   }
  
   return val;
 }

◆ getOnlineCacheUnit()

TileRawChannelUnit::UNIT TileEMScale::getOnlineCacheUnit ( ) const

inline

Return the unit of cached online calibration constants.

Definition at line 440 of file TileEMScale.h.

                                                              {
   return m_onlCacheUnit;
 }

◆ getOnlineCalibration()

float TileEMScale::getOnlineCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		TileRawChannelUnit::UNIT	onlUnit
	)		const

protected

Return the calibration constant applied in the DSP.

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain
onlUnit	The output unit of the DSP

Definition at line 71 of file TileEMScale.cxx.

                                                                                         {
  
   float onlCalib(1.);
   //=== CIS calibration
   if (onlUnit > TileRawChannelUnit::OnlineADCcounts) {
     onlCalib = m_calibOnlCis->getCalibDrawer(drawerIdx)->getCalib(channel, adc, onlCalib);
  
     //=== LAS+CES calibration
     if (onlUnit > TileRawChannelUnit::OnlinePicoCoulombs) {
       onlCalib = m_calibOnlLas->getCalibDrawer(drawerIdx)->getCalib(channel, adc, onlCalib);
       onlCalib = m_calibOnlCes->getCalibDrawer(drawerIdx)->getCalib(channel, adc, onlCalib);
     }
     //=== EMSCALE calibration
     if (onlUnit > TileRawChannelUnit::OnlineCesiumPicoCoulombs) {
       onlCalib = m_calibOnlEms->getCalibDrawer(drawerIdx)->getCalib(channel, adc, onlCalib);
     }
   }
   //=== Convert float to 16 bit fixed point DSP precision
   onlCalib = TileCalibUtils::fixedPointPrecision(onlCalib);
  
   return onlCalib;
 }

◆ initialize()

bool TileEMScale::initialize ( )

Definition at line 35 of file TileEMScale.cxx.

                              {
  
   m_useOflLasFib = (m_calibOflLasFib != nullptr);
   m_isOflLasLinUsed = checkIfOflLaserLinearCalibrationUsed();
   m_isOflLasNlnUsed = checkIfOflLaserNonLinearCalibrationUsed();
  
   m_drawerCacheSize = m_maxChannels * m_maxGains;
   m_onlCache.resize(m_drawerCacheSize * TileCalibUtils::MAX_DRAWERIDX);
  
   if (m_onlCacheUnit >= TileRawChannelUnit::OnlineADCcounts
       && m_onlCacheUnit <= TileRawChannelUnit::OnlineMegaElectronVolts) {
  
     resetOnlineCache();
   }
  
   return true;
 }

◆ resetOnlineCache()

void TileEMScale::resetOnlineCache ( )

protected

Recache the total online calibration constant applied in ROD.

This callback is called if any of the "online" proxies callback function has been called due to an updated COOL DB IOV. The cache is cleared and refilled with the current valid values of the unit specified in the OnlCacheUnit property.

Definition at line 56 of file TileEMScale.cxx.

                                    {
  
   //=== recalculate online cache
   for (unsigned int drawerIdx = 0; drawerIdx < TileCalibUtils::MAX_DRAWERIDX; ++ drawerIdx) {
     for (unsigned int channel = 0; channel < m_maxChannels; ++channel) {
       for (unsigned int adc = 0; adc < m_maxGains; ++adc) {
         m_onlCache[getCacheIndex(drawerIdx, channel, adc)] = getOnlineCalibration(drawerIdx, channel, adc, m_onlCacheUnit);
       }
     }
   }
  
 }

◆ setCalibOflCes()

void TileEMScale::setCalibOflCes ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 428 of file TileEMScale.cxx.

                                                                           {
   m_calibOflCes = std::move(calibData);
 }

◆ setCalibOflCisLin()

void TileEMScale::setCalibOflCisLin ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 408 of file TileEMScale.cxx.

                                                                              {
   m_calibOflCisLin = std::move(calibData);
 }

◆ setCalibOflCisNln()

void TileEMScale::setCalibOflCisNln ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 412 of file TileEMScale.cxx.

                                                                              {
   m_calibOflCisNln = std::move(calibData);
 }

◆ setCalibOflEms()

void TileEMScale::setCalibOflEms ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 432 of file TileEMScale.cxx.

                                                                           {
   m_calibOflEms = std::move(calibData);
 }

◆ setCalibOflLasFib()

void TileEMScale::setCalibOflLasFib ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 424 of file TileEMScale.cxx.

                                                                              {
   m_calibOflLasFib = std::move(calibData);
 }

◆ setCalibOflLasLin()

void TileEMScale::setCalibOflLasLin ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 416 of file TileEMScale.cxx.

                                                                              {
   m_calibOflLasLin = std::move(calibData);
 }

◆ setCalibOflLasNln()

void TileEMScale::setCalibOflLasNln ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 420 of file TileEMScale.cxx.

                                                                              {
   m_calibOflLasNln = std::move(calibData);
 }

◆ setCalibOnlCes()

void TileEMScale::setCalibOnlCes ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 445 of file TileEMScale.cxx.

                                                                           {
   m_calibOnlCes = std::move(calibData);
 }

◆ setCalibOnlCis()

void TileEMScale::setCalibOnlCis ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 437 of file TileEMScale.cxx.

                                                                           {
   m_calibOnlCis = std::move(calibData);
 }

◆ setCalibOnlEms()

void TileEMScale::setCalibOnlEms ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 449 of file TileEMScale.cxx.

                                                                           {
   m_calibOnlEms = std::move(calibData);
 }

◆ setCalibOnlLas()

void TileEMScale::setCalibOnlLas ( std::unique_ptr< TileCalibDataFlt > calibData )

Definition at line 441 of file TileEMScale.cxx.

                                                                           {
   m_calibOnlLas = std::move(calibData);
 }

◆ setMaxChannels()

void TileEMScale::setMaxChannels ( unsigned int maxChannels )

inline

Definition at line 450 of file TileEMScale.h.

                                                          {
   m_maxChannels = maxChannels;
 }

◆ setMaxGains()

void TileEMScale::setMaxGains ( unsigned int maxGains )

inline

Definition at line 455 of file TileEMScale.h.

                                                    {
   m_maxGains = maxGains;
 }

◆ setOnlineCacheUnit()

void TileEMScale::setOnlineCacheUnit ( TileRawChannelUnit::UNIT onlCacheUnit )

inline

Set online cache unit.

Parameters

onlCacheUnit online cache unit

Definition at line 445 of file TileEMScale.h.

                                                                         {
   m_onlCacheUnit = onlCacheUnit;
 }

◆ undoOnlineChannelCalibration()

float TileEMScale::undoOnlineChannelCalibration	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude,
		TileRawChannelUnit::UNIT	onlUnit
	)		const

Undo the calibration applied in ROD signal reconstruction.

At the run configuration stage, calibration constants are loaded into TileCal RODs, enabling the output of the signal reconstruction run online in DSPs to be sent in units of MeV. However, in this first raw calibration only the linear part of corrections are applied. In order to apply the full (and maybe in the meantime updated) calibration including all non-linear corrections, the calibrations applied in the ROD need to be undone first.

Returns: The signal as reconstructed in the DSP in units of ADC counts.

Parameters

drawerIdx	Drawer index
channel	Tile channel
adc	Gain
amplitude	Input ampitude in online units onlUnit
onlUnit	The output unit of the DSP, preserved in the bytestream

Definition at line 97 of file TileEMScale.cxx.

                                                                                         {
  
   //=== Check if online folders are available
   if (m_onlCacheUnit == TileRawChannelUnit::Invalid) {
     throw TileCalib::InvalidRawChanUnit("TileCalibEms::channelCalib(onl)", onlUnit);
   }
  
   //=== Check for valid unit request
   if (onlUnit < TileRawChannelUnit::OnlineADCcounts
       || onlUnit > TileRawChannelUnit::OnlineMegaElectronVolts) {
     throw TileCalib::InvalidRawChanUnit("TileCalibEms::channelCalib(onl)", onlUnit);
   }
  
   float onlCalib(0.);
   //=== Look up total calib constant in cache if possible ...
   if (onlUnit == m_onlCacheUnit) {
     unsigned int idx = getCacheIndex(drawerIdx, channel, adc);
     if (idx >= m_onlCache.size()) {
       throw TileCalib::IndexOutOfRange("TileCalibEms::undoOnlineCalib", idx, m_onlCache.size());
     }
  
     onlCalib = m_onlCache[idx];
   } else {  //=== ... otherwise compute on the fly
  
     onlCalib = getOnlineCalibration(drawerIdx, channel, adc, onlUnit);
  
   }
  
   //=== Sanity check
   if (onlCalib == 0.) {
     throw TileCalib::InvalidValue("TileCalibEms::undoOnlCalib", onlCalib);
   }
  
   return amplitude / onlCalib;
 }

Member Data Documentation

◆ m_calibOflCes

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOflCes

protected

Definition at line 413 of file TileEMScale.h.

◆ m_calibOflCisLin

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOflCisLin

protected

Definition at line 408 of file TileEMScale.h.

◆ m_calibOflCisNln

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOflCisNln

protected

Definition at line 409 of file TileEMScale.h.

◆ m_calibOflEms

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOflEms

protected

Definition at line 414 of file TileEMScale.h.

◆ m_calibOflLasFib

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOflLasFib

protected

Definition at line 412 of file TileEMScale.h.

◆ m_calibOflLasLin

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOflLasLin

protected

Definition at line 410 of file TileEMScale.h.

◆ m_calibOflLasNln

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOflLasNln

protected

Definition at line 411 of file TileEMScale.h.

◆ m_calibOnlCes

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOnlCes

protected

Definition at line 419 of file TileEMScale.h.

◆ m_calibOnlCis

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOnlCis

protected

Definition at line 417 of file TileEMScale.h.

◆ m_calibOnlEms

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOnlEms

protected

Definition at line 420 of file TileEMScale.h.

◆ m_calibOnlLas

std::unique_ptr<TileCalibDataFlt> TileEMScale::m_calibOnlLas

protected

Definition at line 418 of file TileEMScale.h.

◆ m_drawerCacheSize

unsigned int TileEMScale::m_drawerCacheSize

protected

Definition at line 426 of file TileEMScale.h.

◆ m_epsilon

const float TileEMScale::m_epsilon = 1.e-5

protected

Definition at line 428 of file TileEMScale.h.

◆ m_isOflLasLinUsed

bool TileEMScale::m_isOflLasLinUsed

protected

Definition at line 403 of file TileEMScale.h.

◆ m_isOflLasNlnUsed

bool TileEMScale::m_isOflLasNlnUsed

protected

Definition at line 404 of file TileEMScale.h.

◆ m_maxChannels

unsigned int TileEMScale::m_maxChannels

protected

Definition at line 424 of file TileEMScale.h.

◆ m_maxGains

unsigned int TileEMScale::m_maxGains

protected

Definition at line 425 of file TileEMScale.h.

◆ m_onlCache

std::vector<float> TileEMScale::m_onlCache

protected

Definition at line 401 of file TileEMScale.h.

◆ m_onlCacheUnit

TileRawChannelUnit::UNIT TileEMScale::m_onlCacheUnit

protected

Definition at line 400 of file TileEMScale.h.

◆ m_useOflLasFib

bool TileEMScale::m_useOflLasFib

protected

Definition at line 422 of file TileEMScale.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TileEMScale()

◆ ~TileEMScale()

Member Function Documentation

◆ applyCesiumCalibration()

◆ applyChargeCalibration()

◆ applyChargeNonLinearCalibration()

◆ applyChargLinearCalibration()

◆ applyEMScaleCalibration()

◆ applyLaserCalibration()

◆ applyLaserLinearCalibration()

◆ applyLaserNonLinearCalibration()

◆ applyOnlineCesiumCalibration()

◆ applyOnlineChargeCalibration()

◆ applyOnlineEMScaleCalibration()

◆ applyOnlineLaserCalibration()

◆ calibrateChannel()

◆ calibrateOnlineChannel()

◆ checkIfOflLaserLinearCalibrationUsed()

◆ checkIfOflLaserNonLinearCalibrationUsed()

◆ getCacheIndex()

◆ getCesiumReferenceHV()

◆ getCesiumReferenceLaserGain()

◆ getCesiumReferenceTemperature()

◆ getLaserFiberVariation()

◆ getLaserPartitionVariation()

◆ getLaserReferenceHV()

◆ getOnlineCacheUnit()

◆ getOnlineCalibration()

◆ initialize()

◆ resetOnlineCache()

◆ setCalibOflCes()

◆ setCalibOflCisLin()

◆ setCalibOflCisNln()

◆ setCalibOflEms()

◆ setCalibOflLasFib()

◆ setCalibOflLasLin()

◆ setCalibOflLasNln()

◆ setCalibOnlCes()

◆ setCalibOnlCis()

◆ setCalibOnlEms()

◆ setCalibOnlLas()

◆ setMaxChannels()

◆ setMaxGains()

◆ setOnlineCacheUnit()

◆ undoOnlineChannelCalibration()

Member Data Documentation

◆ m_calibOflCes

◆ m_calibOflCisLin

◆ m_calibOflCisNln

◆ m_calibOflEms

◆ m_calibOflLasFib

◆ m_calibOflLasLin

◆ m_calibOflLasNln

◆ m_calibOnlCes

◆ m_calibOnlCis

◆ m_calibOnlEms

◆ m_calibOnlLas

◆ m_drawerCacheSize

◆ m_epsilon

◆ m_isOflLasLinUsed

◆ m_isOflLasNlnUsed

◆ m_maxChannels

◆ m_maxGains

◆ m_onlCache

◆ m_onlCacheUnit

◆ m_useOflLasFib