ATLAS Offline Software
Loading...
Searching...
No Matches
Trk::EventToTrackLinkNtupleTool Class Reference

#include <EventToTrackLinkNtupleTool.h>

Inheritance diagram for Trk::EventToTrackLinkNtupleTool:
Collaboration diagram for Trk::EventToTrackLinkNtupleTool:

Public Member Functions

 EventToTrackLinkNtupleTool (const std::string &, const std::string &, const IInterface *)
 ~EventToTrackLinkNtupleTool ()
StatusCode initialize ()
StatusCode finalize ()
virtual void registerTrackCollections (const std::vector< std::string > &collections, bool doTruth)
 see interface for documentation
virtual void setTrackTreeIndices (unsigned int, int, int)
 see interface for documentation
virtual void setGenParticleTreeIndices (int, int)
 see interface for documentation
virtual StatusCode addNtupleItems (TTree *, const std::string &)
 add branches to the tree Should be called once dunring the initialisation phase by the calling algorithm (usually Trk::TrackValidationNtupleWriter)
virtual StatusCode fillEventData ()
 calculate event-wide data and copy into TTree branches, but don't write the record yet.
virtual StatusCode resetVariables ()
 reset ntuple variables (mainly for vectors which need to be cleared)
virtual bool isTrackLinkTool () const
 is True if instance is Tool which links events property to Trk::Tracks
virtual bool isTrkParticleLinkTool () const
 is True if instance is Tool which links events property to Rec::TrkParticle
virtual bool isTrkParticleTrigLinkTool () const
 is True if instance is Tool which links events property to Rec::TrkParticle recieved useing TrigDecTool
virtual bool isInDetTrackTrigLinkTool () const
 is True if instance is Tool which links events property to InDetTrack recieved useing TrigDecTool
virtual bool isEvtPropertyTool () const
 is True if instance is EventPropertyTool
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 sysInitialize () override
 Perform system initialization for an algorithm.
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

Static Public Member Functions

static const InterfaceID & interfaceID ()
 Interface ID, declared here, and defined below*‍/.

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< StoreGateSvcStoreGateSvc_t

Private Member Functions

StatusCode checkCollectionType () const
 checks if recieved string collectionType corresponds to some collection type names [Trk::Track, Rec::TrackParticle, Rec::TrackParticle_Trig]
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

std::string m_collectionType
TTree * m_eventLinkTree
 pointer to event-wise ntuple trees (one for all input track collections + truth)
bool m_doTruth
 Switch to turn on / off truth.
std::vector< std::string > m_trackCollections
 name of the TrackCollections to form tree branch names later
std::vector< int > m_trackIndexBegin
 index-based link from event tree to track tree entry.
std::vector< int > m_nTracksPerEvent
int m_genParticleIndexBegin
 index-based link from event tree to truth tree entry.
int m_nGenParticlesPerEvent
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

Static Private Attributes

static const std::string s_trackTypeName = "Trk::Track"
 denotes instance which deals with Trk::Track
static const std::string s_trkParticleTypeName = "Rec::TrackParticle"
 denotes instance which deals with Rec::TrackParticle
static const std::string s_trkParticleTrigTypeName = "Rec::TrackParticle_Trig"
 denotes instance which deals with Rec::TrackParticle obtained as feature using TriDecTool
static const std::string s_inDetTrackTrigTypeName = "InDetTrack_Trig"
 denotes instance which deals with InDetTrack obtained as feature using TriDecTool

Detailed Description

Definition at line 32 of file EventToTrackLinkNtupleTool.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ EventToTrackLinkNtupleTool()

EventToTrackLinkNtupleTool::EventToTrackLinkNtupleTool ( const std::string & t,
const std::string & n,
const IInterface * p )

Definition at line 25 of file EventToTrackLinkNtupleTool.cxx.

29 :
30 AthAlgTool(t,n,p),
32 m_eventLinkTree(nullptr),
33 m_doTruth{},
34 m_trackIndexBegin(std::vector<int>()),
35 m_nTracksPerEvent(std::vector<int>()),
38{
39 declareInterface<IEventPropertyNtupleTool>(this);
40 declareProperty("CollectionType",m_collectionType, "Type of collection which associated with this instance ["
42}
AthAlgTool()
Default constructor:
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)
static const std::string s_inDetTrackTrigTypeName
denotes instance which deals with InDetTrack obtained as feature using TriDecTool
static const std::string s_trkParticleTypeName
denotes instance which deals with Rec::TrackParticle
bool m_doTruth
Switch to turn on / off truth.
std::vector< int > m_trackIndexBegin
index-based link from event tree to track tree entry.
TTree * m_eventLinkTree
pointer to event-wise ntuple trees (one for all input track collections + truth)
int m_genParticleIndexBegin
index-based link from event tree to truth tree entry.
static const std::string s_trkParticleTrigTypeName
denotes instance which deals with Rec::TrackParticle obtained as feature using TriDecTool
static const std::string s_trackTypeName
denotes instance which deals with Trk::Track

◆ ~EventToTrackLinkNtupleTool()

EventToTrackLinkNtupleTool::~EventToTrackLinkNtupleTool ( )
default

Member Function Documentation

◆ addNtupleItems()

StatusCode EventToTrackLinkNtupleTool::addNtupleItems ( TTree * tree,
const std::string & cbnt_prefix )
virtual

add branches to the tree Should be called once dunring the initialisation phase by the calling algorithm (usually Trk::TrackValidationNtupleWriter)

Implements Trk::IEventPropertyNtupleTool.

Definition at line 65 of file EventToTrackLinkNtupleTool.cxx.

65 {
66 if (!tree) return StatusCode::FAILURE;
67 //-----------------
68 // add items
70 for (unsigned int tColIndex = 0; tColIndex<m_trackCollections.size(); tColIndex++) {
71 m_eventLinkTree->Branch((cbnt_prefix+m_trackCollections[tColIndex]+"IndexBegin").c_str(),
72 &(m_trackIndexBegin.at(tColIndex)) );
73 m_eventLinkTree->Branch((cbnt_prefix+"n"+m_trackCollections[tColIndex]+"PerEvent").c_str(),
74 &(m_nTracksPerEvent.at(tColIndex)) );
75 }
76 if ( m_doTruth ){
77 m_eventLinkTree->Branch((cbnt_prefix+"GenParticlesIndexBegin").c_str(), &m_genParticleIndexBegin );
78 m_eventLinkTree->Branch((cbnt_prefix+"nGenParticlesPerEvent").c_str(), &m_nGenParticlesPerEvent );
79 }
80 return StatusCode::SUCCESS;
81}
std::vector< std::string > m_trackCollections
name of the TrackCollections to form tree branch names later
TChain * tree

◆ checkCollectionType()

StatusCode EventToTrackLinkNtupleTool::checkCollectionType ( ) const
private

checks if recieved string collectionType corresponds to some collection type names [Trk::Track, Rec::TrackParticle, Rec::TrackParticle_Trig]

Definition at line 109 of file EventToTrackLinkNtupleTool.cxx.

109 {
111 ATH_MSG_ERROR ("Recieved collection type: "<< m_collectionType
112 <<"does not correspond to any of following types:"<< s_trackTypeName
115
116 return StatusCode::FAILURE;
117 }
118 return StatusCode::SUCCESS;
119}
#define ATH_MSG_ERROR(x)

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }

◆ declareProperty()

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

Definition at line 145 of file AthCommonDataStore.h.

145 {
146 typedef typename SG::HandleClassifier<T>::type htype;
148 }
Gaudi::Details::PropertyBase & declareGaudiProperty(Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
specialization for handling Gaudi::Property<SG::VarHandleKey>

◆ detStore()

const ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const
inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

◆ evtStore()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )
inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::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

◆ fillEventData()

StatusCode EventToTrackLinkNtupleTool::fillEventData ( )
virtual

calculate event-wide data and copy into TTree branches, but don't write the record yet.

Implements Trk::IEventPropertyNtupleTool.

Definition at line 101 of file EventToTrackLinkNtupleTool.cxx.

101 {
102 return StatusCode::SUCCESS;
103}

◆ finalize()

StatusCode EventToTrackLinkNtupleTool::finalize ( )

Definition at line 53 of file EventToTrackLinkNtupleTool.cxx.

53 {
54 ATH_MSG_DEBUG ("finalize successfull in "<<name());
55 return StatusCode::SUCCESS;
56}
#define ATH_MSG_DEBUG(x)

◆ initialize()

StatusCode EventToTrackLinkNtupleTool::initialize ( )

Definition at line 47 of file EventToTrackLinkNtupleTool.cxx.

47 {
48 if(checkCollectionType().isFailure()) return StatusCode::FAILURE;
49 ATH_MSG_DEBUG ("initialise successful in "<<name());
50 return AthAlgTool::initialize();
51}
StatusCode checkCollectionType() const
checks if recieved string collectionType corresponds to some collection type names [Trk::Track,...

◆ inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

◆ interfaceID()

const InterfaceID & Trk::IEventPropertyNtupleTool::interfaceID ( )
inlinestaticinherited

Interface ID, declared here, and defined below*‍/.

Definition at line 77 of file IEventPropertyNtupleTool.h.

77 {
79}
static const InterfaceID IID_IEventPropertyNtupleTool("IEventPropertyNtupleTool", 1, 0)

◆ isEvtPropertyTool()

bool EventToTrackLinkNtupleTool::isEvtPropertyTool ( ) const
inlinevirtual

is True if instance is EventPropertyTool

Implements Trk::IEventPropertyNtupleTool.

Definition at line 116 of file EventToTrackLinkNtupleTool.h.

116 {
117 return false;
118 }

◆ isInDetTrackTrigLinkTool()

bool EventToTrackLinkNtupleTool::isInDetTrackTrigLinkTool ( ) const
inlinevirtual

is True if instance is Tool which links events property to InDetTrack recieved useing TrigDecTool

Implements Trk::IEventPropertyNtupleTool.

Definition at line 111 of file EventToTrackLinkNtupleTool.h.

111 {
112 if( m_collectionType == s_inDetTrackTrigTypeName) return true;
113 return false;
114 }

◆ isTrackLinkTool()

bool EventToTrackLinkNtupleTool::isTrackLinkTool ( ) const
inlinevirtual

is True if instance is Tool which links events property to Trk::Tracks

Implements Trk::IEventPropertyNtupleTool.

Definition at line 96 of file EventToTrackLinkNtupleTool.h.

96 {
97 if( m_collectionType == s_trackTypeName) return true;
98 return false;
99 }

◆ isTrkParticleLinkTool()

bool EventToTrackLinkNtupleTool::isTrkParticleLinkTool ( ) const
inlinevirtual

is True if instance is Tool which links events property to Rec::TrkParticle

Implements Trk::IEventPropertyNtupleTool.

Definition at line 101 of file EventToTrackLinkNtupleTool.h.

101 {
102 if( m_collectionType == s_trkParticleTypeName) return true;
103 return false;
104 }

◆ isTrkParticleTrigLinkTool()

bool EventToTrackLinkNtupleTool::isTrkParticleTrigLinkTool ( ) const
inlinevirtual

is True if instance is Tool which links events property to Rec::TrkParticle recieved useing TrigDecTool

Implements Trk::IEventPropertyNtupleTool.

Definition at line 106 of file EventToTrackLinkNtupleTool.h.

106 {
108 return false;
109 }

◆ msg()

MsgStream & AthCommonMsg< AlgTool >::msg ( ) const
inlineinherited

Definition at line 24 of file AthCommonMsg.h.

24 {
25 return this->msgStream();
26 }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl) const
inlineinherited

Definition at line 30 of file AthCommonMsg.h.

30 {
31 return this->msgLevel(lvl);
32 }

◆ outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< AlgTool > >::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.

◆ registerTrackCollections()

void EventToTrackLinkNtupleTool::registerTrackCollections ( const std::vector< std::string > & collections,
bool doTruth )
virtual

see interface for documentation

Implements Trk::IEventPropertyNtupleTool.

Definition at line 58 of file EventToTrackLinkNtupleTool.cxx.

◆ 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< AlgTool > >::renounce ( T & h)
inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

381 {
382 h.renounce();
384 }
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)

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ resetVariables()

StatusCode EventToTrackLinkNtupleTool::resetVariables ( )
virtual

reset ntuple variables (mainly for vectors which need to be cleared)

Implements Trk::IEventPropertyNtupleTool.

Definition at line 105 of file EventToTrackLinkNtupleTool.cxx.

105 {
106 return StatusCode::SUCCESS;
107}

◆ setGenParticleTreeIndices()

void EventToTrackLinkNtupleTool::setGenParticleTreeIndices ( int indexBegin,
int nGenParticlesPerEvent )
virtual

see interface for documentation

Implements Trk::IEventPropertyNtupleTool.

Definition at line 94 of file EventToTrackLinkNtupleTool.cxx.

96 {
97 m_genParticleIndexBegin = indexBegin;
98 m_nGenParticlesPerEvent = nGenParticlesPerEvent;
99}

◆ setTrackTreeIndices()

void EventToTrackLinkNtupleTool::setTrackTreeIndices ( unsigned int tColIndex,
int indexBegin,
int nTracksPerEvent )
virtual

see interface for documentation

Implements Trk::IEventPropertyNtupleTool.

Definition at line 83 of file EventToTrackLinkNtupleTool.cxx.

86 {
87 ATH_MSG_DEBUG ("start setTrackTreeIndices");
88 ATH_MSG_VERBOSE ("Collection index "<<tColIndex<<"\tm_trackIndexBegin\t"<< m_trackIndexBegin.size() );
89 m_trackIndexBegin[tColIndex] = indexBegin;
90 m_nTracksPerEvent[tColIndex] = nTracksPerEvent;
91 if (m_nTracksPerEvent[tColIndex]==0) m_trackIndexBegin[tColIndex]=0;
92}
#define ATH_MSG_VERBOSE(x)

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )
overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::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< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )
inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

308 {
309 // debug() << "updateVHKA for property " << p.name() << " " << p.toString()
310 // << " size: " << m_vhka.size() << endmsg;
311 for (auto &a : m_vhka) {
313 for (auto k : keys) {
314 k->setOwner(this);
315 }
316 }
317 }
std::vector< SG::VarHandleKeyArray * > m_vhka

Member Data Documentation

◆ m_collectionType

std::string Trk::EventToTrackLinkNtupleTool::m_collectionType
private

Definition at line 76 of file EventToTrackLinkNtupleTool.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore
privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doTruth

bool Trk::EventToTrackLinkNtupleTool::m_doTruth
private

Switch to turn on / off truth.

Definition at line 78 of file EventToTrackLinkNtupleTool.h.

◆ m_eventLinkTree

TTree* Trk::EventToTrackLinkNtupleTool::m_eventLinkTree
private

pointer to event-wise ntuple trees (one for all input track collections + truth)

Definition at line 77 of file EventToTrackLinkNtupleTool.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore
privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_genParticleIndexBegin

int Trk::EventToTrackLinkNtupleTool::m_genParticleIndexBegin
private

index-based link from event tree to truth tree entry.

Definition at line 84 of file EventToTrackLinkNtupleTool.h.

◆ m_nGenParticlesPerEvent

int Trk::EventToTrackLinkNtupleTool::m_nGenParticlesPerEvent
private

of true tracks per event, to form truth loop.

Definition at line 85 of file EventToTrackLinkNtupleTool.h.

◆ m_nTracksPerEvent

std::vector<int> Trk::EventToTrackLinkNtupleTool::m_nTracksPerEvent
private

of tracks per event, to form track loop.

Definition at line 83 of file EventToTrackLinkNtupleTool.h.

◆ m_trackCollections

std::vector<std::string> Trk::EventToTrackLinkNtupleTool::m_trackCollections
private

name of the TrackCollections to form tree branch names later

Definition at line 79 of file EventToTrackLinkNtupleTool.h.

◆ m_trackIndexBegin

std::vector<int> Trk::EventToTrackLinkNtupleTool::m_trackIndexBegin
private

index-based link from event tree to track tree entry.

Definition at line 82 of file EventToTrackLinkNtupleTool.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka
privateinherited

Definition at line 398 of file AthCommonDataStore.h.

◆ s_inDetTrackTrigTypeName

const std::string EventToTrackLinkNtupleTool::s_inDetTrackTrigTypeName = "InDetTrack_Trig"
staticprivate

denotes instance which deals with InDetTrack obtained as feature using TriDecTool

Definition at line 90 of file EventToTrackLinkNtupleTool.h.

◆ s_trackTypeName

const std::string EventToTrackLinkNtupleTool::s_trackTypeName = "Trk::Track"
staticprivate

denotes instance which deals with Trk::Track

Definition at line 87 of file EventToTrackLinkNtupleTool.h.

◆ s_trkParticleTrigTypeName

const std::string EventToTrackLinkNtupleTool::s_trkParticleTrigTypeName = "Rec::TrackParticle_Trig"
staticprivate

denotes instance which deals with Rec::TrackParticle obtained as feature using TriDecTool

Definition at line 89 of file EventToTrackLinkNtupleTool.h.

◆ s_trkParticleTypeName

const std::string EventToTrackLinkNtupleTool::s_trkParticleTypeName = "Rec::TrackParticle"
staticprivate

denotes instance which deals with Rec::TrackParticle

Definition at line 88 of file EventToTrackLinkNtupleTool.h.


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