#include <TruthDressingTool.h>

Inheritance diagram for DerivationFramework::TruthDressingTool:

Collaboration diagram for DerivationFramework::TruthDressingTool:

Public Member Functions
	TruthDressingTool (const std::string &t, const std::string &n, const IInterface *p)

	~TruthDressingTool ()

StatusCode	initialize ()

virtual StatusCode	addBranches () const
	Pass the thinning service 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 > &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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods. More...

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

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

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

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

Private Attributes
SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_particlesKey {this, "particlesKey", "TruthParticles", "ReadHandleKey for TruthParticles for photon list input"}
	ReadHandleKey input collection key. More...

SG::ReadHandleKey< xAOD::TruthParticleContainer >	m_dressParticlesKey {this, "dressParticlesKey", "TruthParticles", "ReadHandleKey for input particles to be dressed. If taus are selected, everything in this input key will be used"}
	ReadHandleKey for particles to be dressed. More...

SG::ReadDecorHandleKey< xAOD::TruthParticleContainer >	m_truthClassKey {this, "truthClassifierKey", "", "Will be over written during initialize"}
	Ensure that the algorithm is scheduled after the truth classifier. More...

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_eKey {this, "e_dressed", "TruthParticles.e_dressed", "e_dressed decoration"}
	WriteDecorHandleKeys for decorations. More...

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_ptKey {this, "pt_dressed", "TruthParticles.pt_dressed", "pt_dressed decoration"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_etaKey {this, "eta_dressed", "TruthParticles.eta_dressed", "eta_dressed decoration"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_phiKey {this, "phi_dressed", "TruthParticles.phi_dressed", "phi_dressed decoration"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_pt_visKey {this, "pt_vis_dressed", "TruthParticles.pt_vis_dressed", "pt_vis_dressed decoration"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_eta_visKey {this, "eta_vis_dressed", "TruthParticles.eta_vis_dressed", "eta_vis_dressed decoration"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_phi_visKey {this, "phi_vis_dressed", "TruthParticles.phi_vis_dressed", "phi_vis_dressed decoration"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_m_visKey {this, "m_vis_dressed", "TruthParticles.m_vis_dressed", "m_vis_dressed decoration"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorator_nphotonKey {this, "nPhotons_dressed", "TruthParticles.nPhotons_dressed", "nPhotons_dressed decoration"}

SG::WriteDecorHandleKey< xAOD::TruthParticleContainer >	m_decorationKey {this, "DressingKey", "TruthParticles.dressedPhoton", "Dressed photon decoration"}

Gaudi::Property< bool >	m_usePhotonsFromHadrons {this, "usePhotonsFromHadrons", false, "Add photons coming from hadron decays while dressing"}
	Parameter: Use photons from hadron decays? More...

Gaudi::Property< bool >	m_useLeptonsFromHadrons {this, "useLeptonsFromHadrons", false, "Consider leptons coming from hadron decays?"}
	Parameter: Use leptons from hadron decays? More...

Gaudi::Property< float >	m_coneSize {this, "dressingConeSize", 0.1, "Size of dR cone in which to include FSR photons in dressing"}
	Parameter: Cone size for dressing. More...

Gaudi::Property< std::vector< int > >	m_listOfPIDs {this, "particleIDsToDress", {11,13}, "List of the pdgID's of particles to be dressed (usually 11,13). Special treatment for taus (15)"}
	Parameter: List of pdgIDs of particles to dress. More...

Gaudi::Property< bool >	m_useAntiKt {this, "useAntiKt", false, "use anti-k_T instead of fixed-cone dressing"}
	Parameter: Use antikT algorithm for dressing? More...

Gaudi::Property< std::string >	m_decorationName {this, "decorationName", "", "Name of the decoration for photons that were used in dressing"}
	Parameter: Name of the decoration to apply. More...

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

◆ TruthDressingTool()

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

Definition at line 29 of file TruthDressingTool.cxx.

    : AthAlgTool(t,n,p)
 {
     declareInterface<DerivationFramework::IAugmentationTool>(this);
 }

◆ ~TruthDressingTool()

DerivationFramework::TruthDressingTool::~TruthDressingTool ( )

Definition at line 38 of file TruthDressingTool.cxx.

38 {

39 }

Member Function Documentation

◆ addBranches()

StatusCode DerivationFramework::TruthDressingTool::addBranches ( ) const

virtual

Pass the thinning service

Implements DerivationFramework::IAugmentationTool.

Definition at line 74 of file TruthDressingTool.cxx.

 {
     // Get the event context
     const EventContext& ctx = Gaudi::Hive::currentContext();
  
     // Retrieve the truth collections
     SG::ReadHandle<xAOD::TruthParticleContainer> truthParticles(m_particlesKey,ctx);
     if (!truthParticles.isValid()) {
         ATH_MSG_ERROR("Couldn't retrieve TruthParticle collection with name " << m_particlesKey);
         return StatusCode::FAILURE;
     }
  
     SG::ReadHandle<xAOD::TruthParticleContainer> dressTruthParticles(m_dressParticlesKey,ctx);
     if (!dressTruthParticles.isValid()) {
         ATH_MSG_ERROR("Couldn't retrieve TruthParticle collection with name " << m_dressParticlesKey);
         return StatusCode::FAILURE;
     } 
  
     // Decorators
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,float > decorator_e(m_decorator_eKey, ctx);
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,float > decorator_pt(m_decorator_ptKey, ctx);
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,float > decorator_eta(m_decorator_etaKey, ctx);
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,float > decorator_phi(m_decorator_phiKey, ctx);
     // for truth taus, use 'vis' in the decoration name to avoid prompt/visible tau momentum ambiguity
     // use (pt,eta,phi,m) for taus, for consistency with other TauAnalysisTools decorations
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,float > decorator_pt_vis(m_decorator_pt_visKey, ctx);
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,float > decorator_eta_vis(m_decorator_eta_visKey, ctx);
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,float > decorator_phi_vis(m_decorator_phi_visKey, ctx);
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,float > decorator_m_vis(m_decorator_m_visKey, ctx);
     SG::WriteDecorHandle< xAOD::TruthParticleContainer,int > decorator_nphoton(m_decorator_nphotonKey, ctx);
     // One for the photons as well
     SG::WriteDecorHandle< xAOD::TruthParticleContainer, char > dressDec (m_decorationKey, ctx);
     // If we want to decorate, then we need to decorate everything with false to begin with
     if (!m_decorationKey.key().empty()){
       if (!dressDec.isAvailable()) {
         for (const auto * particle : *truthParticles){
           dressDec(*particle);
         }
       } // Loop over particles
     } // We are using the decoration
  
     //get struct of helper functions
     DerivationFramework::DecayGraphHelper decayHelper;
  
     std::vector<const xAOD::TruthParticle*> listOfParticlesToDress;
     std::vector<xAOD::TruthParticle::FourMom_t> listOfDressedParticles;
     std::vector<int> dressedParticlesNPhot;
  
     if(m_listOfPIDs.size()==1 && abs(m_listOfPIDs[0])==15) {
       // when dressing only truth taus, it is assumed that the truth tau container has
       // been built beforehand and is used as input
       for (auto *pItr : *dressTruthParticles) {
         listOfParticlesToDress.push_back(pItr);
       }
     } 
     else {
       // non-prompt particles are still included here to ensure all particles
       // will get the decoration; however further down only the prompt particles
       // are actually dressed depending on the value of m_useLeptonsFromHadrons
       decayHelper.constructListOfFinalParticles(dressTruthParticles.ptr(), listOfParticlesToDress, m_listOfPIDs, true);
     }
  
     //initialize list of dressed particles
     for (const auto& part : listOfParticlesToDress) {
       listOfDressedParticles.push_back(part->p4());
       dressedParticlesNPhot.push_back(0);
     }
  
     //fill the photon list
     std::vector<const xAOD::TruthParticle*>  photonsFSRList;
     std::vector<int> photonPID{22};
     const bool pass = decayHelper.constructListOfFinalParticles(truthParticles.ptr(), photonsFSRList, 
                                                                 photonPID, m_usePhotonsFromHadrons);
     if (!pass) {
       ATH_MSG_WARNING("Cannot construct the list of final state particles "<<m_truthClassKey.fullKey());
     }
  
     static const SG::ConstAccessor<double> pt_visAcc("pt_vis");
     static const SG::ConstAccessor<double> eta_visAcc("eta_vis");
     static const SG::ConstAccessor<double> phi_visAcc("phi_vis");
     static const SG::ConstAccessor<double> mvisAcc("m_vis");
  
     // Do dR-based photon dressing (default)
     if (!m_useAntiKt){
       //loop over photons, uniquely associate each to nearest bare particle
       for (const auto& phot : photonsFSRList ) {
         double dRmin = m_coneSize;
         int idx = -1;
   
         for (size_t i = 0; i < listOfParticlesToDress.size(); ++i) {
           if (!m_useLeptonsFromHadrons) {
             if (!acc_origin.isAvailable(*listOfParticlesToDress[i])) {
               ATH_MSG_WARNING("MCTruthClassifier "<<m_truthClassKey.fullKey() <<" not available, cannot apply notFromHadron veto!");
             }
             unsigned int result = acc_origin(*listOfParticlesToDress[i]);
             const bool isPrompt = MCTruthPartClassifier::isPrompt(result, true);
             if (!isPrompt)  continue;
           }
           xAOD::TruthParticle::FourMom_t bare_part;
           if(listOfParticlesToDress[i]->isTau()) {
   
             if( !pt_visAcc.isAvailable(*listOfParticlesToDress[i]) ||
                 !eta_visAcc.isAvailable(*listOfParticlesToDress[i]) ||
                 !phi_visAcc.isAvailable(*listOfParticlesToDress[i]) ||
                 !mvisAcc.isAvailable(*listOfParticlesToDress[i])) {
               ATH_MSG_ERROR("Visible momentum not available for truth taus, cannot perform dressing!");
               return StatusCode::FAILURE;
             }
   
             bare_part.SetPtEtaPhiM(pt_visAcc(*listOfParticlesToDress[i]),
                                    eta_visAcc(*listOfParticlesToDress[i]),
                                    phi_visAcc(*listOfParticlesToDress[i]),
                                    mvisAcc(*listOfParticlesToDress[i]));
           }
           else {
             bare_part = listOfParticlesToDress[i]->p4();
           }
   
           double dR = bare_part.DeltaR(phot->p4());
           if (dR < dRmin) {
             dRmin = dR;
             idx = i;
           }
         }
   
         if(idx > -1) {
           listOfDressedParticles[idx] += phot->p4();
           dressedParticlesNPhot[idx]++;
           if (!m_decorationName.empty()){
             dressDec(*phot) = 1;
           }
         }
       }
   
       //loop over particles and add decorators
       //for (const auto& part : listOfDressedParticles) {
       for (size_t i = 0; i < listOfParticlesToDress.size(); ++i) {
           const xAOD::TruthParticle* part = listOfParticlesToDress[i];
           xAOD::TruthParticle::FourMom_t& dressedVec = listOfDressedParticles[i];
   
         if(part->isTau()) {
           decorator_pt_vis(*part)      = dressedVec.Pt();
           decorator_eta_vis(*part)     = dressedVec.Eta();
           decorator_phi_vis(*part)     = dressedVec.Phi();
           decorator_m_vis(*part)       = dressedVec.M();
         }
         else {
           decorator_e(*part)       = dressedVec.E();
           decorator_pt(*part)      = dressedVec.Pt();
           decorator_eta(*part)     = dressedVec.Eta();
           decorator_phi(*part)     = dressedVec.Phi();
         }
         decorator_nphoton(*part) = dressedParticlesNPhot[i];
       }
     } // end of the dR matching part
  
     //build the anti-kt jet list
     if (m_useAntiKt) {
       std::vector<fastjet::PseudoJet> sorted_jets;
       std::vector<fastjet::PseudoJet> fj_particles;
       for (const auto& part : listOfParticlesToDress) {
  
         if(part->isTau()) {
           if(!pt_visAcc.isAvailable(*part) || !eta_visAcc.isAvailable(*part)
              || !phi_visAcc.isAvailable(*part) || !mvisAcc.isAvailable(*part)) {
             ATH_MSG_ERROR("Visible momentum not available for truth taus, cannot perform dressing!");
             return StatusCode::FAILURE;
           }
  
           TLorentzVector tauvis;
           tauvis.SetPtEtaPhiM(pt_visAcc(*part),
                               eta_visAcc(*part),
                               phi_visAcc(*part),
                               mvisAcc(*part));
           fj_particles.emplace_back(tauvis.Px(), tauvis.Py(), tauvis.Pz(), tauvis.E());
         }
         else {
           fj_particles.emplace_back(part->px(), part->py(), part->pz(), part->e());
         }
  
         fj_particles.back().set_user_index(HepMC::uniqueID(part));
       }
       for (const auto& part : photonsFSRList) {
         fj_particles.emplace_back(part->px(), part->py(), part->pz(), part->e());
         fj_particles.back().set_user_index(HepMC::uniqueID(part));
       }
  
       //run the clustering
       fastjet::JetAlgorithm alg=fastjet::antikt_algorithm;
       const fastjet::JetDefinition jet_def(alg, m_coneSize);
       fastjet::ClusterSequence cseq(fj_particles, jet_def);
       sorted_jets = sorted_by_pt(cseq.inclusive_jets(0));
       //associate clustered jets back to bare particles
       std::vector<int> photon_uniqueIDs(50);
       photon_uniqueIDs.clear();
       for (const auto& part : listOfParticlesToDress) {
         //loop over fastjet pseudojets and associate one with this particle
         bool found=false;
         auto pjItr=sorted_jets.begin();
         while(!found && pjItr!=sorted_jets.end()) {
           std::vector<fastjet::PseudoJet> constituents = pjItr->constituents();
           for(const auto& constit : constituents) {
             if (HepMC::uniqueID(part)==constit.user_index()) {
  
               // shall we count the number of photons among the pseudojet constituents 
               // to decorate leptons with the number of dressing photons found by the anti-kt algorithm?
  
               if(part->isTau()) {
                 decorator_pt_vis(*part)      = pjItr->pt();
                 decorator_eta_vis(*part)     = pjItr->pseudorapidity();
                 decorator_phi_vis(*part)     = pjItr->phi_std(); //returns phi in [-pi,pi]
                 decorator_m_vis(*part)       = pjItr->m();
               }
               else {
                 decorator_e(*part)       = pjItr->e();
                 decorator_pt(*part)      = pjItr->pt();
                 decorator_eta(*part)     = pjItr->pseudorapidity();
                 decorator_phi(*part)     = pjItr->phi_std(); //returns phi in [-pi,pi]
               }
               found=true;
               break;
             } // Found the matching unique ID
           } // Loop over the jet constituents
           if (found){
             for(const auto& constit : constituents) {
               photon_uniqueIDs.push_back(constit.user_index());
             } // Loop over the constituents
           } // Found one of the key leptons in this jet
           ++pjItr;
         }
         if (!found) {
           if(part->isTau()) {
             decorator_pt_vis(*part)      = 0.;
             decorator_eta_vis(*part)     = 0.;
             decorator_phi_vis(*part)     = 0.;
             decorator_m_vis(*part)       = 0.;
           }
           else {
             decorator_e(*part)       = 0;
             decorator_pt(*part)      = 0;
             decorator_eta(*part)     = 0;
             decorator_phi(*part)     = 0;
           }
           ATH_MSG_WARNING("Bare particle not found in constituents ");
         }
       }
       // Check if we wanted to decorate photons used for dressing
       if (!m_decorationName.empty()){
         //loop over photons, uniquely associate each to nearest bare particle
         for (const auto& phot : photonsFSRList ) {
           bool found = std::find(photon_uniqueIDs.begin(), photon_uniqueIDs.end(), HepMC::uniqueID(phot)) != photon_uniqueIDs.end();
           if (found) {
             dressDec(*phot) = 1;
           }
         } // End of loop over photons
       } // End of decoration of photons used in dressing
     } // End of anti-kT dressing
  
     return StatusCode::SUCCESS;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	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 > &	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 > &	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 > &	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 > & 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

◆ initialize()

StatusCode DerivationFramework::TruthDressingTool::initialize ( )

Definition at line 42 of file TruthDressingTool.cxx.

 {
     // Initialise handle keys
     ATH_CHECK(m_particlesKey.initialize());
     ATH_CHECK(m_dressParticlesKey.initialize());
     m_decorator_eKey = m_dressParticlesKey.key() + ".e_dressed";
     ATH_CHECK(m_decorator_eKey.initialize());
     m_decorator_ptKey = m_dressParticlesKey.key() + ".pt_dressed";
     ATH_CHECK(m_decorator_ptKey.initialize());
     m_decorator_etaKey= m_dressParticlesKey.key() + ".eta_dressed";
     ATH_CHECK(m_decorator_etaKey.initialize());
     m_decorator_phiKey= m_dressParticlesKey.key() + ".phi_dressed";
     ATH_CHECK(m_decorator_phiKey.initialize());
     m_decorator_pt_visKey = m_dressParticlesKey.key() + ".pt_vis_dressed";
     ATH_CHECK(m_decorator_pt_visKey.initialize());
     m_decorator_eta_visKey= m_dressParticlesKey.key() + ".eta_vis_dressed";
     ATH_CHECK(m_decorator_eta_visKey.initialize());
     m_decorator_phi_visKey= m_dressParticlesKey.key() + ".phi_vis_dressed";
     ATH_CHECK(m_decorator_phi_visKey.initialize());
     m_decorator_m_visKey= m_dressParticlesKey.key() + ".m_vis_dressed";
     ATH_CHECK(m_decorator_m_visKey.initialize());
     m_decorator_nphotonKey = m_dressParticlesKey.key() + ".nPhotons_dressed";
     ATH_CHECK(m_decorator_nphotonKey.initialize());
     if (!m_decorationName.empty()) {m_decorationKey = m_particlesKey.key()+"."+m_decorationName;}
     else {m_decorationKey = m_particlesKey.key()+".unusedPhotonDecoration";} 
     ATH_CHECK(m_decorationKey.initialize());
     m_truthClassKey = m_dressParticlesKey.key() + "." + SG::AuxTypeRegistry::instance().getName(acc_origin.auxid());
     ATH_CHECK(m_truthClassKey.initialize());
     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.

◆ interfaceID()

static const InterfaceID& DerivationFramework::IAugmentationTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 31 of file IAugmentationTool.h.

31 { return IID_IAugmentationTool; }

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

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

Member Data Documentation

◆ m_coneSize

Gaudi::Property<float> DerivationFramework::TruthDressingTool::m_coneSize {this, "dressingConeSize", 0.1, "Size of dR cone in which to include FSR photons in dressing"}

private

Parameter: Cone size for dressing.

Definition at line 67 of file TruthDressingTool.h.

◆ m_decorationKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorationKey {this, "DressingKey", "TruthParticles.dressedPhoton", "Dressed photon decoration"}

private

Definition at line 57 of file TruthDressingTool.h.

◆ m_decorationName

Gaudi::Property<std::string> DerivationFramework::TruthDressingTool::m_decorationName {this, "decorationName", "", "Name of the decoration for photons that were used in dressing"}

private

Parameter: Name of the decoration to apply.

Definition at line 76 of file TruthDressingTool.h.

◆ m_decorator_eKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_eKey {this, "e_dressed", "TruthParticles.e_dressed", "e_dressed decoration"}

private

WriteDecorHandleKeys for decorations.

Definition at line 39 of file TruthDressingTool.h.

◆ m_decorator_eta_visKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_eta_visKey {this, "eta_vis_dressed", "TruthParticles.eta_vis_dressed", "eta_vis_dressed decoration"}

private

Definition at line 49 of file TruthDressingTool.h.

◆ m_decorator_etaKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_etaKey {this, "eta_dressed", "TruthParticles.eta_dressed", "eta_dressed decoration"}

private

Definition at line 43 of file TruthDressingTool.h.

◆ m_decorator_m_visKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_m_visKey {this, "m_vis_dressed", "TruthParticles.m_vis_dressed", "m_vis_dressed decoration"}

private

Definition at line 53 of file TruthDressingTool.h.

◆ m_decorator_nphotonKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_nphotonKey {this, "nPhotons_dressed", "TruthParticles.nPhotons_dressed", "nPhotons_dressed decoration"}

private

Definition at line 55 of file TruthDressingTool.h.

◆ m_decorator_phi_visKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_phi_visKey {this, "phi_vis_dressed", "TruthParticles.phi_vis_dressed", "phi_vis_dressed decoration"}

private

Definition at line 51 of file TruthDressingTool.h.

◆ m_decorator_phiKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_phiKey {this, "phi_dressed", "TruthParticles.phi_dressed", "phi_dressed decoration"}

private

Definition at line 45 of file TruthDressingTool.h.

◆ m_decorator_pt_visKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_pt_visKey {this, "pt_vis_dressed", "TruthParticles.pt_vis_dressed", "pt_vis_dressed decoration"}

private

Definition at line 47 of file TruthDressingTool.h.

◆ m_decorator_ptKey

SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_decorator_ptKey {this, "pt_dressed", "TruthParticles.pt_dressed", "pt_dressed decoration"}

private

Definition at line 41 of file TruthDressingTool.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_dressParticlesKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_dressParticlesKey {this, "dressParticlesKey", "TruthParticles", "ReadHandleKey for input particles to be dressed. If taus are selected, everything in this input key will be used"}

private

ReadHandleKey for particles to be dressed.

Definition at line 34 of file TruthDressingTool.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_listOfPIDs

Gaudi::Property< std::vector<int> > DerivationFramework::TruthDressingTool::m_listOfPIDs {this, "particleIDsToDress", {11,13}, "List of the pdgID's of particles to be dressed (usually 11,13). Special treatment for taus (15)"}

private

Parameter: List of pdgIDs of particles to dress.

Definition at line 70 of file TruthDressingTool.h.

◆ m_particlesKey

SG::ReadHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_particlesKey {this, "particlesKey", "TruthParticles", "ReadHandleKey for TruthParticles for photon list input"}

private

ReadHandleKey input collection key.

Definition at line 31 of file TruthDressingTool.h.

◆ m_truthClassKey

SG::ReadDecorHandleKey<xAOD::TruthParticleContainer> DerivationFramework::TruthDressingTool::m_truthClassKey {this, "truthClassifierKey", "", "Will be over written during initialize"}

private

Ensure that the algorithm is scheduled after the truth classifier.

Definition at line 37 of file TruthDressingTool.h.

◆ m_useAntiKt

Gaudi::Property<bool> DerivationFramework::TruthDressingTool::m_useAntiKt {this, "useAntiKt", false, "use anti-k_T instead of fixed-cone dressing"}

private

Parameter: Use antikT algorithm for dressing?

Definition at line 73 of file TruthDressingTool.h.

◆ m_useLeptonsFromHadrons

Gaudi::Property<bool> DerivationFramework::TruthDressingTool::m_useLeptonsFromHadrons {this, "useLeptonsFromHadrons", false, "Consider leptons coming from hadron decays?"}

private

Parameter: Use leptons from hadron decays?

Definition at line 64 of file TruthDressingTool.h.

◆ m_usePhotonsFromHadrons

Gaudi::Property<bool> DerivationFramework::TruthDressingTool::m_usePhotonsFromHadrons {this, "usePhotonsFromHadrons", false, "Add photons coming from hadron decays while dressing"}

private

Parameter: Use photons from hadron decays?

Definition at line 61 of file TruthDressingTool.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

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TruthDressingTool()

◆ ~TruthDressingTool()

Member Function Documentation

◆ addBranches()

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

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_coneSize

◆ m_decorationKey

◆ m_decorationName

◆ m_decorator_eKey

◆ m_decorator_eta_visKey

◆ m_decorator_etaKey

◆ m_decorator_m_visKey

◆ m_decorator_nphotonKey

◆ m_decorator_phi_visKey

◆ m_decorator_phiKey

◆ m_decorator_pt_visKey

◆ m_decorator_ptKey

◆ m_detStore

◆ m_dressParticlesKey

◆ m_evtStore

◆ m_listOfPIDs

◆ m_particlesKey

◆ m_truthClassKey

◆ m_useAntiKt

◆ m_useLeptonsFromHadrons

◆ m_usePhotonsFromHadrons

◆ m_varHandleArraysDeclared

◆ m_vhka