CaloThinCellsByClusterAlg Class Reference

Thin calorimeter cells not associated with clusters. More...

#include <CaloThinCellsByClusterAlg.h>

Inheritance diagram for CaloThinCellsByClusterAlg:

Collaboration diagram for CaloThinCellsByClusterAlg:

Public Member Functions
virtual StatusCode	initialize () override
	Gaudi initialize method.
virtual StatusCode	execute (const EventContext &ctx) const override
	Execute the algorithm.
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	decodeSamplings ()
	Decode the provided list of calorimeter samplings.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StringProperty	m_streamName { this, "StreamName", "", "Name of the stream being thinned" }
	Name of the stream being thinned.
SG::ThinningHandleKey< CaloCellContainer >	m_cells { this, "Cells", "AllCalo", "Cell container to thin." }
	Cell container to thin.
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_clusters { this, "Clusters", "", "Container of clusters for which cells should be saved." }
	Clusters to read.
SG::ThinningHandleKey< CaloClusterCellLinkContainer >	m_clusterCellLinks
	Calo Cell links for the clusters we keep cells for.
StringArrayProperty	m_samplingNames
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}
std::vector< int >	m_validSamplings
	Decoded list of samplings.
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

Thin calorimeter cells not associated with clusters.

Thinning algorithm to keep calorimeter cells used by clusters in a collection. Optionally can also save all cells in particular samplings within rectangular windows around the clusters matching the cluster size.

Definition at line 33 of file CaloThinCellsByClusterAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

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

decodeSamplings()

StatusCode CaloThinCellsByClusterAlg::decodeSamplings ( )

private

Decode the provided list of calorimeter samplings.

Definition at line 129 of file CaloThinCellsByClusterAlg.cxx.

{
  for (const std::string& name : m_samplingNames) {
    CaloSampling::CaloSample samp = CaloSampling::getSampling (name);
    if (samp == CaloSampling::Unknown) {
      ATH_MSG_ERROR (  "Calorimeter sampling" << name
                       << " is not a valid Calorimeter sampling name and will be ignored! " );
    }
    else {
      m_validSamplings.push_back (static_cast<int> (samp));
    }
  }
 
  std::sort (m_validSamplings.begin(), m_validSamplings.end());
  auto it = std::unique (m_validSamplings.begin(), m_validSamplings.end());
  m_validSamplings.erase (it, m_validSamplings.end());
 
  return StatusCode::SUCCESS;
}

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 CaloThinCellsByClusterAlg::execute ( const EventContext & ctx ) const

overridevirtual

Execute the algorithm.

Parameters

ctx	Current event context.

Definition at line 41 of file CaloThinCellsByClusterAlg.cxx.

{
  SG::ThinningHandle<CaloCellContainer> cells (m_cells, ctx);
  cells.thinAll();
 
  SG::ReadHandle<xAOD::CaloClusterContainer> clusters (m_clusters, ctx);
  if(!clusters.isValid()){
     ATH_MSG_WARNING( "Collection  " << m_clusters.key()<<" is not valid");
     return StatusCode::SUCCESS;
  }
 
  SG::ThinningHandle<CaloClusterCellLinkContainer> clusterCellLinks (m_clusterCellLinks, ctx);
  clusterCellLinks.keepAll();
 
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey,ctx};
  const CaloDetDescrManager* caloDDMgr = *caloMgrHandle;
 
 
  for (const xAOD::CaloCluster* clust : *clusters) {
    const CaloClusterCellLink* cellLinks = clust->getCellLinks();
    if (!cellLinks) {
      ATH_MSG_WARNING( "  Cluster without cell links found  in collection: " << m_clusters.key()
                       << "   ===> cells cannot be written in AOD as requested ! " );
      continue;
    }
 
    if (cellLinks->getCellContainerLink().dataID() != m_cells.key()) {
      ATH_MSG_WARNING( "  Cluster points to cell container "
                       << cellLinks->getCellContainerLink().dataID()
                       << " which is different from the cell container being thinned: "
                       << m_cells.key() << "; cluster skipped.");
      continue;
    }
 
    // nb. not using range-based for here because we don't want to actually
    //     dereference the iterators.
    CaloClusterCellLink::const_iterator it = cellLinks->begin();
    CaloClusterCellLink::const_iterator end = cellLinks->end();
    for (; it != end; ++it) {
      if (it.index() >= cells->size()) {
        ATH_MSG_WARNING( "  Cell index " << it.index()
                         << " is larger than the number of cells in "
                         << m_cells.key() << " (" << cells->size() << ")" );
        continue;
      }
      cells.keep (it.index());
    }
 
    // add additional layer cells
    if (!m_validSamplings.empty()) {
      double eta = clust->eta();
      double phi = clust->phi();
      double deta = clust->getClusterEtaSize() * 0.025;
      double dphi = clust->getClusterPhiSize() * 0.025;
      // get cell lists for each sampling we want to add
      for (int isamp : m_validSamplings) {
        CaloCellList cell_list (caloDDMgr,cells.cptr());
        cell_list.select (eta, phi, deta, dphi, isamp);
 
        ATH_MSG_DEBUG( "sampling " << isamp
                       << ", size of list = " << cell_list.ncells()
                       << ", eta = " << eta
                       << ", phi = " << phi
                       << ", deta = " << deta
                       << ", dphi = " << dphi );
 
        for (const CaloCell* cell : cell_list) {
          const IdentifierHash cellHash = cell->caloDDE()->calo_hash();
          int index = cells->findIndex (cellHash);
          if (index < 0) {
            ATH_MSG_WARNING( "  Cell hash " << cellHash
                             << " not found in cell container "
                             << m_cells.key() );
            continue;
          }
          cells.keep (index);
        } // end of cell loop
      } // end of sampling loop
    } // endif m_addSamplingCells
  }
 
  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();
  }

initialize()

StatusCode CaloThinCellsByClusterAlg::initialize ( )

overridevirtual

Gaudi initialize method.

Definition at line 21 of file CaloThinCellsByClusterAlg.cxx.

{
  ATH_CHECK( m_cells.initialize (m_streamName) );
  ATH_CHECK( m_clusters.initialize() );
  ATH_CHECK(m_caloMgrKey.initialize());
  if (m_clusterCellLinks.key().empty()) {
    m_clusterCellLinks = m_clusters.key() + "_links";
  }
  ATH_CHECK(m_clusterCellLinks.initialize(m_streamName));
  if (!m_samplingNames.empty()) {
    ATH_CHECK( decodeSamplings() );
  }
  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_caloMgrKey

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

private

Definition at line 80 of file CaloThinCellsByClusterAlg.h.

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

m_cells

SG::ThinningHandleKey<CaloCellContainer> CaloThinCellsByClusterAlg::m_cells { this, "Cells", "AllCalo", "Cell container to thin." }

private

Cell container to thin.

Definition at line 64 of file CaloThinCellsByClusterAlg.h.

{ this, "Cells", "AllCalo", "Cell container to thin." };

m_clusterCellLinks

SG::ThinningHandleKey<CaloClusterCellLinkContainer> CaloThinCellsByClusterAlg::m_clusterCellLinks

private

Initial value:

{
      this, "CaloClusterCellLinks", "",
      "Container of CaloClusterCellLinks corresponding to the clusters for which we save cells."}

Calo Cell links for the clusters we keep cells for.

Definition at line 72 of file CaloThinCellsByClusterAlg.h.

                                                                      {
      this, "CaloClusterCellLinks", "",
      "Container of CaloClusterCellLinks corresponding to the clusters for which we save cells."};

m_clusters

SG::ReadHandleKey<xAOD::CaloClusterContainer> CaloThinCellsByClusterAlg::m_clusters { this, "Clusters", "", "Container of clusters for which cells should be saved." }

private

Clusters to read.

Definition at line 68 of file CaloThinCellsByClusterAlg.h.

{ this, "Clusters", "", "Container of clusters for which cells should be saved." };

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_samplingNames

StringArrayProperty CaloThinCellsByClusterAlg::m_samplingNames

private

Initial value:

{ this, "SamplingCellsName", {},
    "List of names of samplings for which all cluster cells in a rectangular window should be saved" }

Definition at line 76 of file CaloThinCellsByClusterAlg.h.

  { this, "SamplingCellsName", {},
    "List of names of samplings for which all cluster cells in a rectangular window should be saved" };

m_streamName

StringProperty CaloThinCellsByClusterAlg::m_streamName { this, "StreamName", "", "Name of the stream being thinned" }

private

Name of the stream being thinned.

Definition at line 60 of file CaloThinCellsByClusterAlg.h.

{ this, "StreamName", "", "Name of the stream being thinned" };

m_validSamplings

std::vector<int> CaloThinCellsByClusterAlg::m_validSamplings

private

Decoded list of samplings.

Definition at line 83 of file CaloThinCellsByClusterAlg.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:

• CaloThinCellsByClusterAlg.h
• CaloThinCellsByClusterAlg.cxx