CaloCellRescaler Class Reference

#include <CaloCellRescaler.h>

Inheritance diagram for CaloCellRescaler:

Collaboration diagram for CaloCellRescaler:

Public Member Functions
	CaloCellRescaler (const std::string &type, const std::string &name, const IInterface *parent)
	~CaloCellRescaler ()
virtual StatusCode	initialize () override
virtual void	MakeCorrection (CaloCell *theCell, const EventContext &ctx) const override
virtual StatusCode	execute (CaloCellContainer *cellCollection, const EventContext &ctx) const
	AthAlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Constructor with parameters:
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () 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
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.

Static Protected Member Functions
static void	setenergy (CaloCell *lar_cell, float energy)
static void	addenergy (CaloCell *lar_cell, float energy)
static void	scaleenergy (CaloCell *lar_cell, float scale)

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
float	m_factorToCells [CaloCell_ID::Unknown+1]
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 30 of file CaloCellRescaler.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

CaloCellRescaler()

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

Definition at line 9 of file CaloCellRescaler.cxx.

                                                            :
  CaloCellCorrection(type, name, parent) { 
  declareInterface<CaloCellCorrection>(this);
  declareProperty("FactorToCellsEMB0",  m_factorToCells[CaloCell_ID::PreSamplerB] = 1.0, "cells in emb0 are scaled by FactorToCellsEMB0");
  declareProperty("FactorToCellsEMB1",  m_factorToCells[CaloCell_ID::EMB1] = 1.0,        "cells in emb1 are scaled by FactorToCellsEMB1");
  declareProperty("FactorToCellsEMB2",  m_factorToCells[CaloCell_ID::EMB2] = 1.0,        "cells in emb2 are scaled by FactorToCellsEMB2");
  declareProperty("FactorToCellsEMB3",  m_factorToCells[CaloCell_ID::EMB3] = 1.0,        "cells in emb3 are scaled by FactorToCellsEMB3");
  declareProperty("FactorToCellsEME0",  m_factorToCells[CaloCell_ID::PreSamplerE] = 1.0, "cells in eme0 are scaled by FactorToCellsEME0");
  declareProperty("FactorToCellsEME1",  m_factorToCells[CaloCell_ID::EME1] = 1.0,        "cells in eme1 are scaled by FactorToCellsEME1");
  declareProperty("FactorToCellsEME2",  m_factorToCells[CaloCell_ID::EME2] = 1.0,        "cells in eme2 are scaled by FactorToCellsEME2");
  declareProperty("FactorToCellsEME3",  m_factorToCells[CaloCell_ID::EME3] = 1.0,        "cells in eme3 are scaled by FactorToCellsEME3");
  declareProperty("FactorToCellsHEC0",  m_factorToCells[CaloCell_ID::HEC0] = 1.0,        "cells in hec0 are scaled by FactorToCellsHEC0");
  declareProperty("FactorToCellsHEC1",  m_factorToCells[CaloCell_ID::HEC1] = 1.0,        "cells in hec1 are scaled by FactorToCellsHEC1");
  declareProperty("FactorToCellsHEC2",  m_factorToCells[CaloCell_ID::HEC2] = 1.0,        "cells in hec2 are scaled by FactorToCellsHEC2");
  declareProperty("FactorToCellsHEC3",  m_factorToCells[CaloCell_ID::HEC3] = 1.0,        "cells in hec3 are scaled by FactorToCellsHEC3");
  declareProperty("FactorToCellsTILEB0",m_factorToCells[CaloCell_ID::TileBar0] = 1.0,"cells in tilebar0 are scaled by FactorToCellsTILEB0");
  declareProperty("FactorToCellsTILEB1",m_factorToCells[CaloCell_ID::TileBar1] = 1.0,"cells in tilebar1 are scaled by FactorToCellsTILEB1");
  declareProperty("FactorToCellsTILEB2",m_factorToCells[CaloCell_ID::TileBar2] = 1.0,"cells in tilebar2 are scaled by FactorToCellsTILEB2");
  declareProperty("FactorToCellsTILEG1",m_factorToCells[CaloCell_ID::TileGap1] = 1.0,"cells in tilegap1 are scaled by FactorToCellsTILEG1");
  declareProperty("FactorToCellsTILEG2",m_factorToCells[CaloCell_ID::TileGap2] = 1.0,"cells in tilegap2 are scaled by FactorToCellsTILEG2");
  declareProperty("FactorToCellsTILEG3",m_factorToCells[CaloCell_ID::TileGap3] = 1.0,"cells in tilegap3 are scaled by FactorToCellsTILEG3");
  declareProperty("FactorToCellsTILEE0",m_factorToCells[CaloCell_ID::TileExt0] = 1.0,"cells in tileext0 are scaled by FactorToCellsTILEE0");
  declareProperty("FactorToCellsTILEE1",m_factorToCells[CaloCell_ID::TileExt1] = 1.0,"cells in tileext1 are scaled by FactorToCellsTILEE1");
  declareProperty("FactorToCellsTILEE2",m_factorToCells[CaloCell_ID::TileExt2] = 1.0,"cells in tileext2 are scaled by FactorToCellsTILEE2");
  declareProperty("FactorToCellsFCAL0", m_factorToCells[CaloCell_ID::FCAL0] = 1.0,      "cells in fcal0 are scaled by FactorToCellsFCAL0");
  declareProperty("FactorToCellsFCAL1", m_factorToCells[CaloCell_ID::FCAL1] = 1.0,      "cells in fcal1 are scaled by FactorToCellsFCAL1");
  declareProperty("FactorToCellsFCAL2", m_factorToCells[CaloCell_ID::FCAL2] = 1.0,      "cells in fcal2 are scaled by FactorToCellsFCAl2");
  declareProperty("FactorToCellsMBTS",  m_factorToCells[CaloCell_ID::Unknown] = 1.0,     "cells in MBTS are scaled by FactorToCellsMBTS");
}

~CaloCellRescaler()

CaloCellRescaler::~CaloCellRescaler ( )

default

Member Function Documentation

addenergy()

void CaloCellCorrection::addenergy ( CaloCell * lar_cell, float energy )

staticprotectedinherited

Definition at line 86 of file CaloCellCorrection.cxx.

{
  theCell->addEnergy( energy );
}

AthAlgTool()

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

inherited

Constructor with parameters:

Definition at line 31 of file AthAlgTool.cxx.

                                       : 
  AthCommonDataStore<AthCommonMsg<AlgTool>> ( type, name, parent )
{
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty ( Gaudi::Property< T, V, H > & 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());
 
  }

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & 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.

{ return m_detStore; }

evtStore()

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.

{ return m_evtStore; }

execute()

StatusCode CaloCellCorrection::execute ( CaloCellContainer * cellCollection, const EventContext & ctx ) const

virtualinherited

Definition at line 50 of file CaloCellCorrection.cxx.

{
 
  ATH_MSG_DEBUG("Executing CaloCellCorrection");
 
  if (!cellCollection) {
    ATH_MSG_ERROR( "Cell Correction tool receives invalid cell Collection"  );
    return StatusCode::FAILURE;
  }
 
  // Loop over all the CaloCell Objects and call Make Correction.
  // Note that this is the base class of all the concrete correction
  // classes which implement a Make Correction method.
 
  for (CaloCell* cell : *cellCollection) {
    MakeCorrection ( cell, ctx );
  }
 
  // Done, Return success
 
  return StatusCode::SUCCESS;
 
}

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

initialize()

StatusCode CaloCellRescaler::initialize ( )

overridevirtual

Definition at line 45 of file CaloCellRescaler.cxx.

                                        {
  ATH_MSG_INFO( " initialization "  );
  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 & CaloCellCorrection::interfaceID ( )

inlinestaticinherited

Definition at line 51 of file CaloCellCorrection.h.

{ return IID_CaloCellCorrection;}

MakeCorrection()

void CaloCellRescaler::MakeCorrection ( CaloCell * theCell, const EventContext & ctx ) const

overridevirtual

Implements CaloCellCorrection.

Definition at line 51 of file CaloCellRescaler.cxx.

{
  const CaloDetDescrElement* caloDDE = theCell->caloDDE();
  if (caloDDE) {
    theCell->scaleEnergy( m_factorToCells[caloDDE->getSampling()] );
  }
  }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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();
  }

scaleenergy()

void CaloCellCorrection::scaleenergy ( CaloCell * lar_cell, float scale )

staticprotectedinherited

Definition at line 91 of file CaloCellCorrection.cxx.

{
  theCell->scaleEnergy( scale );
}

setenergy()

void CaloCellCorrection::setenergy ( CaloCell * lar_cell, float energy )

staticprotectedinherited

Definition at line 81 of file CaloCellCorrection.cxx.

{
  theCell->setEnergy( energy );
}

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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

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.

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_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_factorToCells

float CaloCellRescaler::m_factorToCells[CaloCell_ID::Unknown+1]

private

Definition at line 45 of file CaloCellRescaler.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:

• CaloCellRescaler.h
• CaloCellRescaler.cxx