ATLAS Offline Software
Loading...
Searching...
No Matches
xAODMaker::TruthVertexFixerAlg Class Referencefinal

Algorithm fixing xAOD::TruthVertex objects in (old) DAOD files. More...

#include <TruthVertexFixerAlg.h>

Inheritance diagram for xAODMaker::TruthVertexFixerAlg:
Collaboration diagram for xAODMaker::TruthVertexFixerAlg:

Public Member Functions

virtual StatusCode initialize () override
 Function initialising the algorithm.
virtual StatusCode execute (const EventContext &ctx) const override
 Function executing the algorithm.
 AnaReentrantAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
 Inherit the base class's constructors.
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

virtual::StatusCode finalize ()
 finalize this algorithm
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

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::TruthVertexContainerm_inputContainerKey
 The keys of the input xAOD truth containers.
SG::WriteHandleKey< xAOD::TruthVertexContainerm_outputContainerKey
 The keys for the output xAOD truth containers.
Gaudi::Property< std::vector< std::string > > m_particleLinks
 Names of the truth particle links to fix.
Gaudi::Property< std::vector< std::string > > m_vertexLinks
 Names of the truth vertex links to fix.
Gaudi::Property< std::string > m_linkPrefixToRemove
 Prefix to remove from the link names.
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 fixing xAOD::TruthVertex objects in (old) DAOD files.

This algorithm can be used to translate legacy xAOD::TruthVertex information read in from a DAOD file, which didn't use xAOD::TruthVertexAuxContainer_v1 for storing the information.

Definition at line 26 of file TruthVertexFixerAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t
privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Function Documentation

◆ AnaReentrantAlgorithm()

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

Inherit the base class's constructors.

Definition at line 67 of file AnaReentrantAlgorithm.cxx.

32 : AsgComponent (name)
33#else
34 : AthReentrantAlgorithm (name, pSvcLocator)
35#endif
36 {
37 ANA_MSG_DEBUG ("AnaReentrantAlgorithm: " << name);
38 }
#define ANA_MSG_DEBUG(xmsg)
Macro printing debug messages.

◆ 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 xAODMaker::TruthVertexFixerAlg::execute ( const EventContext & ctx) const
overridevirtual

Function executing the algorithm.

Definition at line 32 of file TruthVertexFixerAlg.cxx.

32 {
33
34 // Access the input container.
35 auto inputContainer = SG::makeHandle(m_inputContainerKey, ctx);
36
37 // Create the output container and its auxiliary store.
38 auto outputContainer = std::make_unique<xAOD::TruthVertexContainer>();
39 auto outputAuxContainer = std::make_unique<xAOD::AuxContainerBase>();
40 outputContainer->setStore(outputAuxContainer.get());
41
42 // Variable(s) specific to the old schema.
43 static const SG::ConstAccessor<int> barcodeAcc("barcode");
44 static const SG::ConstAccessor<int> idAcc("id");
45
46 // Deep-copy the objects in a relatively slow/inefficient way.
47 bool warningPrinted = false;
48 for (const xAOD::TruthVertex* input : *inputContainer) {
49 // Create the output vertex as a (deep) copy of the input one.
51 outputContainer->push_back(output);
52 *output = *input;
53 // Fix up the output vertex if needed.
54 if (barcodeAcc.isAvailable(*output) && idAcc.isAvailable(*output)) {
55 // Access the variables copied from the in-file container.
56 const int id = idAcc(*output);
57 const int barcode = barcodeAcc(*output);
58 // convert "old" id + barcode to "new" status values
59 output->setStatus(HepMC::new_vertex_status_from_old(id, barcode));
60 // The old barcode is still a unique identifier
61 output->setUid(barcode);
62 } else if (warningPrinted == false) {
63 // Print a warning if not, but don't fail.
65 "One or both of xAOD::TruthVertex barcode and id are not available. "
66 "This algorithm should not be run with these inputs.");
67 warningPrinted = true;
68 }
69
70 // Fix the truth particle links on it if needed.
71 for (const std::string& linkName : m_particleLinks.value()) {
72 // Access the link in question.
73 SG::Accessor<std::vector<ElementLink<xAOD::TruthParticleContainer>>>
74 linkAcc(linkName);
75 if (!linkAcc.isAvailable(*output)) {
76 ANA_MSG_ERROR("TruthParticle link \"" << linkName
77 << "\" is not available on "
78 "container \""
79 << m_inputContainerKey.key()
80 << "\"");
81 return StatusCode::FAILURE;
82 }
83 auto& links = linkAcc(*output);
84 // Update the name of the container that it's pointing to.
85 for (auto& link : links) {
86 link.resetWithKeyAndIndex(
87 Details::removePrefix(link.dataID(), m_linkPrefixToRemove.value()),
88 link.index());
89 }
90 }
91
92 // Fix the truth vertex links on it if needed.
93 for (const std::string& linkName : m_vertexLinks.value()) {
94 // Access the link in question.
95 SG::Accessor<std::vector<ElementLink<xAOD::TruthVertexContainer>>>
96 linkAcc(linkName);
97 if (!linkAcc.isAvailable(*output)) {
98 ANA_MSG_ERROR("TruthParticle link \"" << linkName
99 << "\" is not available on "
100 "container \""
101 << m_inputContainerKey.key()
102 << "\"");
103 return StatusCode::FAILURE;
104 }
105 auto& links = linkAcc(*output);
106 // Update the name of the container that it's pointing to.
107 for (auto& link : links) {
108 link.resetWithKeyAndIndex(
109 Details::removePrefix(link.dataID(), m_linkPrefixToRemove.value()),
110 link.index());
111 }
112 }
113 }
114
115 // Record the modified truth vertices.
116 ANA_CHECK(
118 .record(std::move(outputContainer), std::move(outputAuxContainer)));
120 "Recorded TruthVertexContainer with key: " << m_outputContainerKey.key());
121
122 // Return gracefully.
123 return StatusCode::SUCCESS;
124}
#define ANA_MSG_ERROR(xmsg)
Macro printing error messages.
#define ANA_MSG_WARNING(xmsg)
Macro printing warning messages.
#define ANA_CHECK(EXP)
check whether the given expression was successful
Gaudi::Property< std::vector< std::string > > m_particleLinks
Names of the truth particle links to fix.
SG::ReadHandleKey< xAOD::TruthVertexContainer > m_inputContainerKey
The keys of the input xAOD truth containers.
SG::WriteHandleKey< xAOD::TruthVertexContainer > m_outputContainerKey
The keys for the output xAOD truth containers.
Gaudi::Property< std::string > m_linkPrefixToRemove
Prefix to remove from the link names.
Gaudi::Property< std::vector< std::string > > m_vertexLinks
Names of the truth vertex links to fix.
int barcode(const T *p)
Definition Barcode.h:16
int new_vertex_status_from_old(const int oldStatus, const int barcode)
Get vertex status in the new scheme from the barcode and status in the old scheme.
SG::ReadCondHandle< T > makeHandle(const SG::ReadCondHandleKey< T > &key, const EventContext &ctx=Gaudi::Hive::currentContext())
output
Definition merge.py:16
std::string removePrefix(std::string_view str, std::string_view prefix)
Remove a prefix from a string, if it exists.
TruthVertex_v1 TruthVertex
Typedef to implementation.
Definition TruthVertex.h:15

◆ 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

◆ finalize()

StatusCode EL::AnaReentrantAlgorithm::finalize ( )
protectedinherited

finalize this algorithm

This gets called after event processing has finished. The last event may no longer be in memory, and the code should not try to access it.

Definition at line 102 of file AnaReentrantAlgorithm.cxx.

104 {
105 return StatusCode::SUCCESS;
106 }

◆ initialize()

StatusCode xAODMaker::TruthVertexFixerAlg::initialize ( )
overridevirtual

Function initialising the algorithm.

Definition at line 22 of file TruthVertexFixerAlg.cxx.

22 {
23
24 // initialize handles
25 ANA_CHECK(m_inputContainerKey.initialize());
26 ANA_CHECK(m_outputContainerKey.initialize());
27
28 // Return gracefully.
29 return StatusCode::SUCCESS;
30}

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

◆ 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_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_inputContainerKey

SG::ReadHandleKey<xAOD::TruthVertexContainer> xAODMaker::TruthVertexFixerAlg::m_inputContainerKey
private
Initial value:
{
this, "InputContainer", "InputFileTruthVertices",
"Input TruthVertices container"}

The keys of the input xAOD truth containers.

Definition at line 39 of file TruthVertexFixerAlg.h.

39 {
40 this, "InputContainer", "InputFileTruthVertices",
41 "Input TruthVertices container"};

◆ m_linkPrefixToRemove

Gaudi::Property<std::string> xAODMaker::TruthVertexFixerAlg::m_linkPrefixToRemove
private
Initial value:
{
this, "LinkPrefixToRemove", "", "Prefix to remove from the link names"}

Prefix to remove from the link names.

Definition at line 57 of file TruthVertexFixerAlg.h.

57 {
58 this, "LinkPrefixToRemove", "", "Prefix to remove from the link names"};

◆ m_outputContainerKey

SG::WriteHandleKey<xAOD::TruthVertexContainer> xAODMaker::TruthVertexFixerAlg::m_outputContainerKey
private
Initial value:
{
this, "OutputContainer", "TruthVertices",
"Output TruthVertices container"}

The keys for the output xAOD truth containers.

Definition at line 44 of file TruthVertexFixerAlg.h.

44 {
45 this, "OutputContainer", "TruthVertices",
46 "Output TruthVertices container"};

◆ m_particleLinks

Gaudi::Property<std::vector<std::string> > xAODMaker::TruthVertexFixerAlg::m_particleLinks
private
Initial value:
{
this, "ParticleLinks", {}, "Names of the truth particle links to fix"}

Names of the truth particle links to fix.

Definition at line 49 of file TruthVertexFixerAlg.h.

49 {
50 this, "ParticleLinks", {}, "Names of the truth particle links to fix"};

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared
privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vertexLinks

Gaudi::Property<std::vector<std::string> > xAODMaker::TruthVertexFixerAlg::m_vertexLinks
private
Initial value:
{
this, "VertexLinks", {}, "Names of the truth vertex links to fix"}

Names of the truth vertex links to fix.

Definition at line 53 of file TruthVertexFixerAlg.h.

53 {
54 this, "VertexLinks", {}, "Names of the truth vertex links to fix"};

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