Algorithm to add TrackSummary to Track collections read from file. More...

#include <AddTrackSummaryAlg.h>

Inheritance diagram for Trk::AddTrackSummaryAlg:

Collaboration diagram for Trk::AddTrackSummaryAlg:

Public Member Functions
	AddTrackSummaryAlg (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~AddTrackSummaryAlg ()=default
virtual StatusCode	initialize () override
virtual StatusCode	execute (const EventContext &ctx) 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::ReadHandleKey< TrackCollection >	m_inputTrackCollection
	Input track collection (read-only)
SG::WriteHandleKey< ConstDataVector< TrackCollection > >	m_outputTrackCollection
	Output track collection with summaries added.
ToolHandle< Trk::ITrackSummaryTool >	m_trackSummaryTool
	Track summary tool.
Gaudi::Property< float >	m_minPt {this, "MinPt", 0.0, "Only add summary if pT > MinPt [MeV]"}
Gaudi::Property< float >	m_maxAbsEta {this, "MaxAbsEta", 99.0, "Only add summary if \|eta\| < MaxAbsEta"}
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 to add TrackSummary to Track collections read from file.

This algorithm is needed for track overlay where pileup tracks are read from file and don't have TrackSummary objects (which are not persisted with Track EDM). It loops through the input track collection and calls computeAndReplaceTrackSummary on each track to create the summary.

Definition at line 24 of file AddTrackSummaryAlg.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

◆ AddTrackSummaryAlg()

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

Definition at line 7 of file AddTrackSummaryAlg.cxx.

8 : AthReentrantAlgorithm(name, pSvcLocator)

9{}

◆ ~AddTrackSummaryAlg()

virtual Trk::AddTrackSummaryAlg::~AddTrackSummaryAlg ( )

virtualdefault

Member Function Documentation

◆ cardinality()

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

overridevirtualinherited

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

Override this to return 0 for reentrant algorithms.

Definition at line 75 of file AthCommonReentrantAlgorithm.cxx.

{
  return 0;
}

◆ declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

◆ detStore()

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

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

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

overridevirtual

Definition at line 25 of file AddTrackSummaryAlg.cxx.

                                                                    {
  ATH_MSG_DEBUG("Executing " << name());
 
  // Retrieve the input track collection
  SG::ReadHandle<TrackCollection> inputTracks(m_inputTrackCollection, ctx);
  if (!inputTracks.isValid()) {
    ATH_MSG_ERROR("Failed to retrieve track collection: " << m_inputTrackCollection.key());
    return StatusCode::FAILURE;
  }
 
  ATH_MSG_DEBUG("Retrieved " << inputTracks->size() << " tracks from " << m_inputTrackCollection.key());
 
  // Create output collection - use VIEW to avoid copying track objects
  auto outputTracks = std::make_unique<ConstDataVector<TrackCollection>>(SG::VIEW_ELEMENTS);
  outputTracks->reserve(inputTracks->size());
 
  // Loop through tracks and add summary to those missing it
  int tracksProcessed = 0;
  int tracksAlreadyHaveSummary = 0;
 
  for (const Trk::Track* track : *inputTracks) {
    if (!track) {
      ATH_MSG_WARNING("Null track pointer in collection");
      continue;
    }
 
    // Check if track already has a summary
    if (!track->trackSummary()) {
      bool doSummary = true;
 
      const Trk::Perigee* per = track->perigeeParameters();
      if (per) {
        const float pt  = per->momentum().perp();
        const float eta = per->momentum().eta();
 
        if (m_minPt > 0.0 && pt < m_minPt) doSummary = false;
        if (m_maxAbsEta < 90.0 && std::abs(eta) > m_maxAbsEta) doSummary = false;
      }
 
      // Create and attach the summary (updateTrackSummary modifies track in-place)
      // This is thread-safe because each event gets its own copy of tracks
      if (doSummary){
    m_trackSummaryTool->updateTrackSummary(ctx, *const_cast<Trk::Track*>(track));
    ++tracksProcessed;
 
    // Verify the summary was actually created
    if (!track->trackSummary()) {
      ATH_MSG_ERROR("Failed to create TrackSummary for track!");
      return StatusCode::FAILURE;
    }
      }
    } else {
      ++tracksAlreadyHaveSummary;
    }
 
    // Add track pointer to output collection
    outputTracks->push_back(track);
  }
 
  ATH_MSG_DEBUG("Processed " << tracksProcessed << " tracks. " << tracksAlreadyHaveSummary << " tracks already had summary");
 
  // Record output collection
  SG::WriteHandle<ConstDataVector<TrackCollection>> outputHandle(m_outputTrackCollection, ctx);
  ATH_CHECK(outputHandle.record(std::move(outputTracks)));
 
  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 Trk::AddTrackSummaryAlg::initialize ( )

overridevirtual

Definition at line 11 of file AddTrackSummaryAlg.cxx.

                                          {
  ATH_MSG_DEBUG("Initializing " << name());
 
  // Check configuration
  ATH_CHECK(m_inputTrackCollection.initialize());
  ATH_CHECK(m_outputTrackCollection.initialize());
  ATH_CHECK(m_trackSummaryTool.retrieve());
 
  ATH_MSG_INFO("Will add TrackSummary to: " << m_inputTrackCollection.key());
  ATH_MSG_INFO("Output collection: " << m_outputTrackCollection.key());
 
  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_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_inputTrackCollection

SG::ReadHandleKey<TrackCollection> Trk::AddTrackSummaryAlg::m_inputTrackCollection

private

Initial value:

{

this, "InputTrackCollection", "", "Input track collection to add summaries to"}

Input track collection (read-only)

Definition at line 34 of file AddTrackSummaryAlg.h.

34 {

35 this, "InputTrackCollection", "", "Input track collection to add summaries to"};

◆ m_maxAbsEta

Gaudi::Property<float> Trk::AddTrackSummaryAlg::m_maxAbsEta {this, "MaxAbsEta", 99.0, "Only add summary if |eta| < MaxAbsEta"}

private

Definition at line 47 of file AddTrackSummaryAlg.h.

47{this, "MaxAbsEta", 99.0, "Only add summary if |eta| < MaxAbsEta"};

◆ m_minPt

Gaudi::Property<float> Trk::AddTrackSummaryAlg::m_minPt {this, "MinPt", 0.0, "Only add summary if pT > MinPt [MeV]"}

private

Definition at line 46 of file AddTrackSummaryAlg.h.

46{this, "MinPt", 0.0, "Only add summary if pT > MinPt [MeV]"};

◆ m_outputTrackCollection

SG::WriteHandleKey<ConstDataVector<TrackCollection> > Trk::AddTrackSummaryAlg::m_outputTrackCollection

private

Initial value:

{

this, "OutputTrackCollection", "", "Output track collection with summaries added"}

Output track collection with summaries added.

Definition at line 38 of file AddTrackSummaryAlg.h.

38 {

39 this, "OutputTrackCollection", "", "Output track collection with summaries added"};

◆ m_trackSummaryTool

ToolHandle<Trk::ITrackSummaryTool> Trk::AddTrackSummaryAlg::m_trackSummaryTool

private

Initial value:

{

this, "TrackSummaryTool", "", "Track summary tool"}

Track summary tool.

Definition at line 42 of file AddTrackSummaryAlg.h.

42 {

43 this, "TrackSummaryTool", "", "Track summary tool"};

◆ 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

◆ AddTrackSummaryAlg()

◆ ~AddTrackSummaryAlg()

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_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_inputTrackCollection

◆ m_maxAbsEta

◆ m_minPt

◆ m_outputTrackCollection

◆ m_trackSummaryTool

◆ m_varHandleArraysDeclared

◆ m_vhka