MuonTruthAlgs/src/TruthHitSummaryAlg.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
 
  ** @brief This alg receives the container of truth muons and decorates them 
  *         with hit counts and coincidences in different positions of the detector,
  *         as well as hits'ID classified by chamber technology.
*/
 
#ifndef MUONTRUTHALGS_TruthHitSummaryAlg_H
#define MUONTRUTHALGS_TruthHitSummaryAlg_H
 
 
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "MuonIdHelpers/IMuonIdHelperSvc.h"
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/WriteDecorHandleKey.h"
#include "TrkTruthData/PRD_MultiTruthCollection.h"
#include "xAODTruth/TruthParticleContainer.h"
 
#include "StoreGate/WriteDecorHandle.h"
 
#include "MuonTruthAlgs/DecorUtils.h"
 
#include <map>
 
namespace Muon {
 
    class TruthHitSummaryAlg : public AthReentrantAlgorithm {
    public:
 
        // Constructor with parameters:
        using AthReentrantAlgorithm::AthReentrantAlgorithm;
 
        // Basic algorithm methods:
        virtual StatusCode initialize() override;
        virtual StatusCode execute(const EventContext& ctx) const override;

        using ChamberIdMap = std::map<Muon::MuonStationIndex::ChIndex, std::vector<Identifier>>;
 
    private:
        using WriteDecor_uint8_t = std::unique_ptr<SG::WriteDecorHandle<xAOD::TruthParticleContainer, uint8_t>>;
        using llvec = std::vector<unsigned long long>;
        using WriteDecor_llvec =  std::unique_ptr<SG::WriteDecorHandle<xAOD::TruthParticleContainer, llvec>>;
        friend struct summaryDecors;
        struct summaryDecors{
            
            explicit summaryDecors(const TruthHitSummaryAlg* parent,
                          const EventContext& ctx) :
                m_parent{parent},
                m_ctx{ctx} {}
            
            const TruthHitSummaryAlg* m_parent{};
            const EventContext& m_ctx;
 
            WriteDecor_uint8_t nprecLayersDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_nprecLayersKey)};
            WriteDecor_uint8_t nphiLayersDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_nphiLayersKey)};
            WriteDecor_uint8_t ntrigEtaLayersDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_ntrigEtaLayersKey)};
            WriteDecor_uint8_t innerSmallHitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_innerSmallHitsKey)};
            WriteDecor_uint8_t innerLargeHitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_innerLargeHitsKey)};
            WriteDecor_uint8_t middleSmallHitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_middleSmallHitsKey)};
            WriteDecor_uint8_t middleLargeHitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_middleLargeHitsKey)};
            WriteDecor_uint8_t outerSmallHitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_outerSmallHitsKey)};
            WriteDecor_uint8_t outerLargeHitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_outerLargeHitsKey)};
            WriteDecor_uint8_t extendedSmallHitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_extendedSmallHitsKey)};
            WriteDecor_uint8_t extendedLargeHitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_extendedLargeHitsKey)};
            WriteDecor_uint8_t phiLayer1HitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_phiLayer1HitsKey)};
            WriteDecor_uint8_t phiLayer2HitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_phiLayer2HitsKey)};
            WriteDecor_uint8_t phiLayer3HitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_phiLayer3HitsKey)};
            WriteDecor_uint8_t phiLayer4HitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_phiLayer4HitsKey)};
            WriteDecor_uint8_t etaLayer1HitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_etaLayer1HitsKey)};
            WriteDecor_uint8_t etaLayer2HitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_etaLayer2HitsKey)};
            WriteDecor_uint8_t etaLayer3HitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_etaLayer3HitsKey)};
            WriteDecor_uint8_t etaLayer4HitsDecor{makeHandle<uint8_t>(m_ctx, m_parent->m_etaLayer4HitsKey)};
 
            WriteDecor_llvec truthMdtHitsDecor{makeHandle<llvec>(m_ctx, m_parent->m_truthMdtHitsKey)};
            WriteDecor_llvec truthTgcHitsDecor{makeHandle<llvec>(m_ctx, m_parent->m_truthTgcHitsKey)};
            WriteDecor_llvec truthRpcHitsDecor{makeHandle<llvec>(m_ctx, m_parent->m_truthRpcHitsKey)};
            WriteDecor_llvec truthCscHitsDecor{makeHandle<llvec>(m_ctx, m_parent->m_truthCscHitsKey)};
            WriteDecor_llvec truthStgcHitsDecor{makeHandle<llvec>(m_ctx,m_parent->m_truthStgcHitsKey)};
            WriteDecor_llvec truthMMHitsDecor{makeHandle<llvec>(m_ctx,m_parent->m_truthMMHitsKey)};
 
        };

        StatusCode addHitCounts(const EventContext& ctx,
                                const xAOD::TruthParticle& truthParticle,
                                ChamberIdMap& ids,
                                summaryDecors& myDecors) const;

        StatusCode addHitIDVectors(const xAOD::TruthParticle& truthParticle, 
                            const ChamberIdMap& ids,
                            summaryDecors& myDecors) const;
        
        SG::ReadHandleKey<xAOD::TruthParticleContainer> m_muonTruth{this, "muonTruth", "MuonTruthParticles"};

        SG::ReadHandleKeyArray<PRD_MultiTruthCollection> m_PRD_TruthNames{
            this, "PRD_TruthMaps", {"CSC_TruthMap", "RPC_TruthMap", "TGC_TruthMap", "MDT_TruthMap"}, "remove NSW by default for now, can always be changed in the configuration"};

        using WriteDecorKey_t = SG::WriteDecorHandleKey<xAOD::TruthParticleContainer>;
        WriteDecorKey_t m_nprecLayersKey{this, "nprecLayersKey", m_muonTruth, "nprecLayers", ""};
        WriteDecorKey_t m_nphiLayersKey{this, "nphiLayersKey", m_muonTruth, "nphiLayers", ""};
        WriteDecorKey_t m_ntrigEtaLayersKey{this, "ntrigEtaLayersKey", m_muonTruth, "ntrigEtaLayers", ""};
        WriteDecorKey_t m_innerSmallHitsKey{this, "innerSmallHitsKey", m_muonTruth, "innerSmallHits", ""};
        WriteDecorKey_t m_innerLargeHitsKey{this, "innerLargeHitsKey", m_muonTruth, "innerLargeHits", ""};
        WriteDecorKey_t m_middleSmallHitsKey{this, "middleSmallHitsKey", m_muonTruth, "middleSmallHits", ""};
        WriteDecorKey_t m_middleLargeHitsKey{this, "middleLargeHitsKey", m_muonTruth, "middleLargeHits", ""};
        WriteDecorKey_t m_outerSmallHitsKey{this, "outerSmallHitsKey", m_muonTruth, "outerSmallHits", ""};
        WriteDecorKey_t m_outerLargeHitsKey{this, "outerLargeHitsKey", m_muonTruth, "outerLargeHits", ""};
        WriteDecorKey_t m_extendedSmallHitsKey{this, "extendedSmallHitsKey", m_muonTruth, "extendedSmallHits", ""};
        WriteDecorKey_t m_extendedLargeHitsKey{this, "extendedLargeHitsKey", m_muonTruth, "extendedLargeHits", ""};
        WriteDecorKey_t m_phiLayer1HitsKey{this, "phiLayer1HitsKey", m_muonTruth, "phiLayer1Hits", ""};
        WriteDecorKey_t m_phiLayer2HitsKey{this, "phiLayer2HitsKey", m_muonTruth, "phiLayer2Hits", ""};
        WriteDecorKey_t m_phiLayer3HitsKey{this, "phiLayer3HitsKey", m_muonTruth, "phiLayer3Hits", ""};
        WriteDecorKey_t m_phiLayer4HitsKey{this, "phiLayer4HitsKey", m_muonTruth, "phiLayer4Hits", ""};
        WriteDecorKey_t m_etaLayer1HitsKey{this, "etaLayer1HitsKey", m_muonTruth, "etaLayer1Hits", ""};
        WriteDecorKey_t m_etaLayer2HitsKey{this, "etaLayer2HitsKey", m_muonTruth, "etaLayer2Hits", ""};
        WriteDecorKey_t m_etaLayer3HitsKey{this, "etaLayer3HitsKey", m_muonTruth, "etaLayer3Hits", ""};
        WriteDecorKey_t m_etaLayer4HitsKey{this, "etaLayer4HitsKey", m_muonTruth, "etaLayer4Hits", ""};
 
        WriteDecorKey_t m_truthMdtHitsKey{this, "truthMdtHitsKey", m_muonTruth, "truthMdtHits", ""};
        WriteDecorKey_t m_truthTgcHitsKey{this, "truthTgcHitsKey", m_muonTruth, "truthTgcHits", ""};
        WriteDecorKey_t m_truthRpcHitsKey{this, "truthRpcHitsKey", m_muonTruth, "truthRpcHits", ""};
        WriteDecorKey_t m_truthCscHitsKey{this, "truthCscHitskey", m_muonTruth, "truthCscHits", ""};
        WriteDecorKey_t m_truthStgcHitsKey{this, "truthStgcHitsKey", m_muonTruth, "truthStgcHits", ""};
        WriteDecorKey_t m_truthMMHitsKey{this, "truthMMHitsKey", m_muonTruth, "truthMMHits", ""};

        ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc{this, "MuonIdHelperSvc", "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
 
    };
 
}  // namespace Muon
 
#endif