ATLAS Offline Software
Loading...
Searching...
No Matches
egammaRecBuilder Class Reference

Produces egammaRec objects starting from clusters. More...

#include <egammaRecBuilder.h>

Inheritance diagram for egammaRecBuilder:
Collaboration diagram for egammaRecBuilder:

Public Member Functions

 egammaRecBuilder (const std::string &name, ISvcLocator *pSvcLocator)
virtual StatusCode initialize () override final
virtual StatusCode execute (const EventContext &ctx) const override final
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< StoreGateSvcStoreGateSvc_t

Private Member Functions

template<typename T>
StatusCode RetrieveTool (ToolHandle< T > &tool, bool tool_requested)
 Wrap tool retrieval, ensuring it was named and requested.
Gaudi::Details::PropertyBase & declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
 specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes

SG::ReadHandleKey< xAOD::CaloClusterContainerm_inputClusterContainerKey
 Key for the topo cluster input collection.
SG::WriteHandleKey< EgammaRecContainerm_egammaRecContainerKey
 Key for egammaRec container.
SG::WriteHandleKey< ConstDataVector< EgammaRecContainer > > m_trackMatchedEgammaRecs
ToolHandle< IEMTrackMatchBuilderm_trackMatchBuilder
 Tool to perform track matching.
ToolHandle< IEMConversionBuilderm_conversionBuilder
 Tool to perfrom conversion vertex matching.
Gaudi::Property< bool > m_doTrackMatching
 private member flag to do the track matching
Gaudi::Property< bool > m_doConversions
 private member flag to do the conversion matching
Gaudi::Property< bool > m_doTrackMatchedView
 private member flag to produce of view of track matched egammaRecs
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

Produces egammaRec objects starting from clusters.

The algorithm produces an egammaRec for each input cluster where the matched tracks and vertices are linked. These two matchings are done depending on the flags doTrackMatching and doConversions, by default true. Additionally, if doTrackMatchedView is true a view container of the egammaRecs with matched tracks is created.

Input container:

  • InputClusterContainerName (default=egammaTopoCluster): topo cluster to be used to build the egammaRec Output container:
  • egammaRecContainer (default=egammaRecCollection)
  • trackMatchedView (default = trackMatchedEgammaRecs)

Note that the vertex and track container are specified in the tools used by this algorithm:

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

◆ egammaRecBuilder()

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

Definition at line 22 of file egammaRecBuilder.cxx.

24 : AthReentrantAlgorithm(name, pSvcLocator)
25{}

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.

64{
65 return 0;
66}

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

158 {
160 hndl.value(),
161 hndl.documentation());
162
163 }
Gaudi::Details::PropertyBase & declareProperty(Gaudi::Property< T, V, H > &t)

◆ declareProperty()

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

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

◆ execute()

StatusCode egammaRecBuilder::execute ( const EventContext & ctx) const
finaloverridevirtual

Definition at line 58 of file egammaRecBuilder.cxx.

59{
60 ATH_MSG_DEBUG("Executing egammaRecBuilder");
61
62 SG::ReadHandle<xAOD::CaloClusterContainer> clusters(
64
65 // validity check is only really needed for serial running. Remove when MT is
66 // only way.
67 ATH_CHECK(clusters.isValid());
68
69 SG::WriteHandle<EgammaRecContainer> egammaRecs(m_egammaRecContainerKey, ctx);
70 ATH_CHECK(egammaRecs.record(std::make_unique<EgammaRecContainer>()));
71
72 // one egamma Rec objects per cluster
73 const size_t nClusters = clusters->size();
74 egammaRecs->reserve(nClusters);
75 for (size_t i = 0; i < nClusters; ++i) {
76 const ElementLink<xAOD::CaloClusterContainer> clusterLink(
77 *clusters, i, ctx);
78 const std::vector<ElementLink<xAOD::CaloClusterContainer>>
79 clusterLinkVector{ clusterLink };
80 egammaRecs->push_back(std::make_unique<egammaRec>(clusterLinkVector));
81 }
82
83 // Append track Matching information if requested
85 ATH_CHECK(m_trackMatchBuilder->executeRec(ctx, egammaRecs.ptr()));
86 }
87
88 // Append conversion matching information if requested
89 if (m_doConversions) {
90 for (auto egRec : *egammaRecs) {
91 ATH_CHECK(m_conversionBuilder->executeRec(ctx, egRec));
92 }
93 }
94
95 // create a view of the track matched egRecs if requested
97 SG::WriteHandle<ConstDataVector<EgammaRecContainer>> trackMatchedEgammaRecs(
99
100 auto viewCopy =
101 std::make_unique<ConstDataVector<EgammaRecContainer>>(SG::VIEW_ELEMENTS);
102
103 if (m_doTrackMatching) {
104 for (const egammaRec* eg : *egammaRecs) {
105 if (eg->getNumberOfTrackParticles() > 0) {
106 viewCopy->push_back(eg);
107 }
108 }
109 }
110 ATH_CHECK(trackMatchedEgammaRecs.record(std::move(viewCopy)));
111 }
112
113 return StatusCode::SUCCESS;
114}
#define ATH_CHECK
Evaluate an expression and check for errors.
#define ATH_MSG_DEBUG(x)
SG::WriteHandleKey< EgammaRecContainer > m_egammaRecContainerKey
Key for egammaRec container.
Gaudi::Property< bool > m_doTrackMatching
private member flag to do the track matching
SG::WriteHandleKey< ConstDataVector< EgammaRecContainer > > m_trackMatchedEgammaRecs
Gaudi::Property< bool > m_doTrackMatchedView
private member flag to produce of view of track matched egammaRecs
Gaudi::Property< bool > m_doConversions
private member flag to do the conversion matching
ToolHandle< IEMConversionBuilder > m_conversionBuilder
Tool to perfrom conversion vertex matching.
ToolHandle< IEMTrackMatchBuilder > m_trackMatchBuilder
Tool to perform track matching.
SG::ReadHandleKey< xAOD::CaloClusterContainer > m_inputClusterContainerKey
Key for the topo cluster input collection.
@ VIEW_ELEMENTS
this data object is a view, it does not own its elmts

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

90{
91 // If we didn't find any symlinks to add, just return the collection
92 // from the base class. Otherwise, return the extended collection.
93 if (!m_extendedExtraObjects.empty()) {
95 }
97}
An algorithm that can be simultaneously executed in multiple threads.

◆ filterPassed()

virtual bool AthCommonReentrantAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx) const
inlinevirtualinherited

Definition at line 96 of file AthCommonReentrantAlgorithm.h.

96 {
97 return execState( ctx ).filterPassed();
98 }
virtual bool filterPassed(const EventContext &ctx) const

◆ initialize()

StatusCode egammaRecBuilder::initialize ( )
finaloverridevirtual

Definition at line 28 of file egammaRecBuilder.cxx.

29{
30 // First the data handle keys
34 // retrieve track match builder
36 // retrieve conversion builder
38 return StatusCode::SUCCESS;
39}
StatusCode RetrieveTool(ToolHandle< T > &tool, bool tool_requested)
Wrap tool retrieval, ensuring it was named and requested.

◆ 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()

◆ msg()

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

Definition at line 24 of file AthCommonMsg.h.

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

◆ msgLvl()

bool AthCommonMsg< Gaudi::Algorithm >::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< 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.

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< Gaudi::Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray)
inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

364 {
366 }

◆ RetrieveTool()

template<typename T>
StatusCode egammaRecBuilder::RetrieveTool ( ToolHandle< T > & tool,
bool tool_requested )
private

Wrap tool retrieval, ensuring it was named and requested.

Definition at line 43 of file egammaRecBuilder.cxx.

44{
45 if (!tool_requested) {
46 tool.disable();
47 return StatusCode::SUCCESS;
48 }
49 if (tool.empty()) {
50 ATH_MSG_INFO(tool.type() << " is empty");
51 return StatusCode::FAILURE;
52 }
53 ATH_CHECK(tool.retrieve());
54 return StatusCode::SUCCESS;
55}
#define ATH_MSG_INFO(x)

◆ setFilterPassed()

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

Definition at line 100 of file AthCommonReentrantAlgorithm.h.

100 {
102 }
virtual void setFilterPassed(bool state, const EventContext &ctx) const

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

77{
78 return BaseAlg::sysExecute (ctx);
79}

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

107 {
109
110 if (sc.isFailure()) {
111 return sc;
112 }
113
114 ServiceHandle<ICondSvc> cs("CondSvc",name());
115 for (auto h : outputHandles()) {
116 if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
117 // do this inside the loop so we don't create the CondSvc until needed
118 if ( cs.retrieve().isFailure() ) {
119 ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
120 return StatusCode::SUCCESS;
121 }
122 if (cs->regHandle(this,*h).isFailure()) {
124 ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
125 << " with CondSvc");
126 }
127 }
128 }
129 return sc;
130}
#define ATH_MSG_ERROR(x)
#define ATH_MSG_WARNING(x)
virtual std::vector< Gaudi::DataHandle * > outputHandles() const override

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

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 }

Member Data Documentation

◆ m_conversionBuilder

ToolHandle<IEMConversionBuilder> egammaRecBuilder::m_conversionBuilder
private
Initial value:
{
this,
"ConversionBuilderTool",
"EMConversionBuilder",
"Tool that matches conversion vertices to egammaRecs"
}

Tool to perfrom conversion vertex matching.

Definition at line 84 of file egammaRecBuilder.h.

84 {
85 this,
86 "ConversionBuilderTool",
87 "EMConversionBuilder",
88 "Tool that matches conversion vertices to egammaRecs"
89 };

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

Gaudi::Property<bool> egammaRecBuilder::m_doConversions
private
Initial value:
{ this,
"doConversions",
true,
"Boolean to do conversion matching" }

private member flag to do the conversion matching

Definition at line 98 of file egammaRecBuilder.h.

98 { this,
99 "doConversions",
100 true,
101 "Boolean to do conversion matching" };

◆ m_doTrackMatchedView

Gaudi::Property<bool> egammaRecBuilder::m_doTrackMatchedView
private
Initial value:
{
this,
"doTrackMatchedView",
false,
"Produce a view of the egammaRecs that have an attached track"
}

private member flag to produce of view of track matched egammaRecs

Definition at line 105 of file egammaRecBuilder.h.

105 {
106 this,
107 "doTrackMatchedView",
108 false,
109 "Produce a view of the egammaRecs that have an attached track"
110 };

◆ m_doTrackMatching

Gaudi::Property<bool> egammaRecBuilder::m_doTrackMatching
private
Initial value:
{ this,
"doTrackMatching",
true,
"Boolean to do track matching" }

private member flag to do the track matching

Definition at line 92 of file egammaRecBuilder.h.

92 { this,
93 "doTrackMatching",
94 true,
95 "Boolean to do track matching" };

◆ m_egammaRecContainerKey

SG::WriteHandleKey<EgammaRecContainer> egammaRecBuilder::m_egammaRecContainerKey
private
Initial value:
{
this,
"egammaRecContainer",
"egammaRecCollection",
"Output container for egammaRec objects"
}

Key for egammaRec container.

Definition at line 61 of file egammaRecBuilder.h.

61 {
62 this,
63 "egammaRecContainer",
64 "egammaRecCollection",
65 "Output container for egammaRec objects"
66 };

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

SG::ReadHandleKey<xAOD::CaloClusterContainer> egammaRecBuilder::m_inputClusterContainerKey
private
Initial value:
{
this,
"InputClusterContainerName",
"egammaTopoCluster",
"Name of input cluster container"
}

Key for the topo cluster input collection.

Definition at line 53 of file egammaRecBuilder.h.

53 {
54 this,
55 "InputClusterContainerName",
56 "egammaTopoCluster",
57 "Name of input cluster container"
58 };

◆ m_trackMatchBuilder

ToolHandle<IEMTrackMatchBuilder> egammaRecBuilder::m_trackMatchBuilder
private
Initial value:
{
this,
"TrackMatchBuilderTool",
"EMTrackMatchBuilder",
"Tool that matches tracks to egammaRecs"
}

Tool to perform track matching.

Definition at line 76 of file egammaRecBuilder.h.

76 {
77 this,
78 "TrackMatchBuilderTool",
79 "EMTrackMatchBuilder",
80 "Tool that matches tracks to egammaRecs"
81 };

◆ m_trackMatchedEgammaRecs

SG::WriteHandleKey<ConstDataVector<EgammaRecContainer> > egammaRecBuilder::m_trackMatchedEgammaRecs
private
Initial value:
{
this,
"trackMatchedEgammaRecs",
"trackMatchedEgammaRecs",
"View container of the track matched egammaRecs"
}

Definition at line 69 of file egammaRecBuilder.h.

69 {
70 this,
71 "trackMatchedEgammaRecs",
72 "trackMatchedEgammaRecs",
73 "View container of the track matched egammaRecs"
74 };

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