MsTrackFindingAlg.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
#ifndef MUONTRACKFINIDNGALGS_MSTRACKFINIDNGALG_H
#define MUONTRACKFINIDNGALGS_MSTRACKFINIDNGALG_H
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
 
 
#include "StoreGate/ReadCondHandleKey.h"
#include "StoreGate/ReadHandleKeyArray.h"
#include "StoreGate/WriteHandleKey.h"
 
#include "MuonReadoutGeometryR4/MuonDetectorManager.h"
#include "xAODTracking/TrackParticleContainer.h"
#include "MuonPatternEvent/MuonPatternContainer.h"
 
#include "xAODMuon/MuonSegmentContainer.h"
#include "MuonTrackEvent/MsTrackSeed.h"
 
#include "ActsEvent/TrackContainer.h"
#include "ActsGeometryInterfaces/IExtrapolationTool.h"
#include "ActsGeometryInterfaces/ITrackingGeometryTool.h"
#include "ActsToolInterfaces/IFitterTool.h"
 
#include "MuonIdHelpers/IMuonIdHelperSvc.h"
#include "MuonRecToolInterfacesR4/ISegmentSelectionTool.h"
#include "MuonRecToolInterfacesR4/ISpacePointCalibrator.h"
#include "MuonRecToolInterfacesR4/ITrackVisualizationTool.h"
 
 
#include "ActsEvent/TrackContainerHandlesHelper.h"
#include "MuonTrackFindingTools/MsTrackSeeder.h"
#include "MuonTrackFindingTools/MlMsTrackSeeder.h"
#include "GaudiKernel/SystemOfUnits.h"
 
 
namespace MuonR4{
    class MsTrackFindingAlg : public AthReentrantAlgorithm {
        public:
            using AthReentrantAlgorithm::AthReentrantAlgorithm;
        
            virtual ~MsTrackFindingAlg();
            virtual StatusCode initialize() override final;
            virtual StatusCode execute(const EventContext& ctx) const override final;
 
            using OptBoundPars_t = Acts::Result<Acts::BoundTrackParameters>;
            using MeasVec_t = std::vector<const xAOD::UncalibratedMeasurement*>;
        private:
            std::unique_ptr<MsTrackSeedContainer> findTrackSeeds(const EventContext& ctx,
                                                                 const xAOD::MuonSegmentContainer& segments) const;

            bool fitSeedCandidate(const Acts::GeometryContext& gCtx,
                                  const Acts::MagneticFieldContext& mCtx,
                                  const Acts::CalibrationContext& cCtx,
                                  const MsTrackSeed& seed,
                                  ActsTrk::MutableTrackContainer& outContainer) const;

            std::pair<OptBoundPars_t, MeasVec_t> prepareFit(const Acts::GeometryContext& tgContext,
                                                            const Acts::MagneticFieldContext& mfContext,
                                                            const Acts::CalibrationContext& calContext,
                                                            const MsTrackSeed& seed) const;
 
            const MsTrackSeeder& baselineSeeder() const;
            
            SG::ReadHandleKey<xAOD::MuonSegmentContainer> m_segmentKey{this, "SegmentContainer", "MuonSegmentsFromR4" };
            ServiceHandle<Muon::IMuonIdHelperSvc> m_idHelperSvc{this, "IdHelperSvc",  "Muon::MuonIdHelperSvc/MuonIdHelperSvc"};
            const MuonGMR4::MuonDetectorManager* m_detMgr{nullptr};
            SG::WriteHandleKey<MsTrackSeedContainer> m_msTrkSeedKey{this, "MsTrkSeedKey", "MsTrackSeeds"};
            ToolHandle<ISegmentSelectionTool> m_segSelector{this, "SegmentSelectionTool" , "" };
            ToolHandle<ActsTrk::IFitterTool> m_trackFitTool{this, "FittingTool", ""};
            ToolHandle<ISpacePointCalibrator> m_calibTool{this, "Calibrator", ""};
            PublicToolHandle<ActsTrk::ITrackingGeometryTool> m_trackingGeometryTool{this, "TrackingGeometryTool", ""};
            ToolHandle<ActsTrk::IExtrapolationTool> m_extrapolationTool{this, "ExtrapolationTool" ,"" };
            ToolHandle<MuonValR4::ITrackVisualizationTool> m_visualizationTool{this, "VisualizationTool", ""};
            Gaudi::Property<double> m_seedHalfLength{this, "SeedHalfLength", 50.*Gaudi::Units::cm};
            SG::WriteHandleKey<ActsTrk::TrackContainer> m_writeKey{this, "TrackWriteKey", "MsTracks"};
            Gaudi::Property<bool> m_useMlSeeder{this, "UseMlSeeder", false, "Use segment-edge ML candidate ids to split seeding"};
            Gaudi::Property<std::string> m_mlCandidateDecoration{this, "MlCandidateDecoration", "trackCandidateIds", "Segment vector<unsigned> decoration with ML track-candidate ids"};
            Gaudi::Property<unsigned> m_mlMinSegmentsPerCandidate{this, "MlMinSegmentsPerCandidate", 2};
            Gaudi::Property<bool> m_mlFallbackToBaselineIfUndecorated{
                this, "MlFallbackToBaselineIfUndecorated", true,
                "Run baseline seeder if the input segment container has no ML decoration"};
            Gaudi::Property<bool> m_mlFallbackToBaselineIfNoCandidates{
                this, "MlFallbackToBaselineIfNoCandidates", false,
                "Run baseline seeder if ML grouping produced no seed candidates"};
            Gaudi::Property<bool> m_mlRunCandidatesInParallel{
                this, "MlRunCandidatesInParallel", true,
                "Run baseline seeding independently for ML candidate groups in parallel"};
            SG::ReadDecorHandleKey<xAOD::MuonSegmentContainer> m_mlCandidateDecorKey{
                this, "MlCandidateDecorationKey", "", "Scheduler dependency on ML candidate decoration"};

            std::unique_ptr<MsTrackSeeder> m_seeder{};
            std::unique_ptr<MlMsTrackSeeder> m_mlSeeder{};
    };      
}
 
#endif