SiCombinatorialTrackFinderData_xk.h

Go to the documentation of this file.

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

// Header file for class SiCombinatorialTrackFinderData_xk
 
#ifndef SiCombinatorialTrackFinderData_xk_H
#define SiCombinatorialTrackFinderData_xk_H
 
#include "SiSPSeededTrackFinderData/SiTrajectory_xk.h"
#include "SiSPSeededTrackFinderData/SiTools_xk.h"
#include "TrkTrack/TrackInfo.h"
 
#include <list>
 
namespace Trk {
  class Track;
}
 
namespace InDet {

 
  class SiCombinatorialTrackFinderData_xk {
 
  public:
    SiCombinatorialTrackFinderData_xk();

    ~SiCombinatorialTrackFinderData_xk() = default;
 
    //enum used in Track Maker tools for summary statistics table
    typedef enum summaryStatArraySizes{
      kNStatAllTypes = 15,
      kNStatEtaTypes = 2,
      kNSeedTypes = 4,
      kNRapidityRanges = 8,
      kNCombStats = 6
    } summaryStatArraySizes;

    enum ResultCode {
      Success = 99,
      Unrecoverable = 0,
      PixSeedDiffKFBwd = 3,
      PixSeedDiffKFFwd = 4,
      PixSeedNCluster = 5,
      MixSeedDiffKFBwd = -3,
      MixSeedDiffKFFwd = -4,
      MixSeedNCluster = -5,
      Quality = 6,
      Pt = 7,
      NCluster = 8,
      HoleCut = 9,
    };
    enum ResultCodeThreshold {
      RecoverableForDisTrk = 4,
    };


    void setTools(const Trk::IPatternParametersPropagator* propTool,
                  const Trk::IPatternParametersUpdator* updatorTool,
                  const Trk::IRIO_OnTrackCreator* rioTool,
                  const IInDetConditionsTool* pixCondTool,
                  const IInDetConditionsTool* sctCondTool,
                  const Trk::MagneticFieldProperties* fieldProp,
                  const Trk::IBoundaryCheckTool* boundaryCheckTool);
 
    void setTools(const IInDetConditionsTool* pixCondTool,
                  const IInDetConditionsTool* sctCondTool) {
       m_tools.setTools(pixCondTool,
                        sctCondTool);
    }

    void setFieldCondObj(const  AtlasFieldCacheCondObj* fieldCondObj)
    {m_tools.setFieldCondObj(fieldCondObj);}

    void setPixContainer(const InDet::PixelClusterContainer* pixcont)
    {m_pixcontainer = pixcont;}

    void setSctContainer(const InDet::SCT_ClusterContainer* sctcont)
    {m_sctcontainer = sctcont;}
 
    void setPixelDetectorElementStatus(
        const InDet::SiDetectorElementStatus* pixelDetElStatus) {
       m_tools.setPixelDetectorElementStatus(pixelDetElStatus);
    }
    void setSCTDetectorElementStatus(
        const InDet::SiDetectorElementStatus* sctDetElStatus) {
       m_tools.setSCTDetectorElementStatus(sctDetElStatus);
    }

    void setResultCode(const ResultCode code) {m_resultCode = code;}

    void setFlagToReturnFailedTrack(const bool);
 
    void setHeavyIon(bool);
    void setITkGeometry(bool);
    void setFastTracking(bool);
 
    void setCosmicTrack(int value) {m_cosmicTrack = value;}
    void setNclusmin(int value)    {m_nclusmin = value;}
    void setNclusminb(int value)   {m_nclusminb = value;}
    void setNwclusmin(int value)   {m_nwclusmin = value;}
    void setNholesmax(int value)   {m_nholesmax = value;}
    void setDholesmax(int value)   {m_dholesmax = value;}
    void setSimpleTrack(bool value){m_simpleTrack = value;}
 
    void setPTmin(double value)      {m_pTmin = value;}
    void setPTminBrem(double value)  {m_pTminBrem = value;}
    void setXi2max(double value)     {m_xi2max = value;}
    void setXi2maxNoAdd(double value){m_xi2maxNoAdd = value;}
    void setXi2maxlink(double value) {m_xi2maxlink = value;}

 

    const InDet::PixelClusterContainer* pixContainer() const
    {return m_pixcontainer;}

    const InDet::SCT_ClusterContainer* sctContainer() const
    {return m_sctcontainer;}

    const Trk::PRDtoTrackMap* PRDtoTrackMap() const
    {return m_tools.PRDtoTrackMap();}

    bool isInitialized() const {return m_initialized;}
 
    // flag to tell whether to return tracks even in case fit is un-successful (for disappearing track trigger)
    bool flagToReturnFailedTrack() const {return m_flagToReturnFailedTrack;}
    // code to tell the fit result (code includes non-succesful cases for disappearing track trigger)
    SiCombinatorialTrackFinderData_xk::ResultCode resultCode() const {return m_resultCode;}
 
    bool heavyIon() const        {return m_heavyIon;}
    bool isITkGeometry() const   {return m_ITkGeometry;}
    bool useFastTracking() const {return m_doFastTracking;}
 
    int cosmicTrack()    const {return m_cosmicTrack;}
    int nclusmin()       const {return m_nclusmin;}
    int nclusminb()      const {return m_nclusminb;}
    int nwclusmin()      const {return m_nwclusmin;}
    int nholesmax()      const {return m_nholesmax;}
    int dholesmax()      const {return m_dholesmax;}
    bool simpleTrack()   const {return m_simpleTrack;}
 
    double pTmin()       const {return m_pTmin;}
    double pTminBrem()   const {return m_pTminBrem;}
    double xi2max()      const {return m_xi2max;}
    double xi2maxNoAdd() const {return m_xi2maxNoAdd;}
    double xi2maxlink()  const {return m_xi2maxlink;}

    SiTrajectory_xk& trajectory()   {return m_trajectory;}
    Trk::TrackInfo& trackinfo()     {return m_trackinfo;}
    InDet::SiTools_xk& tools()      {return m_tools;}
    std::list<Trk::Track*>& tracks(){return m_tracks;}
 
    int& nprint()     {return m_nprint;}
    int& inputseeds() {return m_inputseeds;}
    int& goodseeds()  {return m_goodseeds;}
    int& findtracks() {return m_findtracks;}
    int& inittracks() {return m_inittracks;}
    int& roadbug()    {return m_roadbug;}
    std::array<bool,kNCombStats>& statistic() {return m_statistic;}


    bool findPatternHoleSearchOutcome (Trk::Track* theTrack, InDet::PatternHoleSearchOutcome & outcome) const;
    void addPatternHoleSearchOutcome (Trk::Track* theTrack, const InDet::PatternHoleSearchOutcome & outcome); 
 
  protected:
    void setPRDtoTrackMap(const Trk::PRDtoTrackMap* prd_to_track_map)
    {m_tools.setPRDtoTrackMap(prd_to_track_map);}
 
  private:

    bool m_initialized{false};
    SiTrajectory_xk m_trajectory;
    Trk::TrackInfo m_trackinfo;
    InDet::SiTools_xk m_tools;
    std::list<Trk::Track*> m_tracks;
    int m_nprint{0};
    int m_inputseeds{0};
    int m_goodseeds{0};
    int m_findtracks{0};
    int m_inittracks{0};
    int m_roadbug{0};
    std::array<bool,kNCombStats> m_statistic{};
    // Heavy ion flag
    bool m_heavyIon{false};
    int m_cosmicTrack{0};
    int m_nclusmin{0};
    int m_nclusminb{0};
    int m_nwclusmin{0};
    int m_nholesmax{0};
    int m_dholesmax{0};
    bool m_simpleTrack{false};
    bool m_flagToReturnFailedTrack{false};
    ResultCode m_resultCode{ResultCode::Success};
    double m_pTmin{0.};
    double m_pTminBrem{0.};
    double m_xi2max{0.};
    double m_xi2maxNoAdd{0.};
    double m_xi2maxlink{0.};
    // Is ITk geometry
    bool m_ITkGeometry{false};
    // Do Fast Tracking setup
    bool m_doFastTracking{false};

    std::map<Trk::Track*, InDet::PatternHoleSearchOutcome> m_holeSearchOutcomes; 

    const InDet::PixelClusterContainer* m_pixcontainer{nullptr};
    const InDet::SCT_ClusterContainer* m_sctcontainer{nullptr};
 
  };
 
} // end of name space
 
#endif // SiCombinatorialTrackFinderData_xk_H