MenuTruthThinning.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/

// MenuTruthThinning, (c) ATLAS Detector software
 
#ifndef DERIVATIONFRAMEWORK_MENUTRUTHTHINNINGTOOL_H
#define DERIVATIONFRAMEWORK_MENUTRUTHTHINNINGTOOL_H
 
#include <string>
#include <unordered_set>
#include <atomic>
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "DerivationFrameworkInterfaces/IThinningTool.h"
#include "DerivationFrameworkMCTruth/DecayGraphHelper.h"
#include "xAODTruth/TruthVertexContainer.h"
#include "xAODTruth/TruthParticleContainer.h"
#include "GaudiKernel/ToolHandle.h"
#include "StoreGate/ThinningHandleKey.h"
 
 
namespace DerivationFramework {
    
    class MenuTruthThinning : public extends<AthAlgTool, IThinningTool> {
    public:
        MenuTruthThinning(const std::string& t, const std::string& n, const IInterface* p);
        virtual ~MenuTruthThinning();
        virtual StatusCode initialize() override;
        virtual StatusCode finalize() override;
        virtual StatusCode doThinning() const override;
 
        bool isAccepted(const xAOD::TruthParticle*) const;
        bool matchHadronIncTau(const xAOD::TruthParticle* part) const;
        bool matchQuarkIncTau(const xAOD::TruthParticle* part) const;
        bool isOrphanIncTau(const xAOD::TruthParticle* part) const;
        bool matchGenParticle(const xAOD::TruthParticle* part,
                              std::vector<int> &targetIDs, std::vector<int> &intermediateIDs,
                              bool targetsAreRange) const;
        bool isLeptonFromTau(const xAOD::TruthParticle*) const;
        bool isFromTau(const xAOD::TruthParticle*,
                       std::unordered_set<int>& barcode_trace) const;
        static bool isttHFHadron(const xAOD::TruthParticle*) ;
        bool isFsrFromLepton(const xAOD::TruthParticle*) const;
        bool parentIsLongLived(const xAOD::TruthParticle*) const;
 
 
    private:
        // THE MENU
        
        StringProperty m_streamName
          { this, "StreamName", "", "Name of the stream being thinned" };
        SG::ThinningHandleKey<xAOD::TruthParticleContainer> m_particlesKey
          { this, "ParticlesKey", "TruthParticles", "TruthParticle container name" };
        SG::ThinningHandleKey<xAOD::TruthVertexContainer> m_verticesKey
          { this, "VerticesKey", "TruthVertices", "TruthVertex container name" };

        bool m_writePartons;
        
        bool m_writeHadrons;
        
        bool m_writeBHadrons;

        bool m_writeCHadrons;

        bool m_writeGeant;
        
        float m_geantPhotonPtThresh;
        
        bool m_writeTauHad;
        
        bool m_writeBSM;
        
        bool m_writeBosons;
        float m_photonPtCut;
        
        float m_partonPtThresh;
        
        bool m_writeEverything;
        
        bool m_writeBosonProducts;
        
        bool m_writeBSMProducts;
        
        bool m_writeTopAndDecays;
        
        bool m_writeAllLeptons;
        
        bool m_writeLeptonsNotFromHadrons;
        
        bool m_writeAllStable;
        
        bool m_writeNotPhysical;
        
        bool m_writettHFHadrons;
        
        int m_writeFirstN;
        
        bool m_preserveDescendants;
        bool m_preserveGeneratorDescendants;
        bool m_preserveAncestors;
        bool m_preserveImmediate; // parents, siblings, children only
        bool m_preserveHadVtx; // hadronization vertices for above

        std::vector<int> m_pdgIdsToKeep;

        std::vector<int> m_longLivedPdgIds;
 
        // counters
        mutable std::atomic<unsigned int> m_totpart;
        mutable std::atomic<unsigned int> m_removedpart;
        mutable std::atomic<int> m_eventCount{};
 
    }; 
}
 
#endif // DERIVATIONFRAMEWORK_MENUTRUTHTHINNING_H