(For experts only) Calibration of TileCal channels and access to calibration factors. More...

#include <TileExpertToolEmscale.h>

Inheritance diagram for TileExpertToolEmscale:

Collaboration diagram for TileExpertToolEmscale:

Public Member Functions
	TileExpertToolEmscale (const std::string &type, const std::string &name, const IInterface *parent)

virtual	~TileExpertToolEmscale ()

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

float	doCalibEms (unsigned int drawerIdx, unsigned int channel, float amplitude) const

float	doCalibCes (unsigned int drawerIdx, unsigned int channel, float amplitude, bool applyLasCorr=true) const

float	doCalibLas (unsigned int drawerIdx, unsigned int channel, float amplitude) const

float	doCalibCis (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude) const

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

float	doCalibEmsOnl (unsigned int drawerIdx, unsigned int channel, float amplitude) const

float	doCalibCesOnl (unsigned int drawerIdx, unsigned int channel, float amplitude, bool applyLasCorr=true) const

float	doCalibLasOnl (unsigned int drawerIdx, unsigned int channel, float amplitude) const

float	doCalibCisOnl (unsigned int drawerIdx, unsigned int channel, unsigned int adc, float amplitude) const

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

float	getLasPartition (unsigned int drawerIdx) const

void	setEmOptions (const TileEmscaleCalibOptions &emOptions)

virtual StatusCode	initialize () override

virtual StatusCode	finalize () override

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

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

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

float	getLasFiber (unsigned int drawerIdx, unsigned int channel) const
	Returns laser fiber relative variation. More...

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

TileRawChannelUnit::UNIT	getOnlCacheUnit () const
	Returns the unit of cached online calibration constants. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Protected Attributes
SG::ReadCondHandleKey< TileEMScale >	m_emScaleKey

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
bool	m_setOnceCounter

TileEmscaleCalibOptions	m_emOptions

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

(For experts only) Calibration of TileCal channels and access to calibration factors.

Author: Lukas Pribyl lukas.nosp@m..pri.nosp@m.byl@c.nosp@m.ern..nosp@m.ch

This tool has the same functionality as the standard production TileCondToolEmscale tool. For the description of TileExpertToolEmscale methods please consult the file TileCondToolEmscale. The TileExpertToolEmscale tool is in addition able to switch on/off individual calibration corrections. This is set via TileIdentifier/TileEmscaleCalibOptions bitmap. If the calibration correction is switched on, the tool behaves exactly as TileCondToolEmscale, from which it inherits most of the methods. If the calibration correction is switched of (the relevant bit in m_emOptions bitmap is false), the relevant calibration method returns the input amplitude without any change. The value of the bitmap m_emOptions is set only once at the constructor.

Definition at line 26 of file TileExpertToolEmscale.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ TileExpertToolEmscale()

TileExpertToolEmscale::TileExpertToolEmscale	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Definition at line 20 of file TileExpertToolEmscale.cxx.

     : TileCondToolEmscale(type, name, parent)
     , m_setOnceCounter(false)
     , m_emOptions(0)
 {
   declareInterface<TileExpertToolEmscale>(this);
 }

◆ ~TileExpertToolEmscale()

virtual TileExpertToolEmscale::~TileExpertToolEmscale ( )

inlinevirtual

Definition at line 31 of file TileExpertToolEmscale.h.

31 {};

Member Function Documentation

◆ channelCalib()

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

Definition at line 31 of file TileExpertToolEmscale.cxx.

                                                                                                                                {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
  
   //=== Undo online calibration, result is offline ADC counts
   if (rawDataUnitIn >= TileRawChannelUnit::OnlineADCcounts) {
     if (rawDataUnitIn > TileRawChannelUnit::OnlineMegaElectronVolts) {
       throw TileCalib::InvalidRawChanUnit("TileExpertToolEmscale::channelCalib(onl)", rawDataUnitIn);
     } else if (rawDataUnitIn > TileRawChannelUnit::OnlineADCcounts) {
       amplitude = undoOnlCalib(drawerIdx, channel, adc, amplitude, rawDataUnitIn);
     }
     rawDataUnitIn = TileRawChannelUnit::ADCcounts;
   }
  
   //=== Allow only "forward" calibration from here on
   if (rawDataUnitOut < rawDataUnitIn || rawDataUnitOut > TileRawChannelUnit::MegaElectronVolts) {
     ATH_MSG_ERROR( "Invalid unit combination: "
                   << "in=" << rawDataUnitIn << " ,"
                   << "out="<< rawDataUnitOut );
     throw TileCalib::InvalidRawChanUnit("TileExpertToolEmscale::channelCalib(out)", rawDataUnitOut);
   }
  
   //=== Decide which calibrations to apply
   switch (rawDataUnitIn) {
  
     case TileRawChannelUnit::ADCcounts:
     case TileRawChannelUnit::OnlineADCcounts:
       if (rawDataUnitOut > TileRawChannelUnit::ADCcounts) {
         amplitude = doCalibCis(drawerIdx, channel, adc, amplitude);
         if (rawDataUnitOut > TileRawChannelUnit::PicoCoulombs) {
           amplitude = doCalibLas(drawerIdx, channel, amplitude);
           amplitude = doCalibCes(drawerIdx, channel, amplitude);
           if (rawDataUnitOut > TileRawChannelUnit::CesiumPicoCoulombs) {
             amplitude = doCalibEms(drawerIdx, channel, amplitude);
           }
         }
       }
       break;
  
     case TileRawChannelUnit::PicoCoulombs:
       if (rawDataUnitOut > TileRawChannelUnit::PicoCoulombs) {
         amplitude = doCalibLas(drawerIdx, channel, amplitude);
         amplitude = doCalibCes(drawerIdx, channel, amplitude);
         if (rawDataUnitOut > TileRawChannelUnit::CesiumPicoCoulombs) {
           amplitude = doCalibEms(drawerIdx, channel, amplitude);
         }
       }
       break;
  
     case TileRawChannelUnit::CesiumPicoCoulombs:
       if (rawDataUnitOut > TileRawChannelUnit::CesiumPicoCoulombs) {
         amplitude = doCalibEms(drawerIdx, channel, amplitude);
       }
       break;
  
     case TileRawChannelUnit::MegaElectronVolts:
       break;
  
     default:
       ATH_MSG_ERROR( "We should never come here: "
                     << "in=" << rawDataUnitIn << " ,"
                     << "out=" << rawDataUnitOut );
  
       throw TileCalib::InvalidRawChanUnit("TileExpertToolEmscale::channelCalib", rawDataUnitIn);
  
   }
  
   return amplitude;
  
 }

◆ channelCalibOnl()

float TileExpertToolEmscale::channelCalibOnl	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude,
		TileRawChannelUnit::UNIT	onlUnit
	)		const

Definition at line 166 of file TileExpertToolEmscale.cxx.

                                                                                                       {
  
   ATH_MSG_VERBOSE( "Recalculating total online constant for "
                   << drawerIdx << "/" << channel << "/" << adc << " , " << onlUnit );
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
  
   //=== CIS calibration
   if (onlUnit > TileRawChannelUnit::OnlineADCcounts) {
     amplitude = doCalibCisOnl(drawerIdx, channel, adc, amplitude);
     ATH_MSG_VERBOSE( "---> amplitude after CIS: " << amplitude );
  
     //=== LAS+CES calibration
     if (onlUnit > TileRawChannelUnit::OnlinePicoCoulombs) {
       amplitude = doCalibLasOnl(drawerIdx, channel, amplitude);
       ATH_MSG_VERBOSE( "---> amplitude after LAS: " << amplitude );
  
       amplitude = doCalibCesOnl(drawerIdx, channel, amplitude);
       ATH_MSG_VERBOSE( "---> amplitude after CES: " << amplitude );
  
     }
     //=== EMSCALE calibration
     if (onlUnit > TileRawChannelUnit::OnlineCesiumPicoCoulombs) {
       amplitude = doCalibEmsOnl(drawerIdx, channel, amplitude);
       ATH_MSG_VERBOSE( "---> amplitude after EMS: " << amplitude );
     }
   }
  
   //=== convert float to 16 bit fixed point DSP precision
   amplitude = TileCalibUtils::fixedPointPrecision(amplitude);
   ATH_MSG_VERBOSE( "---> amplitude in fixed point precision: " << amplitude );
  
   return amplitude;
  
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ doCalibCes()

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

Definition at line 116 of file TileExpertToolEmscale.cxx.

                                                                                                                               {
  
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OflCes)) {
     return TileCondToolEmscale::doCalibCes(drawerIdx, channel, amplitude, applyLasCorr);
   } else {
     return amplitude;
   }
  
 }

◆ doCalibCesOnl()

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

Definition at line 217 of file TileExpertToolEmscale.cxx.

                                                                                                                                  {
  
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OnlCes)) {
     return TileCondToolEmscale::doCalibCesOnl(drawerIdx, channel, amplitude, applyLasCorr);
   } else {
     return amplitude;
   }
  
 }

◆ doCalibCis()

float TileExpertToolEmscale::doCalibCis	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude
	)		const

Definition at line 147 of file TileExpertToolEmscale.cxx.

                                                                                                                              {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
  
   //=== Linear correction
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OflCisFitLin)) {
     amplitude = emScale->applyChargLinearCalibration(drawerIdx, channel, adc, amplitude);
   } // OflCisFitLin
  
   //=== non-linear correction
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OflCisFitNln)) {
     amplitude = emScale->applyChargeNonLinearCalibration(drawerIdx, channel, adc, amplitude);
   } // OflCisFitNln
  
   return amplitude;
 }

◆ doCalibCisOnl()

float TileExpertToolEmscale::doCalibCisOnl	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude
	)		const

Definition at line 241 of file TileExpertToolEmscale.cxx.

                                                                                                                                 {
  
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OnlCisLin)) {
     return TileCondToolEmscale::doCalibCisOnl(drawerIdx, channel, adc, amplitude);
   } else {
     return amplitude;
   }
  
 }

◆ doCalibEms()

float TileExpertToolEmscale::doCalibEms	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Definition at line 105 of file TileExpertToolEmscale.cxx.

                                                                                                            {
  
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OflEms)) {
     return TileCondToolEmscale::doCalibEms(drawerIdx, channel, amplitude);
   } else {
     return amplitude;
   }
 }

◆ doCalibEmsOnl()

float TileExpertToolEmscale::doCalibEmsOnl	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Definition at line 205 of file TileExpertToolEmscale.cxx.

                                                                                                               {
  
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OnlEms)) {
     return TileCondToolEmscale::doCalibEmsOnl(drawerIdx, channel, amplitude);
   } else {
     return amplitude;
   }
  
 }

◆ doCalibLas()

float TileExpertToolEmscale::doCalibLas	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Definition at line 128 of file TileExpertToolEmscale.cxx.

                                                                                                            {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
  
   //=== Linear correction
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OflLasLin)) {
     amplitude = emScale->applyLaserLinearCalibration(drawerIdx, channel, amplitude);
   } // OflLasLin
  
   //=== Non-linear correction
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OflLasNln)) {
     amplitude = emScale->applyLaserNonLinearCalibration(drawerIdx, channel, amplitude);
   } // OflLasNln
  
   return amplitude;
 }

◆ doCalibLasOnl()

float TileExpertToolEmscale::doCalibLasOnl	(	unsigned int	drawerIdx,
		unsigned int	channel,
		float	amplitude
	)		const

Definition at line 229 of file TileExpertToolEmscale.cxx.

                                                                                                               {
  
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OnlLasLin)) {
     return TileCondToolEmscale::doCalibLasOnl(drawerIdx, channel, amplitude);
   } else {
     return amplitude;
   }
  
 }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalize()

StatusCode TileCondToolEmscale::finalize ( )

overridevirtualinherited

Definition at line 48 of file TileCondToolEmscale.cxx.

                                          {
  
   ATH_MSG_DEBUG( "finalize called" );
   return StatusCode::SUCCESS;
  
 }

◆ getCesRefHv()

float TileCondToolEmscale::getCesRefHv	(	unsigned int	drawerIdx,
		unsigned int	channel
	)		const

inherited

Returns 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 170 of file TileCondToolEmscale.cxx.

                                                                                          {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
   return emScale->getCesiumReferenceHV(drawerIdx, channel);
  
 }

◆ getCesRefLas()

float TileCondToolEmscale::getCesRefLas	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc
	)		const

inherited

Returns 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 161 of file TileCondToolEmscale.cxx.

                                                                                                             {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
   return emScale->getCesiumReferenceLaserGain(drawerIdx, channel, adc);
  
 }

◆ getCesRefTemp()

float TileCondToolEmscale::getCesRefTemp	(	unsigned int	drawerIdx,
		unsigned int	channel
	)		const

inherited

Returns 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 179 of file TileCondToolEmscale.cxx.

                                                                                            {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
   return emScale->getCesiumReferenceTemperature(drawerIdx, channel);
  
 }

◆ getLasFiber()

float TileCondToolEmscale::getLasFiber	(	unsigned int	drawerIdx,
		unsigned int	channel
	)		const

inherited

Returns laser fiber relative variation.

Parameters

drawerIdx	Drawer index
channel	Tile channel

Definition at line 188 of file TileCondToolEmscale.cxx.

                                                                                          {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
   return emScale->getLaserFiberVariation(drawerIdx, channel);
  
 }

◆ getLasPartition()

float TileExpertToolEmscale::getLasPartition ( unsigned int drawerIdx ) const

Definition at line 284 of file TileExpertToolEmscale.cxx.

                                                                          {
  
   if (m_emOptions.getEmscaleCalibBit(TileEmscaleCalibOptions::OflLasPart)) {
     return TileCondToolEmscale::getLasPartition(drawerIdx);
   } else {
     return 1.0;
   }
  
 }

◆ getLasRefHv()

float TileCondToolEmscale::getLasRefHv	(	unsigned int	drawerIdx,
		unsigned int	channel
	)		const

inherited

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 206 of file TileCondToolEmscale.cxx.

                                                                                          {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
   return emScale->getLaserReferenceHV(drawerIdx, channel);
  
 }

◆ getOnlCacheUnit()

TileRawChannelUnit::UNIT TileCondToolEmscale::getOnlCacheUnit ( ) const

inherited

Returns the unit of cached online calibration constants.

Definition at line 216 of file TileCondToolEmscale.cxx.

                                                                   {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
   return emScale->getOnlineCacheUnit();
  
 }

◆ initialize()

StatusCode TileCondToolEmscale::initialize ( )

overridevirtualinherited

Definition at line 39 of file TileCondToolEmscale.cxx.

                                            {
  
   ATH_MSG_DEBUG( "In initialize()" );
   ATH_CHECK( m_emScaleKey.initialize() );
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

const InterfaceID & TileExpertToolEmscale::interfaceID ( )

static

Definition at line 14 of file TileExpertToolEmscale.cxx.

                                                       {
   return IID_TileExpertToolEmscale;
 }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setEmOptions()

void TileExpertToolEmscale::setEmOptions ( const TileEmscaleCalibOptions & emOptions )

Definition at line 296 of file TileExpertToolEmscale.cxx.

                                                                                  {
   //=== check whether the m_emOptions were not already set (except for the constructor)
   if (!m_setOnceCounter) {
     m_emOptions = emOptions;
     m_setOnceCounter = true;
     ATH_MSG_INFO( "m_emOptions set to = " << m_emOptions.getEmscaleCalibOptions() );
   } else {
     ATH_MSG_WARNING( "m_emOptions already set, original value is kept = "
                      << m_emOptions.getEmscaleCalibOptions() );
   }
 }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ undoOnlCalib()

float TileExpertToolEmscale::undoOnlCalib	(	unsigned int	drawerIdx,
		unsigned int	channel,
		unsigned int	adc,
		float	amplitude,
		TileRawChannelUnit::UNIT	onlUnit
	)		const

Definition at line 253 of file TileExpertToolEmscale.cxx.

                                                                                                    {
  
   SG::ReadCondHandle<TileEMScale> emScale(m_emScaleKey);
  
   //=== Check if online folders are available
   if (emScale->getOnlineCacheUnit() == TileRawChannelUnit::Invalid) {
     ATH_MSG_FATAL( "Trying to undo online calibration, but COOL folders were not loaded" );
     std::abort();
   }
  
   //=== Check for valid unit request
   if (onlUnit < TileRawChannelUnit::OnlineADCcounts
       || onlUnit > TileRawChannelUnit::OnlineMegaElectronVolts) {
     throw TileCalib::InvalidRawChanUnit("TileExpertToolEmscale::channelCalib(onl)", onlUnit);
   }
  
   float val(1.);
   //=== Compute total calib constant on the fly
   val = channelCalibOnl(drawerIdx, channel, adc, val, onlUnit);
  
   //=== Sanity check
   if (val == 0.) {
     throw TileCalib::InvalidValue("TileExpertToolEmscale::undoOnlCalib", val);
   }
  
   return amplitude / val;
 }

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_emOptions

TileEmscaleCalibOptions TileExpertToolEmscale::m_emOptions

private

Definition at line 58 of file TileExpertToolEmscale.h.

◆ m_emScaleKey

SG::ReadCondHandleKey<TileEMScale> TileCondToolEmscale::m_emScaleKey

protectedinherited

Initial value:

{this,

"TileEMScale", "TileEMScale", "Input Tile EMS calibration constants"}

Definition at line 259 of file TileCondToolEmscale.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_setOnceCounter

bool TileExpertToolEmscale::m_setOnceCounter

private

Definition at line 57 of file TileExpertToolEmscale.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TileExpertToolEmscale()

◆ ~TileExpertToolEmscale()

Member Function Documentation

◆ channelCalib()

◆ channelCalibOnl()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ doCalibCes()

◆ doCalibCesOnl()

◆ doCalibCis()

◆ doCalibCisOnl()

◆ doCalibEms()

◆ doCalibEmsOnl()

◆ doCalibLas()

◆ doCalibLasOnl()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ getCesRefHv()

◆ getCesRefLas()

◆ getCesRefTemp()

◆ getLasFiber()

◆ getLasPartition()

◆ getLasRefHv()

◆ getOnlCacheUnit()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setEmOptions()

◆ sysInitialize()

◆ sysStart()

◆ undoOnlCalib()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_emOptions

◆ m_emScaleKey

◆ m_evtStore

◆ m_setOnceCounter

◆ m_varHandleArraysDeclared

◆ m_vhka