#include <MuonDecayTruthTrajectoryBuilder.h>

Inheritance diagram for Muon::MuonDecayTruthTrajectoryBuilder:

Collaboration diagram for Muon::MuonDecayTruthTrajectoryBuilder:

Public Member Functions
	MuonDecayTruthTrajectoryBuilder (const std::string &type, const std::string &name, const IInterface *parent)
void	buildTruthTrajectory (TruthTrajectory *result, const HepMC::ConstGenParticlePtr &input) const override
	Build a TruthTrajectory this particle belongs to.
HepMC::ConstGenParticlePtr	getMother (const HepMC::ConstGenParticlePtr &particle) const override
	Returns an umambiguous mother of the truth particle on a TruthTrajectory, or 0.
HepMC::ConstGenParticlePtr	getDaughter (const HepMC::ConstGenParticlePtr &particle) const override
	Returns an umambiguous daughter of the truth particle on a TruthTrajectory, or 0.
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 ()

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 std::pair< HepMC::ConstGenParticlePtr, HepMC::ConstGenParticlePtr >	MotherDaughter
	Return type for the next method.
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
MotherDaughter	truthTrajectoryCuts (const HepMC::ConstGenVertexPtr &vtx) const
	Decides if the vertex connects two particles on the same TruthTrajectory.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
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

Definition at line 18 of file MuonDecayTruthTrajectoryBuilder.h.

Member Typedef Documentation

◆ MotherDaughter

typedef std::pair<HepMC::ConstGenParticlePtr, HepMC::ConstGenParticlePtr> Muon::MuonDecayTruthTrajectoryBuilder::MotherDaughter

private

Return type for the next method.

Definition at line 39 of file MuonDecayTruthTrajectoryBuilder.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ MuonDecayTruthTrajectoryBuilder()

Muon::MuonDecayTruthTrajectoryBuilder::MuonDecayTruthTrajectoryBuilder	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Definition at line 21 of file MuonDecayTruthTrajectoryBuilder.cxx.

                                                                                               :
        AthAlgTool(type, name, parent)
    // ,m_isDecayIntoTwoMuons(false)
    {
        declareInterface<Trk::ITruthTrajectoryBuilder>(this);
    }

Member Function Documentation

◆ buildTruthTrajectory()

void Muon::MuonDecayTruthTrajectoryBuilder::buildTruthTrajectory	(	TruthTrajectory *	result,
		const HepMC::ConstGenParticlePtr &	input ) const

overridevirtual

Build a TruthTrajectory this particle belongs to.

The result may be an empty TruthTrajectory (in case input did not pass the cuts).

Implements Trk::ITruthTrajectoryBuilder.

Definition at line 29 of file MuonDecayTruthTrajectoryBuilder.cxx.

                                                                                                                                   {
        result->clear();
        if (input) {
            HepMC::ConstGenParticlePtr next{nullptr};
            auto current = input;
            ATH_MSG_DEBUG(" New TruthTrajectory: input: " << input << " PDG id " << input->pdg_id());
 
            // Extend trajectory outwards.  The last particle should go at [0]
            // in the TruthTrajectory, so we need to use a tmp storage while
            // traversing the structure.
            std::stack<HepMC::ConstGenParticlePtr> tmp;
            while ((next = getDaughter(current))) { tmp.push(current = next); }
 
            // copy the outer half to result
            while (!tmp.empty()) {
                ATH_MSG_DEBUG(" Adding daughter: " << current); // FIXME "current" is not changed in this loop - it might make sense to print tmp.top() instead here?
                result->emplace_back(tmp.top(),tmp.top()->parent_event()->event_number(),HepMcParticleLink::IS_EVENTNUM);
                tmp.pop();
            }
 
            // The input particle itself
            result->emplace_back(input,input->parent_event()->event_number(),HepMcParticleLink::IS_EVENTNUM);
 
            // Now continue towards the interaction point
            while ((next = getMother(current))) {
                ATH_MSG_DEBUG(" Adding mother:  " << current); // FIXME "current" here refers to the child particle rather than the mother? Consider moving this after "current = next"
                current = next;
                result->emplace_back(current,current->parent_event()->event_number(),HepMcParticleLink::IS_EVENTNUM);
            }
 
            ATH_MSG_DEBUG(" Final TruthTrajectory: ");
            std::vector<HepMcParticleLink>::const_iterator pit = result->begin();
            std::vector<HepMcParticleLink>::const_iterator pit_end = result->end();
            for (; pit != pit_end; ++pit) {
                const HepMC::GenParticle& par = *pit->cptr();
                if (msgLvl(MSG::DEBUG)) {
                    msg(MSG::DEBUG) << " PDG ID " << par.pdg_id() 
                                    << " pt: " << par.momentum().perp();
                    if (par.production_vertex())
                        msg(MSG::DEBUG) << " vertices prod: r " << par.production_vertex()->position().perp() << " z "
                                        << par.production_vertex()->position().z();
                    if (par.end_vertex())
                        msg(MSG::DEBUG) << " end: r " << par.end_vertex()->position().perp() << " z " << par.end_vertex()->position().z();
                    msg(MSG::DEBUG) << endmsg;
                }
            }
        }
    }

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

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

◆ declareProperty()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

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

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ getDaughter()

HepMC::ConstGenParticlePtr Muon::MuonDecayTruthTrajectoryBuilder::getDaughter ( const HepMC::ConstGenParticlePtr & particle ) const

overridevirtual

Returns an umambiguous daughter of the truth particle on a TruthTrajectory, or 0.

This assumes no one mother can correspond to no more than one daughter. Implemented via truthTrajectoryCuts().

Implements Trk::ITruthTrajectoryBuilder.

Definition at line 143 of file MuonDecayTruthTrajectoryBuilder.cxx.

                                                                                                                      {
      if(mother) {
        MotherDaughter res = truthTrajectoryCuts(mother->end_vertex());
        if(res.first == mother) return res.second;
      }
      return {nullptr};
    }

◆ getMother()

HepMC::ConstGenParticlePtr Muon::MuonDecayTruthTrajectoryBuilder::getMother ( const HepMC::ConstGenParticlePtr & particle ) const

overridevirtual

Returns an umambiguous mother of the truth particle on a TruthTrajectory, or 0.

Implemented via truthTrajectoryCuts().

Implements Trk::ITruthTrajectoryBuilder.

Definition at line 152 of file MuonDecayTruthTrajectoryBuilder.cxx.

                                                                                                                      {
        return daughter ? truthTrajectoryCuts(daughter->production_vertex()).first : HepMC::ConstGenParticlePtr{nullptr};
    }

◆ 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::ITruthTrajectoryBuilder::interfaceID ( )

inlinestaticinherited

Definition at line 27 of file ITruthTrajectoryBuilder.h.

27{ return IID_ITruthTrajectoryBuilder; }

Trk::IID_ITruthTrajectoryBuilder

static const InterfaceID IID_ITruthTrajectoryBuilder("Trk::ITruthTrajectoryBuilder", 1, 0)

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

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

◆ truthTrajectoryCuts()

MuonDecayTruthTrajectoryBuilder::MotherDaughter Muon::MuonDecayTruthTrajectoryBuilder::truthTrajectoryCuts ( const HepMC::ConstGenVertexPtr & vtx ) const

private

Decides if the vertex connects two particles on the same TruthTrajectory.

Returns the (mother,daughter) pair, where either of the two can be NULL.

This interface implies that there is one-to-one correspondence between mother and daughter particles; i.e. TruthTrajectories are not allowed to branch.

Definition at line 79 of file MuonDecayTruthTrajectoryBuilder.cxx.

                                                 {
        HepMC::ConstGenParticlePtr mother{nullptr};
        HepMC::ConstGenParticlePtr daughter{nullptr};
        int particles_in_size = vtx ? vtx->particles_in_size() : 0;
        int particles_out_size = vtx ? vtx->particles_out_size() : 0;
        if (vtx && msgLvl(MSG::DEBUG)) msg(MSG::DEBUG) << " new vertex: nparticles in " << particles_in_size << endmsg;
        // only truth vertices with 1 incoming particle
        if (vtx && (particles_in_size == 1)) {
#ifdef HEPMC3
            mother = vtx->particles_in().front();
#else
            mother = *vtx->particles_in_const_begin();
#endif
 
            if (mother && msgLvl(MSG::DEBUG))
                msg(MSG::DEBUG) << " new mother: " << mother->pdg_id() << " status " << mother->status() << " particles out "
                                << particles_out_size << endmsg;
            // Allow status code 1 and 2.  E.g. a pion that produced a long track can decay  outside of InDet and have status==2.
            if (mother && MC::isPhysical(mother)) {
                unsigned int nDecayMuons = 0;
                HepMC::ConstGenParticlePtr passed_cuts{nullptr};
                for (const auto& candidate : *vtx) {
                    if (msgLvl(MSG::DEBUG)) {
                        msg(MSG::DEBUG) << " PDG ID " << candidate->pdg_id() << " particle: " << candidate
                                        << " pt: " << candidate->momentum().perp();
                        if (candidate->production_vertex())
                            msg(MSG::DEBUG) << " vertices prod: r " << candidate->production_vertex()->position().perp() << " z "
                                            << candidate->production_vertex()->position().z();
                        if (candidate->end_vertex())
                            msg(MSG::DEBUG) << " end: r " << candidate->end_vertex()->position().perp() << " z "
                                            << candidate->end_vertex()->position().z();
                        msg(MSG::DEBUG) << endmsg;
                    }
 
                    if (candidate->pdg_id() == mother->pdg_id()) {
                        if (passed_cuts && MC::isElectron(mother)) {  // second negative electron is a special case
                            if (candidate->momentum().e() > passed_cuts->momentum().e()) { passed_cuts = candidate; }
                        } else {
                            passed_cuts = candidate;
                        }
                    } else if (MC::isMuon(candidate)) {
                        ATH_MSG_DEBUG(" selecting Decay into muon ");
                        ++nDecayMuons;
                        passed_cuts = candidate;
                    } else {  // temp addition for debugging
                        msg(MSG::DEBUG) << " Neither muon nor identical pdgId " << endmsg;
                        passed_cuts = candidate;
                    }
                }
 
                if (nDecayMuons > 0) {
                    daughter = std::move(passed_cuts);
                    if (nDecayMuons == 2) {
                        ATH_MSG_DEBUG(" decay into two muons ");
                    }
                }
            }  
        }
 
        return std::make_pair(mother, daughter);
    }

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

Member Data Documentation

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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MotherDaughter

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MuonDecayTruthTrajectoryBuilder()

Member Function Documentation

◆ buildTruthTrajectory()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ getDaughter()

◆ getMother()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ truthTrajectoryCuts()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka