TruthDecayCollectionMaker.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef DERIVATIONFRAMEWORK_TRUTHDECAYCOLLECTIONMAKER_H
#define DERIVATIONFRAMEWORK_TRUTHDECAYCOLLECTIONMAKER_H
 
// Base classes
#include "AthenaBaseComps/AthAlgTool.h"
#include "DerivationFrameworkInterfaces/IAugmentationTool.h"
// EDM -- typedefs so these are includes
#include "xAODTruth/TruthParticleContainer.h"
#include "xAODTruth/TruthVertexContainer.h"
// Handles and keys
#include "StoreGate/WriteDecorHandleKey.h"
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/WriteHandleKey.h"
#include "StoreGate/WriteHandle.h"
// Standard library includes
#include <vector>
#include <string>
 
namespace DerivationFramework {
 
 
  class TruthDecayCollectionMaker : public AthAlgTool, public IAugmentationTool {
    public: 
      TruthDecayCollectionMaker(const std::string& t, const std::string& n, const IInterface* p);
      ~TruthDecayCollectionMaker();
      StatusCode initialize();
      virtual StatusCode addBranches() const;
 
    private:
      Gaudi::Property<std::vector<int> > m_pdgIdsToKeep 
         {this, "PDGIDsToKeep", {}, "PDG IDs of particles to build the collection from"}; 
      Gaudi::Property<bool> m_keepBHadrons 
         {this, "KeepBHadrons", false, "Keep b-hadrons (easier than by PDG ID)"};
      Gaudi::Property<bool> m_keepCHadrons 
         {this, "KeepCHadrons", false, "Keep c-hadrons (easier than by PDG ID)"};
      Gaudi::Property<bool> m_keepBSM 
         {this, "KeepBSM", false, "Keep BSM particles (easier than by PDG ID)"};
      Gaudi::Property<bool> m_rejectHadronChildren 
         {this, "RejectHadronChildren", false, "Drop hadron descendants"};
      SG::ReadHandleKey<xAOD::TruthParticleContainer> m_particlesKey
         {this, "ParticlesKey", "TruthParticles", "ReadHandleKey for input TruthParticleContainer"};
      SG::WriteHandleKey<xAOD::TruthParticleContainer> m_outputParticlesKey
         {this, "NewParticleKey", "", "WriteHandleKey for new TruthParticleContainer"};
      SG::WriteHandleKey<xAOD::TruthVertexContainer> m_outputVerticesKey
         {this, "NewVertexKey", "", "WriteHandleKey for new TruthVertexContainer"};
      SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> m_originDecoratorKey
         {this, "classifierParticleOrigin", "TruthParticles.classifierParticleOrigin","Name of the decoration which records the particle origin as determined by the MCTruthClassifier"};
      SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> m_typeDecoratorKey
         {this, "classifierParticleType", "TruthParticles.classifierParticleType","Name of the decoration which records the particle type as determined by the MCTruthClassifier"};
      SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> m_outcomeDecoratorKey
         {this, "classifierParticleOutCome", "TruthParticles.classifierParticleOutCome","Name of the decoration which records the particle outcome as determined by the MCTruthClassifier"};      
      SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> m_classificationDecoratorKey
         {this, "Classification", "TruthParticles.Classification","Name of the decoration which records the particle outcome as determined by the MCTruthClassifier"};
      SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> m_motherIDDecoratorKey
         {this, "motherID", "TruthParticles.motherID","Name of the decoration which records the ID of the particle's mother"};
      SG::WriteDecorHandleKey<xAOD::TruthParticleContainer> m_daughterIDDecoratorKey
         {this, "daughterID", "TruthParticles.daughterID","Name of the decoration which records the ID of the particle's daughter"};
 
      Gaudi::Property<std::string> m_collectionName 
         {this, "NewCollectionName", "", "New collection name stem"};
      Gaudi::Property<int> m_generations 
         {this, "Generations", -1, "Number of generations after the particle in question to keep (-1 for all)"}; 
 
      // Helper functions for building up the decay product collections
      int addTruthParticle( const EventContext& ctx,
                            const xAOD::TruthParticle& old_part, xAOD::TruthParticleContainer* part_cont,
                            xAOD::TruthVertexContainer* vert_cont, std::vector<int>& seen_particles,
                            const int generations=-1) const;
      int addTruthVertex( const EventContext&, 
                          const xAOD::TruthVertex& old_vert, xAOD::TruthParticleContainer* part_cont,
                          xAOD::TruthVertexContainer* vert_cont, std::vector<int>& seen_particles,
                          const int generations=-1) const;
      bool id_ok( const xAOD::TruthParticle& part ) const;
  }; 
}
 
#endif // DERIVATIONFRAMEWORK_TRUTHDECAYCOLLECTIONMAKER_H