Algorithm taking a list of decision objects, extracting RoI from each and prefetching ROBs (i.e. More...

#include <ROBPrefetchingAlg.h>

Inheritance diagram for ROBPrefetchingAlg:

Collaboration diagram for ROBPrefetchingAlg:

Public Member Functions
	ROBPrefetchingAlg (const std::string &name, ISvcLocator *svcLoc)
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &eventContext) const 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.

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
SG::ReadHandleKeyArray< TrigCompositeUtils::DecisionContainer >	m_inputDecisions
	Array of input decisions from which RoIs will be extracted.
ToolHandleArray< IRegSelTool >	m_regionSelectorTools
	Array of RegionSelector tools for RoI->ROBs mapping, one for each detector to be prefetched.
ServiceHandle< IROBDataProviderSvc >	m_robDataProviderSvc
	The ROB data provider service used to prefetch the ROBs.
Gaudi::Property< std::string >	m_roiLinkName
	Choose the name of the RoI link to follow.
Gaudi::Property< std::vector< TrigCompositeUtils::DecisionID > >	m_chainFilterVec
	ChainFilter to select decisions for specific active chains.
std::unordered_set< TrigCompositeUtils::DecisionID >	m_chainFilter
	ChainFilter as unordered_set for faster lookup.
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

Algorithm taking a list of decision objects, extracting RoI from each and prefetching ROBs (i.e.

calling ROBDataProviderSvc::addROBData) for all these RoIs from specific detectors configured in the RegionSelectorTools property.

Definition at line 28 of file ROBPrefetchingAlg.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

◆ ROBPrefetchingAlg()

ROBPrefetchingAlg::ROBPrefetchingAlg	(	const std::string &	name,
		ISvcLocator *	svcLoc )

Definition at line 32 of file ROBPrefetchingAlg.cxx.

33: AthReentrantAlgorithm(name, pSvcLocator) {}

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.

95{ return m_detStore; }

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

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ 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.

85{ return m_evtStore; }

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

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode ROBPrefetchingAlg::execute ( const EventContext & eventContext ) const

overridevirtual

Definition at line 54 of file ROBPrefetchingAlg.cxx.

                                                                            {
  using namespace TrigCompositeUtils;
  std::unordered_set<uint32_t> robsToPrefetch;
  std::vector<uint32_t> robsInRoI; // reused in the loop for each RoI
 
  // Loop over all input Decision collections to extract RoIs
  for (const auto& decisionContKey : m_inputDecisions) {
    SG::ReadHandle<DecisionContainer> decisionCont{decisionContKey, eventContext};
    ATH_CHECK(decisionCont.isValid());
    ATH_MSG_DEBUG("Processing " << decisionCont->size() << " decisions in " << decisionContKey.key());
    for (const Decision* decision : *decisionCont) {
 
      if (not m_chainFilter.empty()) {
        bool skipPrefetching{true};
        // Loop over active chains for this Decision to see if at least one matches the ChainFilter
        for (const DecisionID chainLegID : decisionIDs(decision)) {
          if (m_chainFilter.find(chainLegID)!=m_chainFilter.cend()) {
            skipPrefetching = false;
            break;
          }
        }
        if (skipPrefetching) {
          ATH_MSG_DEBUG("Skipping decision " << decision->name() << " because no active chain matches the " << m_chainFilterVec.name());
          continue;
        }
      }
 
      ElementLink<TrigRoiDescriptorCollection> roiEL = findLink<TrigRoiDescriptorCollection>(decision, m_roiLinkName.value()).link;
      if (!roiEL.isValid()) {
        ATH_MSG_WARNING("No " << m_roiLinkName.value() << " link in " << decisionContKey.key() << " decision " << *decision);
        continue;
      }
 
      const TrigRoiDescriptor& roi = **roiEL;
      ATH_MSG_DEBUG("Processing decision " << *decision);
      ATH_MSG_DEBUG("Processing RoI: " << roi);
 
      for (const auto& tool : m_regionSelectorTools) {
        robsInRoI.clear();
        tool->lookup(eventContext)->ROBIDList( roi, robsInRoI );
        robsToPrefetch.insert(robsInRoI.begin(),robsInRoI.end());
      }
    }
  }
 
  // Prefetch all ROBs collected above
  ATH_MSG_DEBUG("Prefetching " << robsToPrefetch.size() << " ROBs: " << robSetToString(robsToPrefetch));
  std::vector<uint32_t> robsToPrefetchVec{robsToPrefetch.begin(),robsToPrefetch.end()};
  m_robDataProviderSvc->addROBData(eventContext, robsToPrefetchVec, name());
 
  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 ROBPrefetchingAlg::initialize ( )

overridevirtual

Definition at line 35 of file ROBPrefetchingAlg.cxx.

                                         {
  ATH_CHECK(m_inputDecisions.initialize());
  ATH_CHECK(m_regionSelectorTools.retrieve());
  ATH_CHECK(m_robDataProviderSvc.retrieve());
  ATH_MSG_DEBUG("Will consume " << m_inputDecisions.size() << " input decision collection(s):");
  if (msgLvl(MSG::DEBUG)) {
    for (const auto& decisionContKey : m_inputDecisions) {
      ATH_MSG_DEBUG("- " << decisionContKey.key());
    }
  }
  // Convert ChainFilter vector to set
  m_chainFilter.insert(m_chainFilterVec.value().begin(), m_chainFilterVec.value().end());
  if (not m_chainFilter.empty()) {
    ATH_MSG_DEBUG("Will consider only RoIs from " << m_chainFilter.size()
                  << " chains (or chain legs) in " << m_chainFilterVec.name());
  }
  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_chainFilter

std::unordered_set<TrigCompositeUtils::DecisionID> ROBPrefetchingAlg::m_chainFilter

private

ChainFilter as unordered_set for faster lookup.

Definition at line 56 of file ROBPrefetchingAlg.h.

◆ m_chainFilterVec

Gaudi::Property<std::vector<TrigCompositeUtils::DecisionID> > ROBPrefetchingAlg::m_chainFilterVec

private

Initial value:

{

this, "ChainFilter", {}, "Apply prefetching only to RoIs from Decisions where chains from this list are active. Empty list means no filtering."}

ChainFilter to select decisions for specific active chains.

Definition at line 52 of file ROBPrefetchingAlg.h.

52 {

53 this, "ChainFilter", {}, "Apply prefetching only to RoIs from Decisions where chains from this list are active. Empty list means no filtering."};

◆ 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_inputDecisions

SG::ReadHandleKeyArray<TrigCompositeUtils::DecisionContainer> ROBPrefetchingAlg::m_inputDecisions

private

Initial value:

{

this, "ROBPrefetchingInputDecisions", {}, "Input Decisions"}

Array of input decisions from which RoIs will be extracted.

Definition at line 36 of file ROBPrefetchingAlg.h.

36 {

37 this, "ROBPrefetchingInputDecisions", {}, "Input Decisions"};

◆ m_regionSelectorTools

ToolHandleArray<IRegSelTool> ROBPrefetchingAlg::m_regionSelectorTools

private

Initial value:

{

this, "RegionSelectorTools", {}, "Region Selector tools"}

Array of RegionSelector tools for RoI->ROBs mapping, one for each detector to be prefetched.

Definition at line 40 of file ROBPrefetchingAlg.h.

40 {

41 this, "RegionSelectorTools", {}, "Region Selector tools"};

◆ m_robDataProviderSvc

ServiceHandle<IROBDataProviderSvc> ROBPrefetchingAlg::m_robDataProviderSvc

private

Initial value:

{

this, "ROBDataProviderSvc", "ROBDataProviderSvc", "Name of the ROB data provider"}

The ROB data provider service used to prefetch the ROBs.

Definition at line 44 of file ROBPrefetchingAlg.h.

44 {

45 this, "ROBDataProviderSvc", "ROBDataProviderSvc", "Name of the ROB data provider"};

◆ m_roiLinkName

Gaudi::Property<std::string> ROBPrefetchingAlg::m_roiLinkName

private

Initial value:

{

this, "RoILinkName", TrigCompositeUtils::roiString(), "The string identifying links from Decisions to RoIs"}

TrigCompositeUtils::roiString

const std::string & roiString()

Definition TrigCompositeUtils.h:419

Choose the name of the RoI link to follow.

Definition at line 48 of file ROBPrefetchingAlg.h.

48 {

49 this, "RoILinkName", TrigCompositeUtils::roiString(), "The string identifying links from Decisions to RoIs"};

◆ 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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ROBPrefetchingAlg()

Member Function Documentation

◆ cardinality()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ filterPassed()

◆ initialize()

◆ inputHandles()

◆ isClonable()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterPassed()

◆ sysExecute()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_chainFilter

◆ m_chainFilterVec

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputDecisions

◆ m_regionSelectorTools

◆ m_robDataProviderSvc

◆ m_roiLinkName

◆ m_varHandleArraysDeclared

◆ m_vhka