CaloCell2ClusterMapper Class Reference

create a map of CaloCluster objects each CaloCell belongs to. More...

#include <CaloCell2ClusterMapper.h>

Inheritance diagram for CaloCell2ClusterMapper:

Collaboration diagram for CaloCell2ClusterMapper:

Public Member Functions
	CaloCell2ClusterMapper (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~CaloCell2ClusterMapper ()
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) const override
virtual StatusCode	finalize () override
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
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	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

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.

Protected Attributes
SG::WriteHandleKey< CaloCell2ClusterMap >	m_mapOutputKey
	Name of the CaloCell2ClusterMap in StoreGate.
SG::ReadHandleKey< CaloClusterContainer >	m_clusterKey
	Name of the CaloClusterContainer to use.

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
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

create a map of CaloCluster objects each CaloCell belongs to.

Version

$Id: CaloCell2ClusterMapper.h,v 1.3 2008-07-16 09:22:59 cbourdar Exp $

Author

Sven Menke menke.nosp@m.@mpp.nosp@m.mu.mp.nosp@m.g.de

Date

25-June-2004

This class is an Algorithm which creates a map pointing for each CaloCell to all CaloCluster objects from a given CaloClusterContainer it belongs to. Only the member cells of each CaloCluster in the CaloClusterContainer are considered in the map.

Definition at line 29 of file CaloCell2ClusterMapper.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

CaloCell2ClusterMapper()

CaloCell2ClusterMapper::CaloCell2ClusterMapper	(	const std::string &	name,
		ISvcLocator *	pSvcLocator )

Definition at line 42 of file CaloCell2ClusterMapper.cxx.

  : AthReentrantAlgorithm(name, pSvcLocator),
    m_mapOutputKey(""),
    m_clusterKey("")
{
 
  // Name of Cell2Cluster Map to be registered in TDS
  declareProperty("MapOutputName",m_mapOutputKey);  
  
  // Name of CaloClusterContainer to use as input
  declareProperty("ClustersName",m_clusterKey);
}

~CaloCell2ClusterMapper()

CaloCell2ClusterMapper::~CaloCell2ClusterMapper ( )

virtualdefault

Member Function Documentation

cardinality()

unsigned int AthCommonReentrantAlgorithm< Gaudi::Algorithm >::cardinality ( ) const

overridevirtualinherited

Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant.

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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 CaloCell2ClusterMapper::execute ( const EventContext & ctx ) const

overridevirtual

Definition at line 76 of file CaloCell2ClusterMapper.cxx.

                                                                        {
 
  // make a DataVector of Navigable CaloClusterContainer 
  ATH_MSG_DEBUG(" Recording Cell2Cluster Map " << m_mapOutputKey.key());
 
  SG::WriteHandle<CaloCell2ClusterMap> cell2ClusterMap ( m_mapOutputKey, ctx );
  ATH_CHECK( cell2ClusterMap.record(std::make_unique<CaloCell2ClusterMap>
                                    (SG::VIEW_ELEMENTS)) );
 
   const CaloCell_ID*               calo_id  = nullptr;
   ATH_CHECK(detStore()->retrieve(calo_id,"CaloCell_ID"));
 
  // resize it to total range of IdentifierHash for all calos
  Identifier::size_type maxRange = calo_id->calo_cell_hash_max();
  cell2ClusterMap->resize(maxRange);
  
  SG::ReadHandle<CaloClusterContainer> clusColl(m_clusterKey, ctx);
  
 
  ATH_MSG_DEBUG("CaloCluster container: " << clusColl.name()
      <<" contains " << clusColl->size() << " clusters");
 
  std::vector<double> weightedESum;
  weightedESum.resize(clusColl->size());
 
  std::vector<int> numberOfCells;
  numberOfCells.resize(clusColl->size());
 
  DataPool<Navigable<CaloClusterContainer> > navPool(maxRange);
 
  // loop over cluster collection and add each cluster to the map for 
  // each member cell
  unsigned int iClus = 0;
  for (const CaloCluster* clus : *clusColl) {
    // loop over its cell members
    CaloCluster::cell_iterator cellIter = clus->cell_begin();
    CaloCluster::cell_iterator cellIterEnd = clus->cell_end();
    for (; cellIter != cellIterEnd; cellIter++) {
      // look up the IdentifierHash for the current cell
      IdentifierHash myHashId = calo_id->calo_cell_hash((*cellIter)->ID());
      // get the existing? Navigable for this cell
      Navigable<CaloClusterContainer> *theNav = (*cell2ClusterMap)[myHashId];
      if (!theNav) {
        // create a new Navigable if it doesn't exist
        theNav = navPool.nextElementPtr();
        theNav->removeAll();
        // and store it in the vector
        (*cell2ClusterMap)[myHashId] = theNav;
      }
      // add the current cluster to the list of clusters for this cell
      theNav->putElement(clusColl.cptr(), clus);
      // add the energy*weight for this cell to the weightedESum 
      //if ( messageService()->outputLevel(name()) <= MSG::DEBUG) {
      if (msgLvl(MSG::DEBUG)) {
        weightedESum[iClus] += (clus->getCellWeight(*cellIter))
            * ((*cellIter)->energy());
        numberOfCells[iClus]++;
      }
    }
  }
 
  // compare weighted sums per cluster from the map with cluster energies
  if (msgLvl(MSG::DEBUG)) {
    double epsilon = 0.001;
    unsigned int iClus = 0;
    for (const CaloCluster* clus : *clusColl) {
      if (fabs(weightedESum[iClus] - clus->e())
          > epsilon * fabs(clus->e()))
      {
        //FIXME: WARNING printed only if msglevel <=
        ATH_MSG_WARNING( "CaloCluster has E = " << clus->e()
                         << " MeV, while weighted sum of cells gives E = "
                         << weightedESum[iClus]
                         << " MeV! Complain with the creator of the CaloClusterContainer named "
                         << m_clusterKey.key()  );
      } else {
        ATH_MSG_DEBUG( "CaloCluster and weighted sum of cell members have E = "
                       << clus->e() << " MeV, good!"  );
      }
      if (numberOfCells[iClus] != static_cast<int>(clus->getNumberOfCells())) {
        //FIXME: WARNING printed only if msglevel <=
        ATH_MSG_WARNING( "CaloCluster has N = "
                         << clus->getNumberOfCells() << " cells, while N = "
                         << numberOfCells[iClus]
                         << " cells are in the map! Something is wrong with the creation of the Map!" );
      } else {
        ATH_MSG_DEBUG( "CaloCluster with N = "
                       << clus->getNumberOfCells() << " cells is in the map, good!" );
      }
    } //end loop over clusters
  } //end if DEBUG
 
  // print the Map
  if (msgLvl(MSG::VERBOSE)) {
    for (unsigned int iHash = 0; iHash < maxRange; iHash++) {
      // get the existing? Navigable for this cell
      Navigable<CaloClusterContainer> *theNav = (*cell2ClusterMap)[iHash];
      if (theNav) {
        msg(MSG::VERBOSE) << "CaloCell with hashID " << iHash << " belongs to";
        for (const CaloCluster* pClus : *theNav) {
          // the next line assumes all cells of the cluster belong to the same
          // cell container ...
          const CaloCellContainer *cellColl = pClus->getCellContainer(
              *(pClus->cell_begin()));
          const CaloCell* pCell = cellColl->findCell(iHash);
          if (!pCell) {
            // need to find the cell in clusters member list because the
            // cluster is made of more than one cell container
            CaloCluster::cell_iterator cellIter = pClus->cell_begin();
            CaloCluster::cell_iterator cellIterEnd = pClus->cell_end();
            for (; cellIter != cellIterEnd; cellIter++) {
              pCell = (*cellIter);
              // look up the IdentifierHash for the current cell
              IdentifierHash myHashId = calo_id->calo_cell_hash(pCell->ID());
              if (((unsigned int) myHashId) == iHash)
                break;
              else
                pCell = nullptr;
            }
          }
          if (pCell)
            msg() << " Cluster with E_clus = " << pClus->e()
                << " MeV with weight w_cell = " << pClus->getCellWeight(pCell)
                << " ";
        }
        msg() << endmsg;
      }
    }
  }
 
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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

extraOutputDeps()

const DataObjIDColl & AthCommonReentrantAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 94 of file AthCommonReentrantAlgorithm.cxx.

{
  // If we didn't find any symlinks to add, just return the collection
  // from the base class.  Otherwise, return the extended collection.
  if (!m_extendedExtraObjects.empty()) {
    return m_extendedExtraObjects;
  }
  return BaseAlg::extraOutputDeps();
}

filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

finalize()

StatusCode CaloCell2ClusterMapper::finalize ( )

overridevirtual

Definition at line 69 of file CaloCell2ClusterMapper.cxx.

{
  return StatusCode::SUCCESS;
}

initialize()

StatusCode CaloCell2ClusterMapper::initialize ( )

overridevirtual

Definition at line 63 of file CaloCell2ClusterMapper.cxx.

                                              {
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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.

isClonable()

bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

Reimplemented in InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ITkPixelCablingAlg, ITkStripCablingAlg, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, and Simulation::BeamEffectsAlg.

Definition at line 68 of file AthCommonReentrantAlgorithm.cxx.

{
  // Reentrant algorithms are clonable.
  return true;
}

msg()

MsgStream & AthCommonMsg< Gaudi::Algorithm >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

virtual void AthCommonReentrantAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Definition at line 85 of file AthCommonReentrantAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonReentrantAlgorithm< Gaudi::Algorithm >::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >.

Reimplemented in HypoBase, and InputMakerBase.

Definition at line 61 of file AthCommonReentrantAlgorithm.cxx.

                                                               {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }      
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;  
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::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< Gaudi::Algorithm > >::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_clusterKey

SG::ReadHandleKey<CaloClusterContainer> CaloCell2ClusterMapper::m_clusterKey

protected

Name of the CaloClusterContainer to use.

the map is filled with all CaloCell objects which are member of at least one CaloCluster in this CaloClusterContainer.

Definition at line 52 of file CaloCell2ClusterMapper.h.

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonReentrantAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 114 of file AthCommonReentrantAlgorithm.h.

m_mapOutputKey

SG::WriteHandleKey<CaloCell2ClusterMap> CaloCell2ClusterMapper::m_mapOutputKey

protected

Name of the CaloCell2ClusterMap in StoreGate.

the map can be retrieved with this key from StoreGate.

Definition at line 45 of file CaloCell2ClusterMapper.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• CaloCell2ClusterMapper.h
• CaloCell2ClusterMapper.cxx