TRT_TrackSegmentsMaker_ATLxk.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/

//  Header file for class TRT_TrackSegmentsMaker_ATLxk
// (c) ATLAS Detector software
// Class for track candidates generation using InDet::TRT_DriftCircles
// for standard Atlas geometry
// Version 1.0 11/10/2005 I.Gavrilenko
 
#ifndef TRT_TrackSegmentsMaker_ATLxk_H
#define TRT_TrackSegmentsMaker_ATLxk_H
 
#include <list>
#include <map>
 
#include "GaudiKernel/ServiceHandle.h"
#include "GaudiKernel/ToolHandle.h"
#include "AthenaBaseComps/AthAlgTool.h"
#include "GeoModelInterfaces/IGeoModelSvc.h"
#include "InDetRecToolInterfaces/ITRT_TrackSegmentsMaker.h"
#include "InDetRecToolInterfaces/ITRT_TrackExtensionTool.h"
#include "TrkGeometry/MagneticFieldProperties.h"
#include "InDetPrepRawData/TRT_DriftCircleContainer.h"
#include "TRT_ReadoutGeometry/TRT_DetectorManager.h"
#include "TRT_TrackSegmentsTool_xk/TRT_DriftCircleLinkN_xk.h"
#include "TrkEventUtils/PRDtoTrackMap.h"
#include "TrkEventUtils/EventDataBase.h"
#include "TRT_TrackSegmentsToolCondData_xk.h"
 
#include "StoreGate/ReadHandleKey.h"
 
class MsgStream;
 
namespace InDet{
 
  class ITRT_TrackExtensionTool;
 
  class TRT_TrackSegmentsMaker_ATLxk : 
    virtual public ITRT_TrackSegmentsMaker, public AthAlgTool
    {
      // Public methods:
      
    public:
      
      // Standard tool methods
 
      TRT_TrackSegmentsMaker_ATLxk
    (const std::string&,const std::string&,const IInterface*);
      virtual ~TRT_TrackSegmentsMaker_ATLxk();
      virtual StatusCode               initialize() override;
      virtual StatusCode               finalize  () override;

      // Methods to initialize tool for new event or region
 
      virtual std::unique_ptr<InDet::ITRT_TrackSegmentsMaker::IEventData> newEvent (const EventContext& ctx) const override;
      virtual std::unique_ptr<InDet::ITRT_TrackSegmentsMaker::IEventData> newRegion(const EventContext& ctx, const std::vector<IdentifierHash>&) const override;
      void endEvent(InDet::ITRT_TrackSegmentsMaker::IEventData &event_data) const override;
      
      // Methods of seeds production without vertex constraint
 
      virtual void find(const EventContext &ctx,
                        InDet::ITRT_TrackSegmentsMaker::IEventData &event_data,
                        InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap &used) const override;

      // Iterator through seeds pseudo collection produced accordingly
      // methods find    
      
      virtual Trk::TrackSegment* next(InDet::ITRT_TrackSegmentsMaker::IEventData &event_data) const override;
  
      // Print internal tool parameters and status
 
      virtual MsgStream&    dump          (MsgStream   & out) const override;
      virtual std::ostream& dump          (std::ostream& out) const override;
 
    protected:
 
      class EventData;
      class EventData : public Trk::EventDataBase<EventData,InDet::ITRT_TrackSegmentsMaker::IEventData>
      {
         friend class TRT_TrackSegmentsMaker_ATLxk;
      public:
         EventData(const TRT_DriftCircleContainer *trtcontainer, unsigned int cirsize) : m_trtcontainer(trtcontainer) {
            m_segiterator      = m_segments.begin();
            m_sizebin_iterator = m_sizebin.rend();
            m_circles  = new TRT_DriftCircleLinkN_xk[cirsize];
         }
 
         ~EventData() { delete [] m_circles; }
         EventData (const EventData&) = delete;
         EventData& operator= (const EventData&) = delete;
 
      protected:
         const InDet::TRT_DriftCircleContainer *m_trtcontainer = nullptr;
         std::unique_ptr<InDet::ITRT_TrackExtensionTool::IEventData>  m_extEventData;
         int                                    m_clusters  = 0   ;
         int                                    m_nlocal    = 0   ;
         int                                    m_nsegments = 0   ;
 
         std::multimap<unsigned int,unsigned int>  m_bincluster   ;
         std::multimap<unsigned int,unsigned int>  m_sizebin      ;
 
         std::list<Trk::TrackSegment*>            m_segments   ;
         std::list<Trk::TrackSegment*>::iterator  m_segiterator;
 
         std::multimap<unsigned int,unsigned int>::reverse_iterator m_sizebin_iterator;
 
         union {unsigned char H[227500*4]; unsigned int H4[227500];} m_U;
 
         std::multimap<const InDet::TRT_DriftCircle*,Trk::TrackSegment*> m_clusterSegment;
         std::multimap<int                          ,Trk::TrackSegment*> m_qualitySegment;
 
         TRT_DriftCircleLinkN_xk*               m_circles  = nullptr;
 
      };
      
      // Protected data and methods
 
      StringProperty m_fieldmode{this, "MagneticFieldMode", "MapSolenoid",
       "Mode of magnetic field"};
      ToolHandle<ITRT_TrackExtensionTool>    m_extensionTool
         {this, "TrackExtensionTool", "InDet::TRT_TrackExtensionTool_xk"} ; // TRT track extension   tool
 
      Trk::MagneticFieldProperties           m_fieldprop       ; // Magnetic field properties
      const TRT_ID                         * m_trtid{}           ; 
      SG::ReadHandleKey<InDet::TRT_DriftCircleContainer> m_trtname{this,"TRT_ClustersContainer","TRT_DriftCircles","RHK to retrieve TRT_DriftCircles"}; // TRTs   container ; // Name  TRT container
      SG::ReadCondHandleKey<InDet::TRT_TrackSegmentsToolCondData_xk> m_condDataKey{this, "CondDataKey","TRT_TrackSegmentsToolCondData_xk", "Key of TRT_TrackSegmentsToolCondData"};
      SG::ReadHandleKey<Trk::PRDtoTrackMap>          m_prdToTrackMap
         {this,"PRDtoTrackMap",""};
 
      BooleanProperty m_removeNoise{this, "RemoveNoiseDriftCircles", true};
      IntegerProperty m_clustersCut{this, "MinNumberDriftCircles", 10};
      FloatProperty m_pTmin{this, "pTmin", 500.};
      FloatProperty m_sharedfrac{this, "sharedFrac", 0.3};
      IntegerProperty m_nPhi{this, "NumberAzimuthalChannel", 500,
    "number azimuthal channel"};
      IntegerProperty m_nMom{this, "NumberMomentumChannel", 70,
    "number momentum  channel"};
 
      int                                    m_outputlevel{}     ;
      int                                    m_Ts{}              ;
      int                                    m_Ns128{}           ;
      float                                  m_Psi{}             ;
      float                                  m_Psi128{}          ;
      float                                  m_A{}               ;
      float                                  m_Ai{}              ;
      int                                    m_histsize{}        ; // histogram size
 

      // Protected methods
 
      inline
        const TRT_TrackSegmentsToolCondData_xk* getConditionsData() const {
        SG::ReadCondHandle<TRT_TrackSegmentsToolCondData_xk> condDataHandle(m_condDataKey);
        if (not condDataHandle.isValid()) {
          ATH_MSG_FATAL("Failed to get " << m_condDataKey.key());
        }
        return *condDataHandle;
      }
      
      void magneticFieldInit();
      void eraseHistogramm(TRT_TrackSegmentsMaker_ATLxk::EventData &event_data) const;
      void fillHistogramm   (float,int, TRT_TrackSegmentsMaker_ATLxk::EventData &event_data) const;
      void analyseHistogramm(unsigned char&,unsigned int&,float,int,TRT_TrackSegmentsMaker_ATLxk::EventData &event_data) const;
      unsigned int localMaximum(unsigned int, TRT_TrackSegmentsMaker_ATLxk::EventData &event_data) const;
 
      void findLocaly(const EventContext &ctx,
                      unsigned int,
                      const Trk::PRDtoTrackMap *prd_to_track_map,
                      TRT_TrackSegmentsMaker_ATLxk::EventData &event_data,
                      InDet::TRT_DetElementLink_xk::TRT_DetElemUsedMap &used) const;
 
      static void segmentsPreparation(TRT_TrackSegmentsMaker_ATLxk::EventData &event_data) ;
 
      MsgStream&    dumpConditions(MsgStream   & out) const;
      static MsgStream&    dumpEvent     (MsgStream   & out,InDet::ITRT_TrackSegmentsMaker::IEventData &event_data) ;
    };
 
} // end of name space
 
#endif // TRT_TrackSegmentsMaker_ATLxk_H