egammaTopoClusterCopier Class Reference

Select topo-clusters to be used in egamma reconstruction. More...

#include <egammaTopoClusterCopier.h>

Inheritance diagram for egammaTopoClusterCopier:

Collaboration diagram for egammaTopoClusterCopier:

Public Member Functions
	egammaTopoClusterCopier (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode	initialize () override final
virtual StatusCode	execute (const EventContext &ctx) const override final
virtual StatusCode	finalize () override final
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual bool	isClonable () const override
	Specify if the algorithm is clonable. More...
virtual unsigned int	cardinality () const override
	Cardinality (Maximum number of clones that can exist) special value 0 means that algorithm is reentrant. More...
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
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. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
SG::ReadHandleKey< xAOD::CaloClusterContainer >	m_inputTopoCollection
SG::WriteHandleKey< xAOD::CaloClusterContainer >	m_outputTopoCollectionShallow
SG::WriteHandleKey< ConstDataVector< xAOD::CaloClusterContainer > >	m_outputTopoCollection
SG::WriteHandleKey< ConstDataVector< xAOD::CaloClusterContainer > >	m_outputFwdTopoCollection
Gaudi::Property< float >	m_etaCut
Gaudi::Property< double >	m_fwdEtaCut
Gaudi::Property< float >	m_ECut
Gaudi::Property< double >	m_fwdETCut
Gaudi::Property< float >	m_EMFracCut
Gaudi::Property< bool >	m_hasITk
	Private member flag to do the track matching. More...
bool	m_doForwardClusters = false
	Private member flag to copy forward clusters. More...
Gaudi::Accumulators::Counter	m_AllClusters {}
Gaudi::Accumulators::Counter	m_CentralPassPreSelection {}
Gaudi::Accumulators::Counter	m_CentralPassSelection {}
Gaudi::Accumulators::Counter	m_FwdPassPreSelection {}
Gaudi::Accumulators::Counter	m_FwdPassSelection {}
Gaudi::Accumulators::Counter	m_SharedPassPreSelection {}
Gaudi::Accumulators::Counter	m_SharedPassSelection {}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks. More...
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Select topo-clusters to be used in egamma reconstruction.

This algorithm is the first step in egamma reconstruction. It selects topoclusters and decorate them with the EM fraction. The input and output containers are collections of xAOD::CaloCluster.

• Input container: input clusters
• Output container: view of decorated selected clusters
• Output container: shallow copy of decorated clusters of the input container

The algorithm computes a custom version of the EM fraction defined as the sum of the energy of the presampler, three accordion layers and the energy in the tile-gap divided by the total energy of the cluster. The computation is done only for cluster passing the preselection (|eta| and minimum EM energy). Otherwise a value of 0 is used. The value is used to decorate the clusters with "EMFraction" decoration.

The selection is based on:

• maximum |eta| of selected clusters
• minimum EM energy of selected clusters
• mimimum EM fraction of selected clusters

Definition at line 42 of file egammaTopoClusterCopier.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

egammaTopoClusterCopier()

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

Definition at line 89 of file egammaTopoClusterCopier.cxx.

                                                                          :
  AthReentrantAlgorithm(name, pSvcLocator)
{ }

Member Function Documentation

cardinality()

unsigned int AthReentrantAlgorithm::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.

Override this to return 0 for reentrant algorithms.

Definition at line 55 of file AthReentrantAlgorithm.cxx.

{
  return 0;
}

declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleKeyArrayType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
 
  }

declareGaudiProperty() [2/4]

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

declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  hndl, const SG::VarHandleType &    )

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

  {
    return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                       hndl.value(), 
                                                       hndl.documentation());
  }

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T > &  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() [1/2]

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

evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode egammaTopoClusterCopier::execute ( const EventContext &  ctx ) const

finaloverridevirtual

Definition at line 125 of file egammaTopoClusterCopier.cxx.

                                                                         {
  SG::ReadHandle<xAOD::CaloClusterContainer> inputTopoclusters(m_inputTopoCollection, ctx);
  SG::WriteHandle<xAOD::CaloClusterContainer> outputTopoclustersShallow(m_outputTopoCollectionShallow, ctx);
  SG::WriteHandle<ConstDataVector<xAOD::CaloClusterContainer>> outputTopoclusters(m_outputTopoCollection, ctx);
 
  // Create a shallow copy, the elements of this can be modified, but no need to
  // recreate the cluster.
  std::pair<
    std::unique_ptr<xAOD::CaloClusterContainer>,
    std::unique_ptr<xAOD::ShallowAuxContainer>
  > inputShallowcopy = xAOD::shallowCopyContainer(*inputTopoclusters, ctx);
 
  ATH_CHECK(outputTopoclustersShallow.record(
    std::move(inputShallowcopy.first),
    std::move(inputShallowcopy.second)
  ));
 
  // Here it just needs to be a view copy, i.e the collection we create does not
  // really own its elements.
  auto viewCopy = std::make_unique<ConstDataVector<xAOD::CaloClusterContainer>>(SG::VIEW_ELEMENTS);
 
  // Declare and conditionally initialise forward cluster objects.
  SG::WriteHandle<ConstDataVector<xAOD::CaloClusterContainer>> outputFwdTopoclusters;
  std::unique_ptr<ConstDataVector<xAOD::CaloClusterContainer>> fwdViewCopy;
 
  if (m_doForwardClusters) {
    outputFwdTopoclusters = SG::WriteHandle<ConstDataVector<xAOD::CaloClusterContainer>>(
      m_outputFwdTopoCollection,
      ctx
    );
 
    fwdViewCopy = std::make_unique<ConstDataVector<xAOD::CaloClusterContainer>>(SG::VIEW_ELEMENTS);
  }
 
  auto buff_AllClusters = m_AllClusters.buffer();
  auto buff_CentralPassPreSelection = m_CentralPassPreSelection.buffer();
  auto buff_CentralPassSelection = m_CentralPassSelection.buffer();
  auto buff_FwdPassPreSelection = m_FwdPassPreSelection.buffer();
  auto buff_FwdPassSelection = m_FwdPassSelection.buffer();
  auto buff_SharedPassPreSelection = m_SharedPassPreSelection.buffer();
  auto buff_SharedPassSelection = m_SharedPassSelection.buffer();
 
  // Loop over the output shallow copy.
  for (xAOD::CaloCluster* clus : *outputTopoclustersShallow) {
    ATH_MSG_DEBUG(
        "->CHECKING Cluster at eta,phi,et " <<
        clus->eta() << " , " <<
        clus->phi() << " , " <<
        clus->et()
    );
 
    ++buff_AllClusters;
    s_acc_emfraction(*clus) = 0.0;  // Always decorate
 
    const double clusterE = clus->e();
    const double aeta = std::abs(clus->eta());
 
    const bool valid_for_central = checkIfValidForCentral(aeta, m_etaCut, clusterE, m_ECut);
    const bool valid_for_fwd = checkIfValidForFwd(aeta, m_fwdEtaCut, m_fwdETCut, clus, m_doForwardClusters, m_hasITk);
    if (valid_for_central) {
      ++buff_CentralPassPreSelection;
    } else if (valid_for_fwd) {
      ++buff_FwdPassPreSelection;
    } else {
      continue;
    }
 
    const bool valid_for_both = valid_for_central && valid_for_fwd;
    if (valid_for_both) {
      ++buff_FwdPassPreSelection;  // since we count them only in the else above
      ++buff_SharedPassPreSelection;
    }
 
    if (!m_hasITk && m_doForwardClusters && valid_for_fwd) {
      fwdViewCopy->push_back(clus->getSisterCluster());
      ++buff_FwdPassSelection;
    }
 
    // Add the relevant TileGap3/E4 cells.
    double eg_tilegap = 0;
    if (valid_for_central) {
      if (aeta > 1.35 && aeta < 1.65 && clusterE > 0) {
        eg_tilegap += addTileGapCellsEnergy(clus);
      }
    }
 
    const double emfrac= (clus->energyBE(0) + clus->energyBE(1) +
                    clus->energyBE(2) + clus->energyBE(3) + eg_tilegap) / clusterE;
 
    s_acc_emfraction(*clus) = emfrac;
    if ((emfrac > m_EMFracCut && (clusterE * emfrac) > m_ECut) || xAOD::EgammaHelpers::isFCAL(clus)) {
      ATH_MSG_DEBUG(
        "-->Selected Cluster at eta,phi,et,EMFraction " << clus->eta() <<
        " , " << clus->phi() <<
        " , " << clus->et() <<
        " , " << emfrac
      );
 
      if (valid_for_central) {
        viewCopy->push_back(clus);
        ++buff_CentralPassSelection;
      }
 
      if (m_hasITk && valid_for_fwd) {
        fwdViewCopy->push_back(clus);
        ++buff_FwdPassSelection;
      }
 
      if (valid_for_both) {
        ++buff_SharedPassSelection;
      }
    }
  } // End loop on clusters.
 
  // Sort in descenting em energy.
  std::sort(viewCopy->begin(), viewCopy->end(), greater);
 
  ATH_MSG_DEBUG(
      "Cloned container has size: " << viewCopy->size() <<
      " selected out of : " << inputTopoclusters->size()
  );
 
  ATH_CHECK(outputTopoclusters.record(std::move(viewCopy)));
 
  if (m_doForwardClusters) {
    if (m_hasITk) {
      std::sort(fwdViewCopy->begin(), fwdViewCopy->end(), greater);
    }
 
    ATH_MSG_DEBUG(
      "Cloned fwd container has size: " << fwdViewCopy->size() <<
      " selected out of : " << inputTopoclusters->size()
    );
 
    ATH_CHECK(outputFwdTopoclusters.record(std::move(fwdViewCopy)));
  }
 
  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 & AthReentrantAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 79 of file AthReentrantAlgorithm.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 Algorithm::extraOutputDeps();
}

filterPassed()

virtual bool AthReentrantAlgorithm::filterPassed ( const EventContext &  ctx ) const

inlinevirtualinherited

Definition at line 135 of file AthReentrantAlgorithm.h.

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

finalize()

StatusCode egammaTopoClusterCopier::finalize ( )

finaloverridevirtual

Definition at line 111 of file egammaTopoClusterCopier.cxx.

                                             {
  ATH_MSG_INFO("=====> Selected Topo cluster statistics ===========");
  ATH_MSG_INFO(" All Clusters " << m_AllClusters );
  ATH_MSG_INFO(" Central: Pass Preselection Clusters " << m_CentralPassPreSelection );
  ATH_MSG_INFO(" Fwd: Pass Preselection Clusters " << m_FwdPassPreSelection );
  ATH_MSG_INFO(" Shared: Pass Preselection Clusters " << m_SharedPassPreSelection );
  ATH_MSG_INFO(" Central: Pass Selection " << m_CentralPassSelection );
  ATH_MSG_INFO(" Fwd: Pass Selection " << m_FwdPassSelection );
  ATH_MSG_INFO(" Shared: Pass Selection " << m_SharedPassSelection );
  ATH_MSG_INFO("===================================================");
 
  return StatusCode::SUCCESS;
}

initialize()

StatusCode egammaTopoClusterCopier::initialize ( )

finaloverridevirtual

Definition at line 94 of file egammaTopoClusterCopier.cxx.

                                               {
  ATH_MSG_DEBUG("Initializing " << name() << "...");
 
  ATH_CHECK(m_inputTopoCollection.initialize());
  ATH_CHECK(m_outputTopoCollection.initialize());
 
  m_doForwardClusters = !m_outputFwdTopoCollection.empty();
  ATH_CHECK(m_outputFwdTopoCollection.initialize(m_doForwardClusters));
 
  m_outputTopoCollectionShallow = "tmp_"+ m_outputTopoCollection.key();
  ATH_CHECK(m_outputTopoCollectionShallow.initialize());
 
  ATH_MSG_DEBUG("Initialization successful");
 
  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 AthReentrantAlgorithm::isClonable ( ) const

overridevirtualinherited

Specify if the algorithm is clonable.

Reentrant algorithms are clonable.

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

Definition at line 44 of file AthReentrantAlgorithm.cxx.

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

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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 AthReentrantAlgorithm::setFilterPassed ( bool  state, const EventContext &  ctx  ) const

inlinevirtualinherited

Definition at line 139 of file AthReentrantAlgorithm.h.

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

sysExecute()

StatusCode AthReentrantAlgorithm::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 67 of file AthReentrantAlgorithm.cxx.

{
  return Gaudi::Algorithm::sysExecute (ctx);
}

sysInitialize()

StatusCode AthReentrantAlgorithm::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 InputMakerBase, and HypoBase.

Definition at line 96 of file AthReentrantAlgorithm.cxx.

                                                {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Gaudi::Algorithm>>::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_AllClusters

Gaudi::Accumulators::Counter egammaTopoClusterCopier::m_AllClusters {}

mutableprivate

Definition at line 128 of file egammaTopoClusterCopier.h.

m_CentralPassPreSelection

Gaudi::Accumulators::Counter egammaTopoClusterCopier::m_CentralPassPreSelection {}

mutableprivate

Definition at line 129 of file egammaTopoClusterCopier.h.

m_CentralPassSelection

Gaudi::Accumulators::Counter egammaTopoClusterCopier::m_CentralPassSelection {}

mutableprivate

Definition at line 130 of file egammaTopoClusterCopier.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_doForwardClusters

bool egammaTopoClusterCopier::m_doForwardClusters = false

private

Private member flag to copy forward clusters.

Definition at line 126 of file egammaTopoClusterCopier.h.

m_ECut

Gaudi::Property<float> egammaTopoClusterCopier::m_ECut

private

Initial value:

{
    this,
    "ECut",
    700,
    "minimum EM energy of selected clusters"
  }

Definition at line 96 of file egammaTopoClusterCopier.h.

m_EMFracCut

Gaudi::Property<float> egammaTopoClusterCopier::m_EMFracCut

private

Initial value:

{
    this,
    "EMFracCut",
    0.5,
    "mimimum EM fraction of selected clusters"
  }

Definition at line 110 of file egammaTopoClusterCopier.h.

m_etaCut

Gaudi::Property<float> egammaTopoClusterCopier::m_etaCut

private

Initial value:

{
    this,
    "EtaCut",
    2.6,
    "maximum |eta| of selected clusters"
  }

Definition at line 82 of file egammaTopoClusterCopier.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 AthReentrantAlgorithm::m_extendedExtraObjects

privateinherited

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

Empty if no symlinks were found.

Definition at line 153 of file AthReentrantAlgorithm.h.

m_fwdEtaCut

Gaudi::Property<double> egammaTopoClusterCopier::m_fwdEtaCut

private

Initial value:

{
    this,
    "fwdEtaCut",
    2.5,
    "minimum |eta| of selected fwd clusters"
  }

Definition at line 89 of file egammaTopoClusterCopier.h.

m_fwdETCut

Gaudi::Property<double> egammaTopoClusterCopier::m_fwdETCut

private

Initial value:

{
    this,
    "fwdETCut",
    5. * Gaudi::Units::GeV,
    "Fwd ET cut"
  }

Definition at line 103 of file egammaTopoClusterCopier.h.

m_FwdPassPreSelection

Gaudi::Accumulators::Counter egammaTopoClusterCopier::m_FwdPassPreSelection {}

mutableprivate

Definition at line 131 of file egammaTopoClusterCopier.h.

m_FwdPassSelection

Gaudi::Accumulators::Counter egammaTopoClusterCopier::m_FwdPassSelection {}

mutableprivate

Definition at line 132 of file egammaTopoClusterCopier.h.

m_hasITk

Gaudi::Property<bool> egammaTopoClusterCopier::m_hasITk

private

Initial value:

{
    this,
    "hasITk",
    false,
    "Boolean to do track matching"
  }

Private member flag to do the track matching.

Definition at line 118 of file egammaTopoClusterCopier.h.

m_inputTopoCollection

SG::ReadHandleKey<xAOD::CaloClusterContainer> egammaTopoClusterCopier::m_inputTopoCollection

private

Initial value:

{
    this,
    "InputTopoCollection",
    "CaloTopoClusters",
    "input topocluster collection"
  }

Definition at line 54 of file egammaTopoClusterCopier.h.

m_outputFwdTopoCollection

SG::WriteHandleKey<ConstDataVector<xAOD::CaloClusterContainer> > egammaTopoClusterCopier::m_outputFwdTopoCollection

private

Initial value:

{
    this,
    "OutputFwdTopoCollection",
    "",
    "View container of selected fwd topoclusters"
  }

Definition at line 75 of file egammaTopoClusterCopier.h.

m_outputTopoCollection

SG::WriteHandleKey<ConstDataVector<xAOD::CaloClusterContainer> > egammaTopoClusterCopier::m_outputTopoCollection

private

Initial value:

{
    this,
    "OutputTopoCollection",
    "egammaTopoCluster",
    "View container of selected topoclusters"
  }

Definition at line 68 of file egammaTopoClusterCopier.h.

m_outputTopoCollectionShallow

SG::WriteHandleKey<xAOD::CaloClusterContainer> egammaTopoClusterCopier::m_outputTopoCollectionShallow

private

Initial value:

{
    this,
    "TopoShallow_doNotConfig",
    "",
    "Shallow copy of input collection that allows properties to be modified"
  }

Definition at line 61 of file egammaTopoClusterCopier.h.

m_SharedPassPreSelection

Gaudi::Accumulators::Counter egammaTopoClusterCopier::m_SharedPassPreSelection {}

mutableprivate

Definition at line 133 of file egammaTopoClusterCopier.h.

m_SharedPassSelection

Gaudi::Accumulators::Counter egammaTopoClusterCopier::m_SharedPassSelection {}

mutableprivate

Definition at line 134 of file egammaTopoClusterCopier.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:

• egammaTopoClusterCopier.h
• egammaTopoClusterCopier.cxx