SiSPSeededTrackFinderRoI.h

Go to the documentation of this file.

// -*- C++ -*-
 
/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
 
#ifndef SiSPSeededTrackFinderRoI_H
#define SiSPSeededTrackFinderRoI_H
 
#include "AthenaBaseComps/AthReentrantAlgorithm.h"
#include "GaudiKernel/ToolHandle.h"
 
#include "InDetRecToolInterfaces/ISiSpacePointsSeedMaker.h"
#include "InDetRecToolInterfaces/ISiZvertexMaker.h" 
#include "InDetRecToolInterfaces/ISiTrackMaker.h"
#include "InDetRecToolInterfaces/IZWindowRoISeedTool.h"
#include "TrkToolInterfaces/IExtendedTrackSummaryTool.h"
#include "InDetRecToolInterfaces/IInDetEtaDependentCutsSvc.h"
 
#include "TrkTrack/TrackCollection.h"
#include "BeamSpotConditionsData/BeamSpotData.h"
#include "TrkExInterfaces/IPatternParametersPropagator.h"
#include "TrkGeometry/MagneticFieldProperties.h"
#include "TrkSurfaces/PerigeeSurface.h" 
#include "TrkEventUtils/PRDtoTrackMap.h"
 
#include "xAODTracking/VertexContainer.h"
#include "xAODEventInfo/EventInfo.h"
 
#include <string>
#include <atomic>
 
namespace InDet {
 
  // Class-algorithm for track finding in Pixels and SCT
  // initiated by space points seeds filtering in a given
  // RoI within the z axis
  //
  class SiSPSeededTrackFinderRoI : public AthReentrantAlgorithm 
  {
    
    // Public methods:
      
  public:
      
    // @name Standard Algotithm methods

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

    // @name Flags to configure SiSPSeededTrackFinderRoI

 
    BooleanProperty m_useRoIWidth{this, "useRoIWidth", true, "Use width of RoI along z-axis"};
    IntegerProperty m_maxNumberSeeds{this, "maxNumberSeeds", 3000000, "Max. number used seeds"};
    IntegerProperty m_nfreeCut{this, "FreeClustersCut", 1, "Min number free clusters"};
    BooleanProperty m_doRandomSpot{this, "doRandomSpot", false, "Low-pT tracking setting the RoI in a random position"};
 
    StringProperty m_fieldmode{this, "MagneticFieldMode", "MapSolenoid"};

    // @name Input/Output Handles

    SG::WriteHandleKey<TrackCollection> m_outputTracksKey{this, "TracksLocation", "SiSPSeededTracksRoI", "Output track collection"};
    SG::WriteHandleKey<xAOD::VertexContainer> m_vxOutputKey{this, "VxOutputName", "LowPtRoIVertices", "Output Vertex collection with per-event RoI information"};
 
    SG::ReadHandleKey<Trk::PRDtoTrackMap> m_prdToTrackMap{this,"PRDtoTrackMap",""};
    SG::ReadCondHandleKey<InDet::BeamSpotData> m_beamSpotKey{this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot"};
    SG::ReadHandleKey<xAOD::EventInfo> m_evtKey{this, "EventInfoKey", "EventInfo"};

    // @name Algorithm Tools

 
    ToolHandle<ISiSpacePointsSeedMaker> m_seedsmaker{this, "SeedsTool", "InDet::SiSpacePointsSeedMaker_ATLxk/InDetSpSeedsMaker", "Space poins seed maker"};
    ToolHandle<ISiTrackMaker> m_trackmaker{this, "TrackTool", "InDet::SiTrackMaker_xk/InDetSiTrackMaker", "Track maker"};
    ToolHandle<Trk::IExtendedTrackSummaryTool> m_trackSummaryTool{this, "TrackSummaryTool", "InDetTrackSummaryToolNoHoleSearch"};
 
    ToolHandle<IZWindowRoISeedTool> m_ZWindowRoISeedTool{this, "ZWindowRoISeedTool", "InDet::ZWindowRoISeedTool", "Tool to determin per-event RoI"};
    ToolHandle<IZWindowRoISeedTool> m_RandomRoISeedTool{this, "RandomRoISeedTool", "InDet::RandomRoISeedTool", "Tool to run using additional RoIs randomly chosen away from the main one if doRandomSpot is set"};
 
    ServiceHandle<IInDetEtaDependentCutsSvc> m_etaDependentCutsSvc{this, "EtaDependentCutsSvc", "", "if enable, further require eta-dependent selections on track candidates"};

    // Protected settings
    Trk::MagneticFieldProperties  m_fieldprop;
 

    // Protected methods
         
    void filterSharedTracks(std::multimap<double,Trk::Track*>&) const;
 
    void magneticFieldInit();

    bool passEtaDepCuts(const Trk::Track* track,
            int nClusters,
            int nFreeClusters,
            int nPixels) const;

    // @name Statistics and Debug Information


    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;
      }
    };
 
    mutable Counter_t m_counterTotal ATLAS_THREAD_SAFE {};
 
    mutable std::atomic_int m_neventsTotal{0}; 
    mutable std::atomic_int m_problemsTotal{0}; 
 
    MsgStream& dump(MSG::Level lvl, const SiSPSeededTrackFinderRoI::Counter_t*) const;
    MsgStream& dumptools(MsgStream& out) const;
    MsgStream& dumpevent(MsgStream& out, const SiSPSeededTrackFinderRoI::Counter_t& counter) const;

 
  };
 
}
 
#endif // SiSPSeededTrackFinderRoI_H