#include <xAODtoHepMCTool.h>

Inheritance diagram for xAODtoHepMCTool:

Collaboration diagram for xAODtoHepMCTool:

Public Member Functions
	xAODtoHepMCTool (const std::string &name)

virtual	~xAODtoHepMCTool ()

virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

StatusCode	finalize () override

std::vector< HepMC::GenEvent >	getHepMCEvents (const xAOD::TruthEventContainer xTruthEventContainer, const xAOD::EventInfo eventInfo) const override

virtual void	print () const
	Print the state of the tool. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

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

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

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

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
HepMC::GenEvent	createHepMCEvent (const xAOD::TruthEvent xEvt, const xAOD::EventInfo eventInfo) const

HepMC::GenVertexPtr	vertexHelper (const xAOD::TruthVertex , std::map< const xAOD::TruthVertex , HepMC::GenVertexPtr > &, bool &) const

HepMC::GenParticlePtr	createHepMCParticle (const xAOD::TruthParticle *) const

HepMC::GenVertexPtr	createHepMCVertex (const xAOD::TruthVertex *) const

void	printxAODEvent (const xAOD::TruthEvent event, const xAOD::EventInfo eventInfo) const

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
Gaudi::Property< float >	m_momFac
	Input container key (job property) More...

Gaudi::Property< float >	m_lenFac

Gaudi::Property< bool >	m_signalOnly

Gaudi::Property< int >	m_maxCount

std::atomic< int >	m_evtCount {}
	Counters. More...

std::atomic< int >	m_badSuggest {}

int	m_noProdVtx {}

int	m_badBeams {}

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 22 of file xAODtoHepMCTool.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

◆ xAODtoHepMCTool()

xAODtoHepMCTool::xAODtoHepMCTool ( const std::string & name )

Definition at line 11 of file xAODtoHepMCTool.cxx.

     : asg::AsgTool(name)
 {
 }

◆ ~xAODtoHepMCTool()

virtual xAODtoHepMCTool::~xAODtoHepMCTool ( )

inlinevirtual

Definition at line 26 of file xAODtoHepMCTool.h.

26 { };

Member Function Documentation

◆ createHepMCEvent()

HepMC::GenEvent xAODtoHepMCTool::createHepMCEvent	(	const xAOD::TruthEvent *	xEvt,
		const xAOD::EventInfo *	eventInfo
	)		const

private

EVENT LEVEL

Avoid double deletion

Definition at line 90 of file xAODtoHepMCTool.cxx.

 {
  
   HepMC::GenEvent genEvt;
   #ifdef HEPMC3
   genEvt.set_units(HepMC3::Units::MEV, HepMC3::Units::MM);
   #endif
  
   long long int evtNum = eventInfo->eventNumber();
   genEvt.set_event_number(evtNum);
   ATH_MSG_DEBUG("Start createHepMCEvent for event " << evtNum);
  
   //Weights
   #ifndef XAOD_STANDALONE
   const std::vector<float> weights = xEvt->weights();
   std::map<std::string, int> weightNameMap;
   if (AthAnalysisHelper::retrieveMetadata("/Generation/Parameters","HepMCWeightNames", weightNameMap).isFailure()) {
     ATH_MSG_DEBUG("Couldn't find meta-data for weight names.");
   }
   #ifdef HEPMC3
   std::shared_ptr<HepMC3::GenRunInfo> runinfo = std::make_shared<HepMC3::GenRunInfo>();
   genEvt.set_run_info(std::move(runinfo));
   std::vector<std::string> wnames;
   wnames.reserve(weights.size());
   for (int idx = 0; idx < int(weights.size()); ++idx) {
     for (const auto& it : weightNameMap) {
       if (it.second == idx) {
         wnames.push_back(it.first);
         break;
       }
     }
   }
   genEvt.run_info()->set_weight_names(wnames);
   for ( std::vector<float>::const_iterator wgt = weights.begin(); wgt != weights.end(); ++wgt ) {
     genEvt.weights().push_back(*wgt);
   }
   #else
   if (weightNameMap.size()) {
     HepMC::WeightContainer& wc = genEvt.weights();
     wc.clear();
     for (int idx = 0; idx < int(weights.size()); ++idx) {
       for (const auto& it : weightNameMap) {
         if (it.second == idx) {
           wc[ it.first ] = weights[idx];
           break;
         }
       }
     }
   }
   else {
     for ( std::vector<float>::const_iterator wgt = weights.begin(); wgt != weights.end(); ++wgt ) {
       genEvt.weights().push_back(*wgt);
     }
   }
   #endif
   #endif
  
   // PARTICLES AND VERTICES
   // Map of existing vertices - needed for the tree linking
   std::map<const xAOD::TruthVertex *, HepMC::GenVertexPtr> vertexMap;
  
   // Loop over all of the particles in the event, call particle builder
   for (auto tlink : xEvt->truthParticleLinks()) {
     if (!tlink.isValid()) { continue; }
     const xAOD::TruthParticle *xPart = *tlink;
  
     // sanity check
     if (xPart == nullptr) {
       ATH_MSG_WARNING("xAOD TruthParticle is equal to NULL. This should not happen!");
       continue;
     }
  
     if (!xPart->hasProdVtx() && !xPart->hasDecayVtx()) {
       ATH_MSG_WARNING("xAOD particle with no vertices, uniqueID = " << HepMC::uniqueID(xPart));
       continue;
     }
  
     // skip particles which are Geant4 secondaries
     if (HepMC::is_simulation_particle(xPart)) { continue; }
  
       // Create GenParticle
       // presumably the GenEvent takes ownership of this, but creating a unique_ptr here as that will only happen if there's an associated vertex
 #ifdef HEPMC3
     auto hepmcParticle = createHepMCParticle(xPart);
 #else
     std::unique_ptr<HepMC::GenParticle> hepmcParticle(createHepMCParticle(xPart));
 #endif
  
     // Get the production and decay vertices
     if (xPart->hasProdVtx()) {
       const xAOD::TruthVertex *xAODProdVtx = xPart->prodVtx();
       // skip production vertices which are Geant4 secondaries
       if (HepMC::is_simulation_vertex(xAODProdVtx)) { continue; }
       bool prodVtxSeenBefore(false); // is this new?
       auto hepmcProdVtx = vertexHelper(xAODProdVtx, vertexMap, prodVtxSeenBefore);
       // Set the decay/production links
 #ifdef HEPMC3
       hepmcProdVtx->add_particle_out(hepmcParticle);
 #else
       hepmcProdVtx->add_particle_out(hepmcParticle.get());
 #endif
       // Insert into Event
       if (!prodVtxSeenBefore) {
         genEvt.add_vertex(std::move(hepmcProdVtx));
       }
     }
     else {
       ATH_MSG_VERBOSE("No production vertex found for particle " << HepMC::uniqueID(xPart));
     }
  
     if (xPart->hasDecayVtx()) {
       const xAOD::TruthVertex *xAODDecayVtx = xPart->decayVtx();
       // skip decay vertices which are Geant4 secondaries
       if (HepMC::is_simulation_vertex(xAODDecayVtx)) {
 #ifndef HEPMC3
         if (xPart->hasProdVtx()) { (void)hepmcParticle.release(); }
 #endif
         continue;
       }
       bool decayVtxSeenBefore(false); // is this new?
       auto hepmcDecayVtx = vertexHelper(xAODDecayVtx, vertexMap, decayVtxSeenBefore);
       // Set the decay/production links
 #ifdef HEPMC3
       hepmcDecayVtx->add_particle_in(std::move(hepmcParticle));
 #else
       hepmcDecayVtx->add_particle_in(hepmcParticle.get());
 #endif
       // Insert into Event
       if (!decayVtxSeenBefore) {
         genEvt.add_vertex(std::move(hepmcDecayVtx));
       }
     }
 #ifndef HEPMC3
     (void)hepmcParticle.release();
 #endif
  
   } // end of particle loop
  
   return genEvt;
 }

◆ createHepMCParticle()

HepMC::GenParticlePtr xAODtoHepMCTool::createHepMCParticle ( const xAOD::TruthParticle * particle ) const

private

Definition at line 259 of file xAODtoHepMCTool.cxx.

 {
   ATH_MSG_VERBOSE("Creating GenParticle for uniqueID " << HepMC::uniqueID(particle));
   const HepMC::FourVector fourVec(m_momFac * particle->px(), m_momFac * particle->py(), m_momFac * particle->pz(), m_momFac * particle->e());
   auto hepmcParticle = HepMC::newGenParticlePtr(fourVec, particle->pdgId(), particle->status());
   hepmcParticle->set_generated_mass(m_momFac * particle->m());
   return hepmcParticle;
 }

◆ createHepMCVertex()

HepMC::GenVertexPtr xAODtoHepMCTool::createHepMCVertex ( const xAOD::TruthVertex * vertex ) const

private

Definition at line 269 of file xAODtoHepMCTool.cxx.

 {
   ATH_MSG_VERBOSE("Creating GenVertex for uniqueID " << HepMC::uniqueID(vertex));
   HepMC::FourVector prod_pos(m_lenFac * vertex->x(), m_lenFac * vertex->y(), m_lenFac * vertex->z(), m_lenFac * vertex->t());
   auto genVertex = HepMC::newGenVertexPtr(prod_pos);
   return genVertex;
 }

◆ declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [2/4]

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.

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

◆ declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

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

◆ evtStore() [1/2]

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.

85 { return m_evtStore; }

◆ evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ 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

◆ finalize()

StatusCode xAODtoHepMCTool::finalize ( )

overridevirtual

Implements IxAODtoHepMCTool.

Definition at line 23 of file xAODtoHepMCTool.cxx.

 {
   ATH_MSG_INFO("==============================================================");
   ATH_MSG_INFO("==========    xAOD -> HepMC Tool :: Run Summary     ==========");
   ATH_MSG_INFO("==============================================================");
   if (m_noProdVtx)
   {
     ATH_MSG_INFO("Number of events that have a missing production vertex = " << m_noProdVtx);
   }
   else
   {
     ATH_MSG_INFO("No missing production vertices");
   }
   if (m_badBeams)
   {
     ATH_MSG_INFO("Number events with improperly defined beamparticles = " << m_badBeams);
     ATH_MSG_INFO("Inconsistencies with the beam particles storage in the event record!");
     ATH_MSG_INFO("... check xAOD::TruthEvent record ...");
   }
   else
   {
     ATH_MSG_INFO("No events with undefined beams.");
   }
   ATH_MSG_INFO("==============================================================");
   ATH_MSG_INFO("===================    End Run Summary     ===================");
   ATH_MSG_INFO("==============================================================");
   return StatusCode::SUCCESS;
 }

◆ getHepMCEvents()

std::vector< HepMC::GenEvent > xAODtoHepMCTool::getHepMCEvents	(	const xAOD::TruthEventContainer *	xTruthEventContainer,
		const xAOD::EventInfo *	eventInfo
	)		const

overridevirtual

Implements IxAODtoHepMCTool.

Definition at line 52 of file xAODtoHepMCTool.cxx.

 {
   ++m_evtCount;
   bool doPrint = m_evtCount < m_maxCount;
   // CREATE HEPMC EVENT COLLECTION
   std::vector<HepMC::GenEvent> mcEventCollection;
   // Loop over xAOD truth container
   // Signal event is always first, followed by pileup events
   ATH_MSG_DEBUG("Start event loop");
   for (const xAOD::TruthEvent *xAODEvent : *xTruthEventContainer)
   {
     if (doPrint)
       ATH_MSG_DEBUG("XXX Printing xAOD Event");
     if (doPrint)
       printxAODEvent(xAODEvent, eventInfo);
     // Create GenEvent for each xAOD truth event
     ATH_MSG_DEBUG("Create new GenEvent");
     HepMC::GenEvent&& hepmcEvent = createHepMCEvent(xAODEvent, eventInfo);
     #ifdef HEPMC3
     std::shared_ptr<HepMC3::GenRunInfo> runinfo = std::make_shared<HepMC3::GenRunInfo>(*(hepmcEvent.run_info().get()));
     #endif
     //possibly print info, before moving the object
     if (doPrint){
       ATH_MSG_DEBUG("XXX Printing HepMC Event");
       HepMC::Print::line(std::cout, hepmcEvent);
     }
     // Insert into McEventCollection
     mcEventCollection.push_back(std::move(hepmcEvent));
     #ifdef HEPMC3
     mcEventCollection[mcEventCollection.size()-1].set_run_info(std::move(runinfo));
     #endif
     // Quit if signal only
     if (m_signalOnly)
       break;
   }
   return mcEventCollection;
 }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ initialize()

StatusCode xAODtoHepMCTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 16 of file xAODtoHepMCTool.cxx.

 {
   ATH_MSG_INFO("Initializing xAODtoHepMCTool " << name() << "...");
   ATH_MSG_INFO("SignalOnly         = " << m_signalOnly);
   return StatusCode::SUCCESS;
 }

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

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

◆ msgLvl()

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, LundVariablesTool, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

◆ printxAODEvent()

void xAODtoHepMCTool::printxAODEvent	(	const xAOD::TruthEvent *	event,
		const xAOD::EventInfo *	eventInfo
	)		const

private

Definition at line 279 of file xAODtoHepMCTool.cxx.

 {
  
   std::vector<int> uidPars;
   std::vector<int> uidKids;
  
   long long int evtNum = eventInfo->eventNumber();
  
   std::cout << "======================================================================================" << std::endl;
   std::cout << "xAODTruth Event " << evtNum << std::endl;
   std::cout << "   UniqueID      PDG Id  Status   px(GeV)   py(GeV)   pz(GeV)    E(GeV)   Parent: Decay" << std::endl;
   std::cout << "   -----------------------------------------------------------------------------------" << std::endl;
  
   int nPart = event->nTruthParticles();
   std::ios oldState(nullptr); 
   oldState.copyfmt(std::cout); //save ostream format
   for (int i = 0; i < nPart; ++i)
   {
     const xAOD::TruthParticle *part = event->truthParticle(i);
     if (part == nullptr) continue;
     if (HepMC::generations(part) > 0) continue;
     int id = part->pdgId();
     if (id != 25) continue;
     int stat = part->status();
     float px = part->px() / 1000.;
     float py = part->py() / 1000.;
     float pz = part->pz() / 1000.;
     float e = part->e() / 1000.;
     uidPars.clear();
     uidKids.clear();
  
     if (part->hasProdVtx())
     {
       const xAOD::TruthVertex *pvtx = part->prodVtx();
       if (pvtx)
         uidPars.push_back(HepMC::uniqueID(pvtx));
     }
  
     if (part->hasDecayVtx())
     {
       const xAOD::TruthVertex *dvtx = part->decayVtx();
       if (dvtx)
         uidKids.push_back(HepMC::uniqueID(dvtx));
     }
     
     
     std::cout << std::setw(10) << HepMC::uniqueID(part) << std::setw(12) << id
               << std::setw(8) << stat
               << std::setprecision(2) << std::fixed
               << std::setw(10) << px << std::setw(10) << py
               << std::setw(10) << pz << std::setw(10) << e << "   ";
     std::cout << "P: ";
     for (unsigned int k = 0; k < uidPars.size(); ++k)
     {
       std::cout << uidPars[k] << " ";
     }
     std::cout << "  D: ";
     for (unsigned int k = 0; k < uidKids.size(); ++k)
     {
       std::cout << uidKids[k] << " ";
     }
     std::cout << std::endl;
   }
   std::cout << "======================================================================================" << std::endl;
   std::cout.copyfmt(oldState);//restore ostream format
 }

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

   {
     h.renounce();
     PBASE::renounce (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.

                                                           {
     handlesArray.renounce();
   }

◆ 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 DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

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

                                                {
     // 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);
       }
     }
   }

◆ vertexHelper()

HepMC::GenVertexPtr xAODtoHepMCTool::vertexHelper	(	const xAOD::TruthVertex *	xaodVertex,
		std::map< const xAOD::TruthVertex *, HepMC::GenVertexPtr > &	vertexMap,
		bool &	seenBefore
	)		const

private

Definition at line 235 of file xAODtoHepMCTool.cxx.

 {
  
   HepMC::GenVertexPtr hepmcVertex;
   std::map<const xAOD::TruthVertex *, HepMC::GenVertexPtr>::iterator vMapItr;
   vMapItr = vertexMap.find(xaodVertex);
   // Vertex seen before?
   if (vMapItr != vertexMap.end()) {
     // YES: use the HepMC::Vertex already in the map
     hepmcVertex = (*vMapItr).second;
     seenBefore = true;
   }
   else {
     // NO: create a new HepMC::Vertex
     vertexMap[xaodVertex] = createHepMCVertex(xaodVertex);
     hepmcVertex = vertexMap[xaodVertex];
     seenBefore = false;
   }
   return hepmcVertex;
 }

Member Data Documentation

◆ m_badBeams

int xAODtoHepMCTool::m_badBeams {}

private

Definition at line 60 of file xAODtoHepMCTool.h.

◆ m_badSuggest

std::atomic<int> xAODtoHepMCTool::m_badSuggest {}

mutableprivate

Definition at line 58 of file xAODtoHepMCTool.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_evtCount

std::atomic<int> xAODtoHepMCTool::m_evtCount {}

mutableprivate

Counters.

Definition at line 57 of file xAODtoHepMCTool.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_lenFac

Gaudi::Property<float> xAODtoHepMCTool::m_lenFac

private

Initial value:

{
            this, "LengthFactor", 1.0,
            "Scale factor to be applied to truth lengths to convert from mm, e.g. 0.01 to go to cm"}

Definition at line 46 of file xAODtoHepMCTool.h.

◆ m_maxCount

Gaudi::Property<int> xAODtoHepMCTool::m_maxCount

private

Initial value:

{
            this, "PrintNevents", 0,
            "Maximum number of events to print out"}

Definition at line 52 of file xAODtoHepMCTool.h.

◆ m_momFac

Gaudi::Property<float> xAODtoHepMCTool::m_momFac

private

Initial value:

{
            this, "MomentFactor", 0.001,
            "Scale factor to be applied to truth energy and momenta to convert from MeV, e.g. 0.001 to go to GeV"}

Input container key (job property)

Definition at line 43 of file xAODtoHepMCTool.h.

◆ m_noProdVtx

int xAODtoHepMCTool::m_noProdVtx {}

private

Definition at line 59 of file xAODtoHepMCTool.h.

◆ m_signalOnly

Gaudi::Property<bool> xAODtoHepMCTool::m_signalOnly

private

Initial value:

{
            this, "SignalOnly", true,
            "Convert only the signal event (true), or all events found"}

Definition at line 49 of file xAODtoHepMCTool.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.

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

◆ xAODtoHepMCTool()

◆ ~xAODtoHepMCTool()

Member Function Documentation

◆ createHepMCEvent()

◆ createHepMCParticle()

◆ createHepMCVertex()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ getHepMCEvents()

◆ getKey()

◆ getName()

◆ getProperty()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ printxAODEvent()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

◆ vertexHelper()

Member Data Documentation

◆ m_badBeams

◆ m_badSuggest

◆ m_detStore

◆ m_evtCount

◆ m_evtStore

◆ m_lenFac

◆ m_maxCount

◆ m_momFac

◆ m_noProdVtx

◆ m_signalOnly

◆ m_varHandleArraysDeclared

◆ m_vhka