LArFCalTowerBuilderTool Class Reference

special tower builder for FCal More...

#include <LArFCalTowerBuilderTool.h>

Inheritance diagram for LArFCalTowerBuilderTool:

Collaboration diagram for LArFCalTowerBuilderTool:

Public Member Functions
	LArFCalTowerBuilderTool (const LArFCalTowerBuilderTool &)=delete
LArFCalTowerBuilderTool &	operator= (const LArFCalTowerBuilderTool &)=delete
	LArFCalTowerBuilderTool (const std::string &name, const std::string &type, const IInterface *parent)
	AlgTool constructor.
virtual	~LArFCalTowerBuilderTool ()
virtual StatusCode	execute (const EventContext &ctx, CaloTowerContainer *theContainer, const CaloCellContainer *theCell=0, const CaloTowerSeg::SubSeg *subseg=0) const override
	Run tower building and add results to the tower container.
virtual StatusCode	execute (const EventContext &ctx, CaloTowerContainer *theContainer) override
	Run tower building and add results to the tower container.
virtual StatusCode initialize	ATLAS_NOT_THREAD_SAFE () override
	common initialization
virtual void	setTowerSeg (const CaloTowerSeg &theTowerSeg) override
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
const CaloTowerSeg &	towerSeg () const
	Return the tower segmentation.
const CaloCellContainer *	getCells () const
	Retrieve cells from StoreGate.
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.

Protected Attributes
SG::ReadHandleKey< CaloCellContainer >	m_cellContainerName
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager","CaloDetDescrManager"}

Private Types
typedef LArFCalTowerStore::tower_iterator	tower_iterator
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
virtual StatusCode	initializeTool () override
void	addTower (const tower_iterator &t, const ElementLink< CaloCellContainer > &cellsEL, CaloTower *tower) const
void	iterateFull (CaloTowerContainer *towers, const ElementLink< CaloCellContainer > &cellsEL) const
void	iterateSubSeg (CaloTowerContainer *towers, const ElementLink< CaloCellContainer > &cellsEL, const CaloTowerSeg::SubSeg *subseg) const
void	runTimeInit (const EventContext &ctx) const
StatusCode	rebuildLookup (const EventContext &ctx)
	Rebuild the cell lookup table.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
double	m_minEt
const CaloCell_ID *	m_cellIdHelper
const LArFCAL_ID *	m_larFCalId
LArFCalTowerStore	m_cellStore
std::once_flag	m_onceFlag
CaloTowerSeg	m_theTowerSeg
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

Static Private Attributes
static const CaloCell_ID::SUBCALO	m_caloIndex = CaloCell_ID::LARFCAL

Detailed Description

special tower builder for FCal

LArFCalTowerBuilderTool is FCal specific. It first produces "mini-cells", which are FCal cell fragments defining the overlap between the (eta,phi) tower grid and the rectangular FCal cell. These mini-cells are then collected onto the tower grid.

Author

Peter Loch loch@.nosp@m.phsy.nosp@m.ics.a.nosp@m.rizo.nosp@m.na.ed.nosp@m.u

Date

April 30, 2004 - first implementation

Definition at line 35 of file LArFCalTowerBuilderTool.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

tower_iterator

typedef LArFCalTowerStore::tower_iterator LArFCalTowerBuilderTool::tower_iterator

private

Definition at line 71 of file LArFCalTowerBuilderTool.h.

Constructor & Destructor Documentation

LArFCalTowerBuilderTool() [1/2]

LArFCalTowerBuilderTool::LArFCalTowerBuilderTool ( const LArFCalTowerBuilderTool & )

delete

LArFCalTowerBuilderTool() [2/2]

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

AlgTool constructor.

Definition at line 26 of file LArFCalTowerBuilderTool.cxx.

  : CaloTowerBuilderToolBase(name,type,parent)
    , m_minEt(0.)
    , m_cellIdHelper(nullptr)
    , m_larFCalId(nullptr)
{
  // Et cut for minicells
  declareProperty("MinimumEt",m_minEt);
}

~LArFCalTowerBuilderTool()

LArFCalTowerBuilderTool::~LArFCalTowerBuilderTool ( )

virtual

Definition at line 38 of file LArFCalTowerBuilderTool.cxx.

                                                 {
}

Member Function Documentation

addTower()

void LArFCalTowerBuilderTool::addTower ( const tower_iterator & t, const ElementLink< CaloCellContainer > & cellsEL, CaloTower * tower ) const

inlineprivate

Definition at line 62 of file LArFCalTowerBuilderTool.cxx.

{
  LArFCalTowerStore::cell_iterator firstC = m_cellStore.firstCellofTower(t);
  LArFCalTowerStore::cell_iterator lastC = m_cellStore.lastCellofTower(t);
  // here get needed size of this vector and use it to reserve tower size.
  int ts=  m_cellStore.towerSize(t);
  double wsumE = tower->getBasicEnergy(); // this is not 0 since some towers already have cells from other calos.
  const CaloCellContainer* cells = cellsEL.getDataPtr();
  for (; firstC != lastC; ++firstC) {
 
    unsigned int ci = firstC->first;
    double weightC = firstC->second;
    int cndx = cells->findIndex(ci);
    const CaloCell* cellPtr = nullptr;
    if (cndx >= 0)
      cellPtr = (*cells)[cndx];
    // get weights
    if (cellPtr) {
      wsumE += weightC * cellPtr->e();                 // Summ up weighted energies .
      tower->addUniqueCellNoKine(cellsEL, cndx, weightC, ts); // add cells to tower.
    }
  }
  tower->setE(wsumE);  // update tower kinematics.
}

ATLAS_NOT_THREAD_SAFE()

virtual StatusCode initialize CaloTowerBuilderToolBase::ATLAS_NOT_THREAD_SAFE ( )

overridevirtualinherited

common initialization

Implements ICaloTowerBuilderToolBase.

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() [1/2]

StatusCode LArFCalTowerBuilderTool::execute ( const EventContext & ctx, CaloTowerContainer * theContainer )

overridevirtual

Run tower building and add results to the tower container.

Parameters

ctx	The current event context.
theContainer	The tower container to fill.

If the segmentation hasn't been set, take it from the tower container. This is for use by converters.

Implements CaloTowerBuilderToolBase.

Definition at line 189 of file LArFCalTowerBuilderTool.cxx.

{
  if (m_cellStore.size() == 0) {
    setTowerSeg (theContainer->towerseg());
    ATH_CHECK( rebuildLookup(ctx) );
  }
 
  return execute (ctx, theContainer, nullptr, nullptr);
}

execute() [2/2]

StatusCode LArFCalTowerBuilderTool::execute ( const EventContext & ctx, CaloTowerContainer * theContainer, const CaloCellContainer * theCell = 0, const CaloTowerSeg::SubSeg * subseg = 0 ) const

overridevirtual

Run tower building and add results to the tower container.

If a cell container is provided, use that; otherwise, fetch from SG (the key is given by a job property). If subseg is provided, then we do the building only within the rectangular region that it describes. The segmentation of the tower container must match the region over which we're running the tower building.

Parameters

ctx	The current event context.
theContainer	The tower container to fill.
theCell	The cell container to read. If null, we fetch from SG.
subseg	If provided, run tower building only within this window. The tower container segmentation must match.

Implements CaloTowerBuilderToolBase.

Definition at line 135 of file LArFCalTowerBuilderTool.cxx.

{
 
  //Init internal structure m_cellStore on first invocation
  //Alignment updates are not taken into account! 
  std::call_once(m_onceFlag,&LArFCalTowerBuilderTool::runTimeInit,this,ctx);
 
  if (m_cellStore.size() == 0) {
    ATH_MSG_ERROR("Cell store not initialized.");
    return StatusCode::FAILURE;
  }
 
  // retrieve cells
  if (!theCells) {
    theCells = getCells();
    if (!theCells) {
      return StatusCode::SUCCESS;
    }
  }
 
  // check if any FCal in container
  if ( theCells->nCellsCalo(m_caloIndex) == 0 ){
    ATH_MSG_DEBUG( "no FCal cells in CaloCellContainer, skip tool!" );
    return StatusCode::SUCCESS;
  }

  // Map Cells on Towers // 
    
  // register this calorimeter
  theTowers->setCalo(m_caloIndex);
 
  const ElementLink<CaloCellContainer> cellsEL (*theCells, 0, ctx);
  if (subseg)
    iterateSubSeg (theTowers, cellsEL, subseg);
  else
    iterateFull (theTowers, cellsEL);
 
  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

getCells()

const CaloCellContainer * CaloTowerBuilderToolBase::getCells ( ) const

protectedinherited

Retrieve cells from StoreGate.

Definition at line 59 of file CaloTowerBuilderToolBase.cxx.

{
  const CaloCellContainer* cells = nullptr;
  if (!m_cellContainerName.key().empty()) {
    cells = SG::get (m_cellContainerName);
    if (!cells) {
      ATH_MSG_WARNING("no CaloCellContainer with key <"
                      << m_cellContainerName.key() << "> found, skip tool!");
      
    }
  }
  return cells;
}

initializeTool()

StatusCode LArFCalTowerBuilderTool::initializeTool ( )

overrideprivatevirtual

Implements CaloTowerBuilderToolBase.

Definition at line 45 of file LArFCalTowerBuilderTool.cxx.

                                                  {
  ATH_CHECK( detStore()->retrieve (m_cellIdHelper, "CaloCell_ID") );
  m_larFCalId = m_cellIdHelper->fcal_idHelper();
 
  // ignore other input!
  ATH_MSG_INFO( "CaloTowerBuilder for the FCal initiated"  );
 
  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 & ICaloTowerBuilderToolBase::interfaceID ( )

inlinestaticinherited

Definition at line 70 of file ICaloTowerBuilderToolBase.h.

                                          {
    static const InterfaceID IID("ICaloTowerBuilderToolBase", 1 , 0);
    return IID;
  }

iterateFull()

void LArFCalTowerBuilderTool::iterateFull ( CaloTowerContainer * towers, const ElementLink< CaloCellContainer > & cellsEL ) const

inlineprivate

Definition at line 92 of file LArFCalTowerBuilderTool.cxx.

{
  size_t sz = towers->size();
  assert(m_cellStore.size() ==  sz);
  tower_iterator tower_it = m_cellStore.towers();
 
  for (unsigned int t = 0; t < sz; ++t, ++tower_it) {
    CaloTower* aTower = towers->getTower(t);
    addTower (tower_it, cellsEL, aTower);
  }
}

iterateSubSeg()

void LArFCalTowerBuilderTool::iterateSubSeg ( CaloTowerContainer * towers, const ElementLink< CaloCellContainer > & cellsEL, const CaloTowerSeg::SubSeg * subseg ) const

inlineprivate

Definition at line 108 of file LArFCalTowerBuilderTool.cxx.

{
  size_t sz = towers->size();
  assert(subseg->size() ==  sz);
  LArFCalTowerStore::tower_subseg_iterator tower_it = m_cellStore.towers(*subseg);
 
  for (unsigned int t = 0; t < sz; ++t, ++tower_it) {
    CaloTower* aTower = towers->getTower(tower_it.itower());
    addTower (tower_it, cellsEL, aTower);
  }
}

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

operator=()

LArFCalTowerBuilderTool & LArFCalTowerBuilderTool::operator= ( const LArFCalTowerBuilderTool & )

delete

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.

rebuildLookup()

StatusCode LArFCalTowerBuilderTool::rebuildLookup ( const EventContext & ctx )

private

Rebuild the cell lookup table.

Definition at line 205 of file LArFCalTowerBuilderTool.cxx.

{
//  std::cout << "rebuildLookup in context : " << ctx << std::endl;
  ATH_MSG_DEBUG("Building lookup table");
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle(m_caloMgrKey,ctx);
  const CaloDetDescrManager* theManager = *caloMgrHandle;
  CaloTowerContainer theTowers (towerSeg());
  if ( m_cellStore.buildLookUp(*m_cellIdHelper,
                               *theManager,
                               &theTowers) )
  {
    return StatusCode::SUCCESS;
  }
  return StatusCode::FAILURE;
}

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

runTimeInit()

void LArFCalTowerBuilderTool::runTimeInit ( const EventContext & ctx ) const

private

Definition at line 127 of file LArFCalTowerBuilderTool.cxx.

                                                                       {
    //cast alway const-ness, acceptable since this is protected under a std::call_once
    LArFCalTowerBuilderTool* thisNC ATLAS_THREAD_SAFE = const_cast<LArFCalTowerBuilderTool*>(this);
    if( thisNC->rebuildLookup(ctx)!=StatusCode::SUCCESS )
       throw std::runtime_error("LArFCalTowerBuilderTool::runTimeInit rebuildLookup table failed");
}

setTowerSeg()

void CaloTowerBuilderToolBase::setTowerSeg ( const CaloTowerSeg & theTowerSeg )

overridevirtualinherited

Implements ICaloTowerBuilderToolBase.

Definition at line 37 of file CaloTowerBuilderToolBase.cxx.

                                                                          {
 
  ATH_MSG_DEBUG(" in CaloTowerBuilderToolBase::setTowerSeg ");
  m_theTowerSeg = theTowerSeg;
  ATH_MSG_DEBUG("   neta,nphi,etamin,etamax " << theTowerSeg.neta()
      << " " << theTowerSeg.nphi() << " " << theTowerSeg.etamin()
      << " " << theTowerSeg.etamax());
}

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.

towerSeg()

const CaloTowerSeg & CaloTowerBuilderToolBase::towerSeg ( ) const

protectedinherited

Return the tower segmentation.

Definition at line 50 of file CaloTowerBuilderToolBase.cxx.

{
  return m_theTowerSeg;
}

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_caloIndex

CaloCell_ID::SUBCALO const LArFCalTowerBuilderTool::m_caloIndex = CaloCell_ID::LARFCAL

staticprivate

Definition at line 92 of file LArFCalTowerBuilderTool.h.

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> CaloTowerBuilderToolBase::m_caloMgrKey {this,"CaloDetDescrManager","CaloDetDescrManager"}

protectedinherited

Definition at line 95 of file CaloTowerBuilderToolBase.h.

{this,"CaloDetDescrManager","CaloDetDescrManager"};

m_cellContainerName

SG::ReadHandleKey<CaloCellContainer> CaloTowerBuilderToolBase::m_cellContainerName

protectedinherited

Definition at line 92 of file CaloTowerBuilderToolBase.h.

m_cellIdHelper

const CaloCell_ID* LArFCalTowerBuilderTool::m_cellIdHelper

private

Definition at line 94 of file LArFCalTowerBuilderTool.h.

m_cellStore

LArFCalTowerStore LArFCalTowerBuilderTool::m_cellStore

private

Definition at line 97 of file LArFCalTowerBuilderTool.h.

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_larFCalId

const LArFCAL_ID* LArFCalTowerBuilderTool::m_larFCalId

private

Definition at line 95 of file LArFCalTowerBuilderTool.h.

m_minEt

double LArFCalTowerBuilderTool::m_minEt

private

Definition at line 67 of file LArFCalTowerBuilderTool.h.

m_onceFlag

std::once_flag LArFCalTowerBuilderTool::m_onceFlag

mutableprivate

Definition at line 98 of file LArFCalTowerBuilderTool.h.

m_theTowerSeg

CaloTowerSeg CaloTowerBuilderToolBase::m_theTowerSeg

privateinherited

Definition at line 99 of file CaloTowerBuilderToolBase.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:

• LArFCalTowerBuilderTool.h
• LArFCalTowerBuilderTool.cxx