CaloTopoTowerAlg Class Reference

============================================================ CaloTopoTowerAlg.cxx, (c) ATLAS Detector software Calorimeter/CaloRec/CaloTopoTowerAlg More...

#include <CaloTopoTowerAlg.h>

Inheritance diagram for CaloTopoTowerAlg:

Collaboration diagram for CaloTopoTowerAlg:

Public Member Functions
	CaloTopoTowerAlg (const std::string &name, ISvcLocator *pSvcLocator)
	AlgTool constructor.
virtual	~CaloTopoTowerAlg ()
	Destructor.
virtual StatusCode	initialize () override
	initialize
virtual StatusCode	finalize () override
	finalize
virtual StatusCode	execute (const EventContext &ctx) const override
	Execute.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
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
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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 Navigable< CaloClusterContainer >	nav_t
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
SG::ReadHandleKey< CaloCell2ClusterMap >	m_cellToClusterMapKey {this, "Cell2ClusterMapName", "CaloCell2TopoCluster"}
SG::ReadHandleKey< CaloCellContainer >	m_cellContainerKey {this, "CellContainerName", "AllCalo"}
SG::ReadHandleKey< CaloTowerContainer >	m_towerContainerKey {this, "InputTowerContainerName", "CmbTower"}
SG::WriteHandleKey< CaloTowerContainer >	m_newTowerContainerKey {this, "OutputTowerContainerName", "TopoTower"}
Gaudi::Property< double >	m_minimumCellEnergy {this, "MinimumCellEnergy", -1000000000.0}
Gaudi::Property< double >	m_minimumClusterEnergy {this, "MinimumClusterEnergy", -1000000000.0}
Gaudi::Property< bool >	m_useCellWeights {this, "useCellWeight", true}
SG::ReadCondHandleKey< CaloNoise >	m_noiseCDOKey {this,"CaloNoiseKey","totalNoise","SG Key of CaloNoise data object"}
	Key of the CaloNoise Conditions data object.
Gaudi::Property< float >	m_cellESignificanceThreshold {this, "CellEnergySignificance", -1.f}
Gaudi::Property< std::vector< std::string > >	m_includedCalos {this, "IncludedCalos", {}}
std::vector< CaloCell_ID::SUBCALO >	m_caloIndices
bool	m_caloSelection {false}
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

============================================================ CaloTopoTowerAlg.cxx, (c) ATLAS Detector software Calorimeter/CaloRec/CaloTopoTowerAlg

Build towers from raw cells that have been taken out of topo clusters. In this way, we can create noise suppressed raw towers to be saved in the AOD and thus allows re-calibration and re-do MET.

Authors :

Author

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

Ariel Schwartzman sch@s.nosp@m.lac..nosp@m.stanf.nosp@m.ord..nosp@m.edu

David W. Miller David.nosp@m..Mil.nosp@m.ler@s.nosp@m.lac..nosp@m.stanf.nosp@m.ord..nosp@m.edu

Date : 25 February 2009

Concrete algorithm for building noise suppressed CaloTowers from standard towers using cells from topo-clusters

CaloTopoTowerAlg fills CaloCells which are used in topological clusters into CaloTowers for the LAr and Tile Calorimeters.

Author

David W. Miller David.nosp@m..W.M.nosp@m.iller.nosp@m.@cer.nosp@m.n.ch

Date

25 February 2009 - port from JetRecTool

Definition at line 52 of file CaloTopoTowerAlg.h.

Member Typedef Documentation

nav_t

typedef Navigable<CaloClusterContainer> CaloTopoTowerAlg::nav_t

private

Definition at line 90 of file CaloTopoTowerAlg.h.

StoreGateSvc_t

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

privateinherited

Definition at line 376 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

CaloTopoTowerAlg()

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

AlgTool constructor.

============================================================ CaloTopoTowerAlg.cxx, (c) ATLAS Detector software Calorimeter/CaloRec/CaloTopoTowerAlg

Build towers from raw cells that have been taken out of topo clusters. In this way, we can create noise suppressed raw towers to be saved in the AOD and thus allows re-calibration and re-do MET.

Authors :

Author

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

Ariel Schwartzman sch@s.nosp@m.lac..nosp@m.stanf.nosp@m.ord..nosp@m.edu

David W. Miller David.nosp@m..Mil.nosp@m.ler@s.nosp@m.lac..nosp@m.stanf.nosp@m.ord..nosp@m.edu

Date : 25 February 2009

==============================================

DEFAULT CONSTRUCTOR

Definition at line 30 of file CaloTopoTowerAlg.cxx.

                                                                                :
   AthReentrantAlgorithm(name, pSvcLocator)
{
}

~CaloTopoTowerAlg()

CaloTopoTowerAlg::~CaloTopoTowerAlg ( )

virtualdefault

Destructor.

==============================================

DESTRUCTOR

Member Function Documentation

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

overridevirtual

Execute.

==============================================

EXECUTE

Say hello

retrieve existing Tower container

create new tower container with same tower segmentation and record it to StoreGate

get CaloCell container from StoreGate

+++ pick up CaloCell2ClusterMap from StoreGate

Get CaloNoise CDO

+++ consistency: pick up CaloClusterContainer pointer from map

+++ loop on towers

+++ loop cells in old tower

Various counters for keeping track of energy added to this tower

+++ Look at all cells in this tower

Require that the cell have a minimum energy and energy significance

Require that the cell be used in at least one cluster

+++ Loop over all clusters associated to this cell

filter clusters according to cluster energy

Set tower energy according to the energy from cells in clusters passing selections

Definition at line 103 of file CaloTopoTowerAlg.cxx.

{
  ATH_MSG_DEBUG( "In CaloTopoTowerAlg::execute()"  );

  
  SG::ReadHandle<CaloTowerContainer> towerContainer( m_towerContainerKey, ctx );
  if ( !towerContainer.isValid()) {
     ATH_MSG_WARNING( " cannot retrieve tower container with key " << towerContainer.name()  );
     return StatusCode::SUCCESS;
  }
 

  SG::WriteHandle<CaloTowerContainer> newTowerContainer(m_newTowerContainerKey, ctx);  
  if (newTowerContainer.record( std::make_unique<CaloTowerContainer> (towerContainer->towerseg()) ).isFailure()){
    ATH_MSG_WARNING( " cannot record new tower container with key " << towerContainer.name()  );
    return StatusCode::SUCCESS;
  }
  newTowerContainer->init();

  SG::ReadHandle<CaloCellContainer> theCells(m_cellContainerKey, ctx);
  if ( !theCells.isValid()) {
     ATH_MSG_WARNING( " cannot retrieve cell container with key " << theCells.name()  );
     return StatusCode::SUCCESS;
  }
 
  // EL to the container, to allow making other ELs quickly.
  ElementLink<CaloCellContainer> theCellsEL (m_cellContainerKey.key(), 0, ctx);

  const CaloClusterContainer* clusterContainer = nullptr;
  
  SG::ReadHandle<CaloCell2ClusterMap> cellToClusterMap(  m_cellToClusterMapKey, ctx );
  
  if ( !cellToClusterMap.isValid() )
  {
    ATH_MSG_WARNING( "cannot retrieve CaloCell2ClusterMap with key <"
                     << cellToClusterMap.name() << ">" );
    return StatusCode::SUCCESS;
  }
  ATH_MSG_DEBUG( "Successfully retrieved CaloCell2ClusterMap <"<< cellToClusterMap.name() << ">" );

  SG::ReadCondHandle<CaloNoise> noiseHdl{m_noiseCDOKey,ctx};
  const CaloNoise* noise=*noiseHdl;
 

  CaloCell2ClusterMap::const_iterator fClusMap(cellToClusterMap->begin());
  CaloCell2ClusterMap::const_iterator lClusMap(cellToClusterMap->end());
  ATH_MSG_DEBUG( "Starting loop over Navigable CaloCell2ClusterMap"  );
  while ( clusterContainer == nullptr && fClusMap != lClusMap )
  {
    ATH_MSG_VERBOSE( "In loop over Navigable CaloCell2ClusterMap"  );
    if (*fClusMap) 
    {
      // Pick first Navigable and then ask first entry in this
      // Navigable for the pointer to the CaloClusterContainer.
      // This should be sufficient because all entries should 
      // have the same pointer. (TBC)
      ATH_MSG_DEBUG( "CaloCell2ClusterMap has entry"  );
      const nav_t* pNav = (*fClusMap);
      clusterContainer = pNav->getContainer(pNav->begin());
      ATH_MSG_DEBUG( "Successfully picked up CaloClusterContainer "  );
    }
    else ++fClusMap;
  }
  
  // Make sure the cluster container is not NULL
  if ( clusterContainer == nullptr )
  {
    if (!theCells->empty() ) {  
      ATH_MSG_WARNING( "No cluster found from  CaloCell2ClusterMap, tool unusable" );
      return StatusCode::SUCCESS;
    }
    else {
      ATH_MSG_DEBUG( " empty calorimeter event .. return "  );
      return StatusCode::SUCCESS;
    }
  }
  else ATH_MSG_DEBUG( "Size of CaloClusterContainer = " << clusterContainer->size()  );
  
  //  (*towerIter) is the ITERATOR over TOWERS
  //  (*cellInTowerIter) is the ITERATOR over CELLS for this TOWER
 
  ATH_MSG_DEBUG( "Beginning loop over tower grid"  );
 
  for (const CaloTower* theTower : *towerContainer) {
    int towerIndex = towerContainer->getTowerIndex(theTower);
 
    CaloTower* newTower = newTowerContainer->getTower(towerIndex);
  
    ATH_MSG_VERBOSE( "In loop over tower grid: tower eta-phi" << theTower->eta() << " " << theTower->phi()  );
    CaloTower::cell_iterator cellInTowerIter(theTower->cell_begin());
    CaloTower::cell_iterator lastCellInTower(theTower->cell_end());
    
    double energyTower = 0.0;
    double totalAttachedClusterEnergy = 0.0;
    int    numberOfCellsInTower = 0;
    int    numberOfAttachedCellsInTower = 0;
    int    numberOfClustersInTower = 0;
    int    totalNumberOfCellsInAttachedClusters = 0;
    
    ATH_MSG_VERBOSE( "Now looking at all cells in this tower"  );
    for ( ; cellInTowerIter != lastCellInTower; cellInTowerIter++ )
    {
      numberOfCellsInTower++;
      // geometrical cell weight in towers
      // **** Note that in the header it says that this gets the kinematic weight
      // **** is this somehow different from the geometrical weight?
      double signedE                = 0.0;                         // zero-out the energy for this cell in case we can't get it from the map
      double weight                 = theTower->getCellWeight(cellInTowerIter);     // get the weight of this cell in the tower
 
      const CaloCell* cell = (*cellInTowerIter);
      if (!cell) continue;
      
      size_t globalIndex=0;
      if (!(theTower->getCellIndex(cell,globalIndex)) ) {
        ATH_MSG_WARNING( " cannot find back cell index "  );
        continue;
      }
 
      if (m_caloSelection) {
        CaloCell_ID::SUBCALO iCaloNum = (cell->caloDDE()->getSubCalo());           // keep only cells from desired calorimeter
        std::vector<CaloCell_ID::SUBCALO>::const_iterator theFound =
          find (m_caloIndices.begin(),m_caloIndices.end(),iCaloNum);
        if (theFound==m_caloIndices.end()) continue ;
      }
 
      signedE             = cell->e();                             // get the cell energy if we got a good pointer
      if (!m_useCellWeights) weight = 1.0;                         // if we chose not to use the cell weights, reset to 1.0
      double cellEnergy             = weight * signedE;             // calculate the energy of this cell in this tower using the weight
 
      
      float signedRatio=0;
 
      float noiseSigma = 1.0;
      if (m_cellESignificanceThreshold>=0.) {
        // Noise tool to calculate cell energy significance
    noiseSigma=noise->getNoise(cell->ID(),cell->gain());
        if ( noiseSigma > 0. ) signedRatio = signedE/noiseSigma;
      }
      
      // DEBUGGING
      ATH_MSG_VERBOSE( "         Cell has E = " << signedE << "  eta,phi " << cell->eta() << " " << cell->phi()  );
      ATH_MSG_VERBOSE( "Cell has E in tower = " << cellEnergy  );
      ATH_MSG_VERBOSE( "   Cell noise sigma = " << noiseSigma  );
      ATH_MSG_VERBOSE( "  Cell noise signif = " << signedRatio  );

      if ( (signedE > m_minimumCellEnergy) && ( fabs(signedRatio) > m_cellESignificanceThreshold) )
      {
        // find clusters associated to this cell using the hash ID
        size_t cellIndex(cell->caloDDE()->calo_hash());
        ATH_MSG_VERBOSE( "Cell index from CaloCell2ClusterMap = " << cellIndex  );
        const nav_t* nav = (cellToClusterMap->operator[])(cellIndex);
        
        if (!nav) {
          ATH_MSG_VERBOSE( "No Cluster container from this cell!"  );
        }
        else 
        {
          ATH_MSG_VERBOSE( "Cell associated to N clusters = " << nav->size()  );
          for (const CaloCluster* clusterFromCell : *nav) {
            double eClusRaw  = clusterFromCell->getBasicEnergy();
            double eClus     = clusterFromCell->energy();
            ATH_MSG_VERBOSE( " Cluster Basic Energy  = " << eClusRaw  );
            ATH_MSG_VERBOSE( " Cluster Normal Energy = " << eClus  );
          
            if ( eClusRaw > m_minimumClusterEnergy )
            {
              ATH_MSG_VERBOSE( "Cluster has at least E > " << m_minimumClusterEnergy  );
 
              numberOfAttachedCellsInTower++;
              totalNumberOfCellsInAttachedClusters += clusterFromCell->getNumberOfCells(); 
              totalAttachedClusterEnergy += eClusRaw;
              energyTower += cellEnergy;
              numberOfClustersInTower++;           
 
              newTower->addUniqueCellNoKine(theCellsEL,globalIndex,weight, 10);
            
              // now that we found the cell in at least one cluster above threshold, stop looking at associated clusters
              ATH_MSG_VERBOSE( " -- Found at least one cluster passing cuts. 'break'"  );
              break;
            
            } // cluster filter
          } // clusters from cell loop
          ATH_MSG_VERBOSE( "Finished cluster loop"  );
        } // cluster associated to cell
      } // cell filter
    } // cell loop
    ATH_MSG_VERBOSE( "Finished cell loop"  );
    
    newTower->setE(energyTower);
    
    // Report some information about this Topo-Tower
    if (msgLvl(MSG::VERBOSE)) {
      ATH_MSG_VERBOSE( "" );
      ATH_MSG_VERBOSE( "Old/ new TopoTower energy from all cells               = " << theTower->e() << " " << newTower->e()  );
      ATH_MSG_VERBOSE( "TopoTower energy adding all cells in clusters = " << energyTower  );
      ATH_MSG_VERBOSE( "Total attached cluster energy                 = " << totalAttachedClusterEnergy  );
      ATH_MSG_VERBOSE( "Total number of attached clusters             = " << numberOfClustersInTower  );
      ATH_MSG_VERBOSE( "Number of cells in attached clusters          = " << totalNumberOfCellsInAttachedClusters  );
      ATH_MSG_VERBOSE( "Total number of cells originally in tower     = " << numberOfCellsInTower  );
      ATH_MSG_VERBOSE( "Total number of cells from clusters           = " << numberOfAttachedCellsInTower  );
      CaloTower::cell_iterator cellInTowerIter(newTower->cell_begin());
      CaloTower::cell_iterator lastCellInTower(newTower->cell_end());
      msg(MSG::VERBOSE) << " E*weight, eta, phi of cells in new tower ";
      for ( ; cellInTowerIter != lastCellInTower; cellInTowerIter++ ) {
         double weight                 = theTower->getCellWeight(cellInTowerIter);     // get the weight of this cell in the tower
         const CaloCell* cell = (*cellInTowerIter);
         if (!cell) continue;
         msg(MSG::VERBOSE) << cell->e()*weight << " " << cell->eta() << " " << cell->phi() << " / ";
      } 
      msg(MSG::VERBOSE) << endmsg;
    }
    
  } // tower loop
  
  ATH_MSG_DEBUG( "Finished creating TopoTowers"  );
  
  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 & AthCommonAlgorithm< 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 89 of file AthCommonAlgorithm.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 AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

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

finalize()

StatusCode CaloTopoTowerAlg::finalize ( )

overridevirtual

finalize

==============================================

finalize

Definition at line 44 of file CaloTopoTowerAlg.cxx.

{
 return StatusCode::SUCCESS;
}

initialize()

StatusCode CaloTopoTowerAlg::initialize ( )

overridevirtual

initialize

==============================================

INITIALIZATION

Definition at line 52 of file CaloTopoTowerAlg.cxx.

{
  // services
  ATH_MSG_INFO( "Initializing CaloTopoTowerAlg"  );
 
  ATH_CHECK(m_cellToClusterMapKey.initialize());
  ATH_CHECK(m_cellContainerKey.initialize());
  ATH_CHECK(m_towerContainerKey.initialize());
  ATH_CHECK(m_newTowerContainerKey.initialize());
  
  ATH_CHECK(m_noiseCDOKey.initialize());
 
  m_caloIndices.clear();
  for ( unsigned int iCalos=0; iCalos< m_includedCalos.size(); iCalos++ )
  {
    if  ( m_includedCalos[iCalos] == "LAREM" )
    {
      m_caloIndices.push_back(CaloCell_ID::LAREM);
    }
        else if ( m_includedCalos[iCalos] == "LARHEC")
    {
      m_caloIndices.push_back(CaloCell_ID::LARHEC);
    }
        else if ( m_includedCalos[iCalos] == "LARFCAL" )
    {
      m_caloIndices.push_back(CaloCell_ID::LARFCAL);
    }
        else if ( m_includedCalos[iCalos] == "TILE" )
    {
      m_caloIndices.push_back(CaloCell_ID::TILE);
    }
  }
 
  m_caloSelection=false;
  unsigned int nSubCalo=static_cast<int>(CaloCell_ID::NSUBCALO) ;
  if (!m_caloIndices.empty() && m_caloIndices.size()<nSubCalo) m_caloSelection=true;
 
  ATH_MSG_INFO( " Calo selection applied ? " << m_caloSelection  );
  if (m_caloSelection) {
    msg(MSG::INFO) << "   subcalo selected ";
    for (unsigned int iCalos=0;iCalos< m_includedCalos.size(); iCalos++ ) msg(MSG::INFO) << " " << m_includedCalos[iCalos];
    msg(MSG::INFO) << " " << endmsg;
  }
 
  // check setup
  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()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, 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, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    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 368 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 352 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

setFilterPassed()

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

inlinevirtualinherited

Set filter decision:

Definition at line 99 of file AthCommonAlgorithm.h.

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

sysExecute()

StatusCode AthCommonAlgorithm< 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.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonAlgorithm< 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 AthAnalysisAlgorithm, AthHistogramAlgorithm, HypoBase, InputMakerBase, and PyAthena::Alg.

Definition at line 60 of file AthCommonAlgorithm.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 298 of file AthCommonDataStore.h.

                                               {
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_caloIndices

std::vector<CaloCell_ID::SUBCALO> CaloTopoTowerAlg::m_caloIndices

private

Definition at line 94 of file CaloTopoTowerAlg.h.

m_caloSelection

bool CaloTopoTowerAlg::m_caloSelection {false}

private

Definition at line 95 of file CaloTopoTowerAlg.h.

{false};

m_cellContainerKey

SG::ReadHandleKey<CaloCellContainer> CaloTopoTowerAlg::m_cellContainerKey {this, "CellContainerName", "AllCalo"}

private

Definition at line 74 of file CaloTopoTowerAlg.h.

{this, "CellContainerName", "AllCalo"};

m_cellESignificanceThreshold

Gaudi::Property<float> CaloTopoTowerAlg::m_cellESignificanceThreshold {this, "CellEnergySignificance", -1.f}

private

Definition at line 87 of file CaloTopoTowerAlg.h.

{this, "CellEnergySignificance", -1.f};

m_cellToClusterMapKey

SG::ReadHandleKey<CaloCell2ClusterMap> CaloTopoTowerAlg::m_cellToClusterMapKey {this, "Cell2ClusterMapName", "CaloCell2TopoCluster"}

private

Definition at line 73 of file CaloTopoTowerAlg.h.

{this, "Cell2ClusterMapName", "CaloCell2TopoCluster"};

m_detStore

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

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 381 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 378 of file AthCommonDataStore.h.

m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

m_includedCalos

Gaudi::Property<std::vector<std::string> > CaloTopoTowerAlg::m_includedCalos {this, "IncludedCalos", {}}

private

Definition at line 93 of file CaloTopoTowerAlg.h.

{this, "IncludedCalos", {}};

m_minimumCellEnergy

Gaudi::Property<double> CaloTopoTowerAlg::m_minimumCellEnergy {this, "MinimumCellEnergy", -1000000000.0}

private

Definition at line 79 of file CaloTopoTowerAlg.h.

{this, "MinimumCellEnergy", -1000000000.0};

m_minimumClusterEnergy

Gaudi::Property<double> CaloTopoTowerAlg::m_minimumClusterEnergy {this, "MinimumClusterEnergy", -1000000000.0}

private

Definition at line 80 of file CaloTopoTowerAlg.h.

{this, "MinimumClusterEnergy", -1000000000.0};

m_newTowerContainerKey

SG::WriteHandleKey<CaloTowerContainer> CaloTopoTowerAlg::m_newTowerContainerKey {this, "OutputTowerContainerName", "TopoTower"}

private

Definition at line 76 of file CaloTopoTowerAlg.h.

{this, "OutputTowerContainerName", "TopoTower"};

m_noiseCDOKey

SG::ReadCondHandleKey<CaloNoise> CaloTopoTowerAlg::m_noiseCDOKey {this,"CaloNoiseKey","totalNoise","SG Key of CaloNoise data object"}

private

Key of the CaloNoise Conditions data object.

Typical values are '"electronicNoise', 'pileupNoise', or '"totalNoise' (default)

Definition at line 85 of file CaloTopoTowerAlg.h.

{this,"CaloNoiseKey","totalNoise","SG Key of CaloNoise data object"};

m_towerContainerKey

SG::ReadHandleKey<CaloTowerContainer> CaloTopoTowerAlg::m_towerContainerKey {this, "InputTowerContainerName", "CmbTower"}

private

Definition at line 75 of file CaloTopoTowerAlg.h.

{this, "InputTowerContainerName", "CmbTower"};

m_useCellWeights

Gaudi::Property<bool> CaloTopoTowerAlg::m_useCellWeights {this, "useCellWeight", true}

private

Definition at line 81 of file CaloTopoTowerAlg.h.

{this, "useCellWeight", true};

m_varHandleArraysDeclared

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

privateinherited

Definition at line 387 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 386 of file AthCommonDataStore.h.

---

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

• CaloTopoTowerAlg.h
• CaloTopoTowerAlg.cxx