TruthSegmentMaker.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef MUONTRUTHSEGMENTMAKER_TRUTHSEGMENTMAKER_H
#define MUONTRUTHSEGMENTMAKER_TRUTHSEGMENTMAKER_H
 
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "StoreGate/ReadHandleKeyArray.h"
#include "StoreGate/WriteHandleKey.h"
#include "StoreGate/WriteDecorHandleKey.h"
#include "StoreGate/WriteHandle.h"
#include "StoreGate/WriteDecorHandle.h"
 
 
#include "xAODMuonSimHit/MuonSimHitContainer.h"
#include "MuonReadoutGeometryR4/MuonDetectorManager.h"
#include "xAODMuon/MuonSegmentContainer.h"
#include "MuonIdHelpers/IMuonIdHelperSvc.h"
#include "MdtCalibData/MdtCalibDataContainer.h"
#include "MuonCondData/NswErrorCalibData.h"
 
#include "MuonPatternEvent/MuonHoughDefs.h"
 
namespace MuonR4{
  /*** @brief The TruthSegmentMaker collects hits inside the chamber stemming from the same HepMC::GenParticle. 
   *          The particle state at the first sim hit is propagated via a simple straight line onto the plane 
   *          z=0 in the sector frame. The parameters are then translated into the global frame and a xAOD::MuonSegment
   *          is created. The segment hit summary is written based on the sim hit type. If a gasGap has eta & phi measurements,
   *          the counters in the respective categories are each increased for the given sim hit. Finally, a vector of ElementLinks
   *          pointing to the sim hits is decorated to the segment. */
  class TruthSegmentMaker : public AthReentrantAlgorithm {
      public:
          using AthReentrantAlgorithm::AthReentrantAlgorithm;
 
          ~TruthSegmentMaker() = default;
 
          StatusCode initialize() override final;
          StatusCode execute(const EventContext& ctx) const override;
      
      private:
          Amg::Transform3D toChamber(const ActsTrk::GeometryContext& gctx,
                                     const Identifier& chanId) const;
          
          using HitPosTuple_t = std::tuple<const xAOD::MuonSimHit*, Amg::Vector3D, Amg::Vector3D>;
          using SimHitVec_t = std::vector<HitPosTuple_t>;
 
 
 
          using EleLink_t = ElementLink<xAOD::MuonSimHitContainer>;
          using HitLinkVec_t = std::vector<EleLink_t>;
          using LinkDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, HitLinkVec_t>;
          using FloatDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, float>;
 
          using SegPars_t = xAOD::MeasVector<Acts::toUnderlying(SegmentFit::ParamDefs::nPars)>;
          using SegParDecor_t = SG::WriteDecorHandle<xAOD::MuonSegmentContainer, SegPars_t>;
        
          struct WriteDecorHolder{
              WriteDecorHolder(xAOD::MuonSegmentContainer& outContainer,
                                const TruthSegmentMaker& parent,
                               const EventContext& ctx):
                  segments{outContainer},
                  paramDecor{parent.m_locParKey, ctx},
                  hitLinkDecor{parent.m_eleLinkKey, ctx},
                  chargeDecor{parent.m_qKey, ctx},
                  ptDecor{parent.m_ptKey, ctx} {}

              xAOD::MuonSegmentContainer& segments;
              SegParDecor_t paramDecor;
              LinkDecor_t hitLinkDecor;
              FloatDecor_t chargeDecor;
              FloatDecor_t ptDecor;
          };

          xAOD::MuonSegment* constructSegmentFromHits(const EventContext& ctx,
                                                      const Amg::Transform3D& locToGlob,
                                                      const SimHitVec_t& hits,
                                                      WriteDecorHolder& writeShip) const;
          void buildSegmentsFromBkg(const EventContext& ctx,
                                    const Amg::Transform3D& locToGlob,
                                    const SimHitVec_t& simHits,
                                    WriteDecorHolder& writeShip) const;

          float muonPt(const xAOD::MuonSimHit& hit, const Amg::Vector3D& globDir) const;
          float hitUncertainty(const EventContext& ctx, const xAOD::MuonSimHit& hit) const;
          ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc{this, "IdHelperSvc",  "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
          SG::ReadHandleKeyArray<xAOD::MuonSimHitContainer> m_readKeys{this, "SimHitKeys", {}};
          SG::ReadHandleKey<ActsTrk::GeometryContext> m_geoCtxKey{this, "AlignmentKey", "ActsAlignment", "cond handle key"};
          SG::WriteHandleKey<xAOD::MuonSegmentContainer> m_segmentKey{this, "WriteKey", "MuonTruthSegments"};
          SG::WriteDecorHandleKey<xAOD::MuonSegmentContainer> m_eleLinkKey{this, "SimHitLink", m_segmentKey, "simHitLinks"};
          SG::WriteDecorHandleKey<xAOD::MuonSegmentContainer> m_ptKey{this, "PtKey", m_segmentKey, "pt"};
          SG::WriteDecorHandleKey<xAOD::MuonSegmentContainer> m_locParKey{this, "LocParKey", m_segmentKey,"localSegPars"};
          SG::WriteDecorHandleKey<xAOD::MuonSegmentContainer> m_qKey{this, "qKey", m_segmentKey, "charge"};
          Gaudi::Property<bool> m_useOnlyMuonHits{this, "useOnlyMuonHits", true};
          Gaudi::Property<bool> m_includePileUpHits{this, "includePileUpHits", true};
          Gaudi::Property<float> m_pileUpHitMinE{this, "energyThresholdPileUp", 1.*Gaudi::Units::GeV};
          Gaudi::Property<float> m_pileUpHitELoss{this, "pileUpHitELoss", 5.*Gaudi::Units::MeV};
          Gaudi::Property<float> m_pileUpHitAngleCone{this, "pileUpHitAngleCone", 1.*Gaudi::Units::deg};
          Gaudi::Property<float> m_pileUpHitDistance{this, "pileUpHitDistance", 2.*Gaudi::Units::m};
          Gaudi::Property<float> m_idCylinderR{this, "IdCylinderR", 1.1*Gaudi::Units::m};
          Gaudi::Property<float> m_idCylinderHalfZ{this, "IdCylinderHalfZ", 3.2*Gaudi::Units::m};
          const MuonGMR4::MuonDetectorManager* m_detMgr{nullptr};
          SG::ReadCondHandleKey<MuonCalib::MdtCalibDataContainer> m_mdtCalibKey{this, "MdtCalibKey", "MdtCalibConstants",
                                                                                "Conditions object containing the calibrations"};

          SG::ReadCondHandleKey<NswErrorCalibData> m_nswUncertKey{this, "NswErrorKey", "NswUncertData", 
                                                                  "Key of the parametrized NSW uncertainties"};
    };
}
#endif