TruthTrackRecordsAlg.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 track records (snapshot) of the same in different positions
  *        within the detector. Decorations (for each detector position)
  *        include: muon records in that layer; a flag saying if a record has
  *        been recorded in that layer; muon extrapolation from the 
  *        previous layer; extrapolation's covariance matrix; and a flag 
  *        representing the exrapolation outcome.
*/
#ifndef MUONTRUTHALGS_TruthTrackRecordsAlg_H
#define MUONTRUTHALGS_TruthTrackRecordsAlg_H
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
 
#include "StoreGate/ReadHandleKey.h"
#include "StoreGate/WriteDecorHandleKey.h"
#include "StoreGate/WriteDecorHandleKeyArray.h"
#include "TrkExInterfaces/IExtrapolator.h"
#include "xAODTruth/TruthParticleContainer.h"
#include "TrackRecord/TrackRecordCollection.h"
#include "xAODMuonViews/ContainerDecorator.h"
 
namespace Muon {
 
    class TruthTrackRecordsAlg : public AthReentrantAlgorithm {
    public:
 
        // Constructor with parameters:
        using AthReentrantAlgorithm::AthReentrantAlgorithm;
 
        // Basic algorithm methods:
        virtual StatusCode initialize() override;
        virtual StatusCode execute(const EventContext& ctx) const override;
 
    private:
        template <typename dType> using  DecorHandlePtrVec_t = std::vector<xAOD::ContainerDecorator<xAOD::TruthParticleContainer, dType>>;
        using WriteDecorArray_f = DecorHandlePtrVec_t<float>;
        using WriteDecorArray_b = DecorHandlePtrVec_t<char>;
        using WriteDecorArray_fvec = DecorHandlePtrVec_t<std::vector<float>>;
        
        struct SummaryDecors{
            WriteDecorArray_f xDecor{};
            WriteDecorArray_f yDecor{};
            WriteDecorArray_f zDecor{};
            WriteDecorArray_f pxDecor {};
            WriteDecorArray_f pyDecor {};
            WriteDecorArray_f pzDecor {};
            WriteDecorArray_b matchedDecor {};
            WriteDecorArray_f exDecor {};
            WriteDecorArray_f eyDecor {};
            WriteDecorArray_f ezDecor {};
            WriteDecorArray_f epxDecor {};
            WriteDecorArray_f epyDecor {};
            WriteDecorArray_f epzDecor {};
            WriteDecorArray_fvec ecovDecor {};
            WriteDecorArray_b eisDecor {};
        };

        StatusCode addTrackRecords(const EventContext& ctx, 
                                   const xAOD::TruthParticle& truthParticle,
                                   SummaryDecors& myDecors) const;
        
        template <typename T> 
        StatusCode fillWriteDecorator(SG::WriteDecorHandleKeyArray<xAOD::TruthParticleContainer, T>& writeKey, const std::string& keyName) const;

        SG::ReadHandleKey<xAOD::TruthParticleContainer> m_muonTruth{this, "muonTruth", "MuonTruthParticles"};

        SG::ReadHandleKeyArray<TrackRecordCollection> m_trackRecords{
            this, "TrackRecordCollectionNames", {"CaloEntryLayer", "MuonEntryLayer", "MuonExitLayer"}};
        
        using DecorKey_t = SG::WriteDecorHandleKeyArray<xAOD::TruthParticleContainer>;
        DecorKey_t m_muonSnapShotX{this, "SnapShotX", { }, "Position decoration..."};
        DecorKey_t m_muonSnapShotY{this, "SnapShotY", { }, "Position decoration..."};
        DecorKey_t m_muonSnapShotZ{this, "SnapShotZ", { }, "Position decoration..."};
        DecorKey_t m_muonSnapShotPx{this, "SnapShotPx", { }, "Momentum decoration..."};
        DecorKey_t m_muonSnapShotPy{this, "SnapShotPy", { }, "Momentum decoration..."};
        DecorKey_t m_muonSnapShotPz{this, "SnapShotPz", { }, "Momentum decoration..."};
        DecorKey_t m_muonSnapShotMtc{this, "SnapShotMtc", { }, "is matched decoration..."};
        DecorKey_t m_muonSnapShotEX{this, "SnapShotEX", { }, "Position decoration..."};
        DecorKey_t m_muonSnapShotEY{this, "SnapShotEY", { }, "Position decoration..."};
        DecorKey_t m_muonSnapShotEZ{this, "SnapShotEZ", { }, "Position decoration..."};
        DecorKey_t m_muonSnapShotEPx{this, "SnapShotEPx", { }, "Momentum decoration..."};
        DecorKey_t m_muonSnapShotEPy{this, "SnapShotEPy", { }, "Momentum decoration..."};
        DecorKey_t m_muonSnapShotEPz{this, "SnapShotEPz", { }, "Momentum decoration..."};
        DecorKey_t m_muonSnapShotEcov{this, "SnapShotEcov", { }, "Covariance decoration"};
        DecorKey_t m_muonSnapShotEis{this, "SnapShotEis", { }, "Flag decoration whether the extrapolation worked"};

        ToolHandle<Trk::IExtrapolator> m_extrapolator{this, "Extrapolator", "Trk::Extrapolator/AtlasExtrapolator"};
 
    };
 
}  // namespace Muon
#endif