MsTrackSeederTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
#ifndef MUONTRACKFINDINGTOOLS_MSTRACKSEEDERTOOL_H
#define MUONTRACKFINDINGTOOLS_MSTRACKSEEDERTOOL_H
 
#include "AthenaBaseComps/AthAlgTool.h"
 
#include "GaudiKernel/SystemOfUnits.h"
#include "Acts/Utilities/KDTree.hpp"
 
 
#include "xAODMuon/MuonSegmentContainer.h"
#include "MuonTrackEvent/MsTrackSeed.h"
#include "MuonReadoutGeometryR4/MuonDetectorManager.h"
#include "MuonRecToolInterfacesR4/ISegmentSelectionTool.h"
#include "MuonRecToolInterfacesR4/ITrackSeedingDiagnosticsTool.h"
#include "ActsGeometryInterfaces/ITrackingGeometryTool.h"
#include "ActsGeometryInterfaces/IExtrapolationTool.h"
#include "MagFieldConditions/AtlasFieldCacheCondObj.h"
 
#include <span>
 
namespace MuonR4{
    class MsTrackSeederTool: public extends<AthAlgTool, ITrackSeedingDiagnosticsTool> {
        public:

            using SearchTree_t = Acts::KDTree<3, const xAOD::MuonSegment*, double, std::array, 6>;
            using Location = MsTrackSeed::Location;
            using SectorProjector = ExpandedSector::SectorProjector;
            enum class SeedCoords : std::uint8_t{
                eDetSection,
                eSector,
                ePosOnCylinder
            };

            using TreeRawVec_t = SearchTree_t::vector_t;

            using base_class::base_class;
            virtual StatusCode initialize() override final;

            virtual StatusCode findTrackSeeds(const EventContext& ctx,
                                              std::vector<MsTrackSeed>& outSeeds) const override final;

            virtual Acts::Result<Acts::BoundTrackParameters> 
                estimateStartParameters(const EventContext& ctx,
                                        const MsTrackSeed& seed) const override final;

            virtual double estimateQtimesP(const EventContext& ctx,
                                           const Amg::Vector3D& planeNorm,
                                           std::span<const PosMomPair_t> circlePoints) const override final;

            virtual bool withinBounds(const Amg::Vector2D& projPos,
                                      const Location loc) const override final;
            virtual Amg::Vector2D expressOnCylinder(const Acts::GeometryContext& tgContext,
                                                    const xAOD::MuonSegment& segment,
                                                    const Location loc,
                                                    const ExpandedSector sector) const override final;

            virtual double estimateQtimesP(const Acts::GeometryContext& tgContext,
                                           const MsTrackSeed& seed,
                                           MagField::AtlasFieldCache& fieldCache) const override final;
 
        private:
            
             Amg::Vector3D segPosOntoPhiPlane(const Acts::GeometryContext& tgContext,
                                              const Amg::Vector3D& planeNormal,
                                              const xAOD::MuonSegment& segment) const;

            SearchTree_t constructTree(const Acts::GeometryContext& tgContext,
                                       const xAOD::MuonSegmentContainer& segments) const;

            double estimateQtimesP(const Amg::Vector3D& planeNorm,
                                   const PosMomPair_t& p1, 
                                   const PosMomPair_t& p2,
                                   const PosMomPair_t& p3,
                                   MagField::AtlasFieldCache& fieldCache) const;
            double estimateQtimesP(const Amg::Vector3D& planeNorm,
                                   const PosMomPair_t& p1, 
                                   const PosMomPair_t& p2,
                                   MagField::AtlasFieldCache& fieldCache) const;
            double getPtimesQ(const Amg::Vector3D& forceIntegral, 
                              const Amg::Vector3D& deltaDir) const;
            Amg::Vector3D forceIntegration(const PosMomPair_t& point1,
                                           const PosMomPair_t& point2,
                                           const Amg::Vector3D& planeNorm,
                                           MagField::AtlasFieldCache& fieldCache) const;
            void appendSegment(const Acts::GeometryContext& tgContext,
                               const xAOD::MuonSegment* segment,
                               const Location loc,
                               TreeRawVec_t& outContainer) const;
            const MuonGMR4::SpectrometerSector* envelope(const xAOD::MuonSegment& segment) const;
            MsTrackSeedContainer resolveOverlaps(MsTrackSeedContainer&& unresolved) const;
            
            std::vector<double> m_fieldExtpSteps{};
            Gaudi::Property<double> m_barrelRadius{this, "BarrelRadius", 7.*Gaudi::Units::m};
            Gaudi::Property<double> m_barrelLength{this, "BarrelLength", 25.*Gaudi::Units::m};
            Gaudi::Property<double> m_endcapDiscZ{this, "EndcapDiscZ", 15.*Gaudi::Units::m};
            Gaudi::Property<double> m_endcapDiscRadius{this, "EndcapRadius", 13.*Gaudi::Units::m};
            Gaudi::Property<double> m_seedHalfLength{this, "SeedHalfLength", 25.*Gaudi::Units::cm};
            Gaudi::Property<unsigned> m_nFieldSteps{this, "nFieldSteps", 10};
            ToolHandle<ISegmentSelectionTool> m_segSelector{this, "SegmentSelectionTool" , "" };
            PublicToolHandle<ActsTrk::ITrackingGeometryTool> m_trackingGeometryTool{this, "TrackingGeometryTool", ""};
            ToolHandle<ActsTrk::IExtrapolationTool> m_extrapolationTool{this, "ExtrapolationTool" ,"" };
            SG::ReadHandleKey<xAOD::MuonSegmentContainer> m_segmentKey{this, "SegmentContainer", "MuonSegmentsFromR4" };
            const MuonGMR4::MuonDetectorManager* m_detMgr{nullptr};
    };
}
 
 
#endif