SiSPSeededTrackFinder.h

Go to the documentation of this file.

// -*- C++ -*-
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
 
#ifndef SiSPSeededTrackFinder_H
#define SiSPSeededTrackFinder_H

#include <Gaudi/Property.h>
#include "AthenaBaseComps/AthReentrantAlgorithm.h"

#include "BeamSpotConditionsData/BeamSpotData.h"
#include "InDetRecToolInterfaces/ISiSpacePointsSeedMaker.h"
#include "InDetRecToolInterfaces/ISiTrackMaker.h"
#include "InDetRecToolInterfaces/ISiZvertexMaker.h"
#include "InDetRecToolInterfaces/IInDetEtaDependentCutsSvc.h"
#include "IRegionSelector/IRegSelTool.h"
#include "StoreGate/DataHandle.h"
#include "TrkCaloClusterROI/ROIPhiRZContainer.h"
#include "TrkExInterfaces/IPatternParametersPropagator.h"
#include "TrkToolInterfaces/IExtendedTrackSummaryTool.h"
#include "TrkGeometry/MagneticFieldProperties.h"
#include "TrkSpacePoint/SpacePointContainer.h"
#include "TrkSurfaces/PerigeeSurface.h"
#include "TrkTrack/TrackCollection.h"
#include "TrkEventUtils/PRDtoTrackMap.h"
#include "xAODEventInfo/EventInfo.h"

#include "GaudiKernel/ToolHandle.h"

#include <atomic>
#include <string>
#include <mutex>
 
//class SpacePointContainer;
namespace InDet {

  class SiSPSeededTrackFinder : public AthReentrantAlgorithm 
  {
    
    // Public methods
      
  public:
      

    SiSPSeededTrackFinder(const std::string &name, ISvcLocator *pSvcLocator);
    virtual ~SiSPSeededTrackFinder() = default;
    virtual StatusCode initialize() override;
    virtual StatusCode execute(const EventContext& ctx) const override;
    virtual StatusCode finalize() override;

    virtual bool isClonable() const override { return true; };
 
  protected:

    // Protected data 

    enum ECounter {kNSeeds, kNTracks, kNCounter};

    class Counter_t : public std::array<std::atomic_int, kNCounter> 
    {
    public:
      Counter_t& operator += (const Counter_t& counter) {
        for (unsigned int idx=0; idx <kNCounter; ++idx) {
          (*this)[idx] += counter[idx];
        }
        return *this;
      }
    };


    BooleanProperty m_useZvertexTool{this, "useZvertexTool", true}; 
    BooleanProperty m_writeHolesFromPattern{this, "writeHolesFromPattern", false,"Flag to activate writing hole info from the pattern recognition"}; 
    BooleanProperty m_useMBTS{this, "useMBTSTimeDiff", false};
    BooleanProperty m_useNewStrategy{this, "useNewStrategy", false};
    BooleanProperty m_useZBoundaryFinding{this, "useZBoundFinding", false};
    BooleanProperty m_ITKGeometry{this, "ITKGeometry", false, "Flag to specify if it is ITK geometry"};
    BooleanProperty m_useITkConvSeeded{this, "useITkConvSeeded", false, "ITk EM-seeded conversion reco"};
    BooleanProperty m_doFastTracking{this, "doFastTracking", false, "ITk fast tracking reco"};
    IntegerProperty m_maxNumberSeeds{this, "maxNumberSeeds", 3000000, "Max. number used seeds"};
    BooleanProperty m_alwaysProtectAgainstBusyEvent{this, "alwaysProtectAgainstBusyEvents", false, "Flag that enables checking always maxNumberPIXsp and maxNumberSCTsp"};
    IntegerProperty m_maxPIXsp{this, "maxNumberPIXsp", 150000, "Max. number pixels space points"};
    IntegerProperty m_maxSCTsp{this, "maxNumberSCTsp", 500000, "Max. number sct    space points"};
    IntegerProperty m_nfreeCut{this, "FreeClustersCut", 1, "Min number free clusters"};
    IntegerProperty m_histsize{this, "HistSize", 1400};
    IntegerProperty m_nvertex{this, "maxVertices", 4};
    DoubleProperty m_zcut{this, "Zcut", 350.};
    DoubleProperty m_deltaEta{this, "dEtaCaloRoI", .1};
    DoubleProperty m_deltaPhi{this, "dPhiCaloRoI", .25};
    DoubleProperty m_deltaZ{this, "dZCaloRoI", 300.};
    StringProperty m_fieldmode{this, "MagneticFieldMode", "MapSolenoid"};
    BooleanProperty m_doDumpGBTSTrainingData{this, "doDumpGBTSTrainingData", false, "write training data used to create GBTS connection table"};
    BooleanProperty m_doDumpGBTSTrainingDataLRT{this, "doDumpGBTSTrainingDataLRT", false, "write LRT training data used to create GBTS connection table"};
    BooleanProperty m_removeShortSegments{this, "removeShortSegments", false, "remove short segments from GBTS connection table"};
    StringProperty m_GBTSTrainingDataFileName{this, "GBTSTrainingDataFileName", "layer_connection_table.csv", "file to write training data used to create GBTS connection table"};


    double                         m_pTcut{500};
    double                         m_imcut{2.};
    double                         m_zstep{0.};


    SG::ReadHandleKey<xAOD::EventInfo> m_evtKey{this, "EventInfoKey", "EventInfo"};
    SG::ReadHandleKey<SpacePointContainer> m_SpacePointsSCTKey{this, "SpacePointsSCTName", "SCT_SpacePoints"};
    SG::ReadHandleKey<SpacePointContainer> m_SpacePointsPixelKey{this, "SpacePointsPixelName", "PixelSpacePoints"};
    SG::ReadHandleKey<Trk::PRDtoTrackMap> m_prdToTrackMap{this,"PRDtoTrackMap",""};
    SG::ReadHandleKey<ROIPhiRZContainer> m_caloClusterROIKey{this, "EMROIPhiRZContainer", "InDetCaloClusterROIPhiRZ15GeVUnordered", "Name of the calo cluster ROIs in Phi,R,Z parameterization"};
 
    SG::ReadCondHandleKey<InDet::BeamSpotData> m_beamSpotKey{this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot"};
 
    SG::ReadDecorHandleKey<xAOD::EventInfo> m_mbtsKey{this, "MBTSKey", m_evtKey, "MBTSBackground"};
 
    SG::WriteHandleKey<TrackCollection> m_outputTracksKey{this, "TracksLocation", "SiSPSeededTracks"};


    ToolHandle<ISiSpacePointsSeedMaker> m_seedsmaker{this, "SeedsTool", "InDet::SiSpacePointsSeedMaker_ATLxk/InDetSpSeedsMaker", "Space poins seed maker"};
    ToolHandle<ISiZvertexMaker> m_zvertexmaker{this, "ZvertexTool", "InDet::SiZvertexMaker_xk/InDetSiZvertexMaker", "Space poins z-vertex maker"};
    ToolHandle<ISiTrackMaker> m_trackmaker{this, "TrackTool", "InDet::SiTrackMaker_xk/InDetSiTrackMaker", "Track maker"};
    PublicToolHandle<Trk::IPatternParametersPropagator> m_proptool{this, "PropagatorTool", "Trk::RungeKuttaPropagator/InDetPropagator"};
    ToolHandle<Trk::IExtendedTrackSummaryTool> m_trackSummaryTool{this, "TrackSummaryTool", "InDetTrackSummaryToolNoHoleSearch"};
    ToolHandle<IRegSelTool> m_regsel_strip { this, "RegSelTool_Strip",    "RegSelTool/RegSelTool_SCT"   };


    Trk::MagneticFieldProperties m_fieldprop;



    ServiceHandle<IInDetEtaDependentCutsSvc> m_etaDependentCutsSvc{this, "InDetEtaDependentCutsSvc", "InDetEtaDependentCutsSvc"};


    mutable Counter_t m_counterTotal ATLAS_THREAD_SAFE {};
 
    mutable std::atomic_int m_neventsTotal{0}; 
    mutable std::atomic_int m_neventsTotalV{0}; 
    mutable std::atomic_int m_problemsTotal{0}; 
    mutable std::atomic_int m_problemsTotalV{0}; 
 
    mutable std::mutex m_GBTSTrainingDataMutex;
    mutable std::map<int, std::map<int, unsigned long>> m_GBTSTrainingData ATLAS_THREAD_SAFE;
    mutable std::atomic_ulong m_numGBTSTrainingData{0};

    // Protected methods


    MsgStream& dump(MSG::Level lvl, const SiSPSeededTrackFinder::Counter_t*) const;
    MsgStream& dumptools(MsgStream& out) const;
    MsgStream& dumpevent(MsgStream& out, const SiSPSeededTrackFinder::Counter_t& counter) const;
 
    // check event quality - mainly used for HI events 
    bool isGoodEvent(const EventContext& ctx) const; 
 
    void filterSharedTracks(std::multimap<double, Trk::Track*>& scoredTracks) const;
    void filterSharedTracksFast(std::multimap<double, Trk::Track*>& scoredTracks) const;
 
    void fillZHistogram(const Trk::Track* Tr,
                        const Trk::PerigeeSurface& beamlinePerigee,
                        std::vector<int>& numberWeightedhistogram,
                        std::vector<double>& zWeightedHistogram,
                        std::vector<double>& ptWeightedHistogram) const;
 
    void findZvertex(std::list<Trk::Vertex>& vertexList,
                     std::pair<double, double> & zBoundaries,
                     const std::vector<int>& numberWeightedhistogram,
                     const std::vector<double>& zWeightedHistogram,
                     const std::vector<double>& ptWeightedHistogram) const;

    StatusCode oldStrategy(const EventContext& ctx) const; 
    
    StatusCode newStrategy(const EventContext& ctx) const; 
 
    StatusCode itkFastTrackingStrategy(const EventContext& ctx) const; 
    StatusCode itkConvStrategy(const EventContext& ctx) const; 
 
    void magneticFieldInit();
 
    bool passEtaDepCuts(const Trk::Track* track,
            int nClusters,
            int nFreeClusters,
            int nPixels) const;
 
    void collectGBTSTrainingData(const Trk::Track*) const;
    void dumpGBTSTrainingData() const;
 
  };
}
#endif // SiSPSeededTrackFinder_H