Tracking/TrkTools/TrkTrackSummaryTool/TrkTrackSummaryTool/TrackSummaryTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRKTRACKSUMMARYTOOL_H
#define TRKTRACKSUMMARYTOOL_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "GaudiKernel/ToolHandle.h"
#include "TrkTrack/Track.h"               //used in the included icc file
#include "TrkTrackSummary/TrackSummary.h" //used in the included icc file
 
#include "TRT_ElectronPidTools/ITRT_ToT_dEdx.h" //template parameter to tool handle
#include "TrkToolInterfaces/ITrackSummaryHelperTool.h" //template parameter to tool handle
#include "TrkToolInterfaces/IPixelToTPIDTool.h" //template parameter to tool handle
#include "TrkToolInterfaces/ITRT_ElectronPidTool.h" //template parameter to tool handle
 
#include "TrkToolInterfaces/IExtendedTrackSummaryTool.h"
#include <bitset>
#include <memory>
#include <vector>
 
class EventContext;
class AtlasDetectorID;
class Identifier;
 
namespace Trk {

enum TRT_ElectronPidProbability
{
  Combined = 0,
  HighThreshold = 1,
  TimeOverThreshold = 2,
  Bremsstrahlung = 3
};
 
class RIO_OnTrack;
class TrackStateOnSurface;
class MeasurementBase;
 
class TrackSummaryTool final
  : public extends<AthAlgTool, IExtendedTrackSummaryTool>
{
 
public:
  TrackSummaryTool(const std::string&, const std::string&, const IInterface*);
  virtual ~TrackSummaryTool();
  virtual StatusCode initialize() override;

  using IExtendedTrackSummaryTool::computeAndReplaceTrackSummary;
  using IExtendedTrackSummaryTool::summary;
  using IExtendedTrackSummaryTool::summaryNoHoleSearch;
  using IExtendedTrackSummaryTool::updateTrack;
 
  virtual void computeAndReplaceTrackSummary(
    const EventContext& ctx,
    Track& track,
    bool suppress_hole_search = false) const override final;

  virtual void updateTrack(const EventContext& ctx,
                           Track& track) const override final;
 
  /* Start from a copy of the existing input track summary if there,
   * otherwise start from a new one. Fill it and return it.
   * Does not modify the const track.
   */
  virtual std::unique_ptr<Trk::TrackSummary> summary(
    const EventContext& ctx,
    const Track& track) const override final;
 
  /* Start from a copy of the existing input track summary if there,
   * otherwise start from a new one. Fill it and return it.
   * but without doing the hole search.
   * Does not modify the const track.
   */
  virtual std::unique_ptr<Trk::TrackSummary> summaryNoHoleSearch(
    const EventContext& ctx,
    const Track& track) const override final;

  virtual void updateTrackSummary(const EventContext& ctx,
                                  Track& track) const override final;

  virtual void updateTrackSummary(
    const EventContext& ctx,
    Track& track,
    bool suppress_hole_search = false) const override final;
 
private:
  /*
   * Fill the summary info for a Track*/
  void fillSummary(const EventContext& ctx,
                   Trk::TrackSummary& ts,
                   const Trk::Track& track,
                   bool doHolesInDet,
                   bool doHolesMuon) const;
 
  /*
   * If a summary is there Update it with the required info.
   * If not there create a new one with the required info.
   */
  void UpdateSummary(const EventContext& ctx,
                     Track& track,
                     bool suppress_hole_search) const;
 
  std::unique_ptr<Trk::TrackSummary> createSummary(
    const EventContext& ctx,
    const Track& track,
    bool doHolesInDet,
    bool doHolesMuon) const;

  const Trk::ITrackSummaryHelperTool* getTool(
    const Identifier& id) const;

  ToolHandle<ITrackSummaryHelperTool>
    m_idTool{ this, "InDetSummaryHelperTool", "", "" };
  ToolHandle<ITrackSummaryHelperTool>
    m_muonTool{ this, "MuonSummaryHelperTool", "", "" };

  Gaudi::Property<bool> m_doHolesMuon{ this, "doHolesMuon", false, "" };
  Gaudi::Property<bool> m_doHolesInDet{ this, "doHolesInDet", false, "" };

  Gaudi::Property<bool> m_addMuonDetailedSummary{ this,
                                                  "AddDetailedMuonSummary",
                                                  true,
                                                  "" };

  Gaudi::Property<bool> m_pixelExists{ this, "PixelExists", true, "" };
 
  Gaudi::Property<bool> m_alwaysRecomputeHoles{ this,
                                                "AlwaysRecomputeHoles",
                                                false,
                                                "" };

  const AtlasDetectorID* m_detID;

  void processTrackStates(const EventContext& ctx,
                          const Track& track,
                          const Trk::TrackStates* tsos,
                          std::vector<int>& information,
                          std::bitset<numberOfDetectorTypes>& hitPattern,
                          bool doHolesInDet,
                          bool doHolesMuon) const;
 
  void processMeasurement(const EventContext& ctx,
                          const Track& track,
                          const Trk::MeasurementBase* meas,
                          const Trk::TrackStateOnSurface* tsos,
                          std::vector<int>& information,
                          std::bitset<numberOfDetectorTypes>& hitPattern) const;

  void searchHolesStepWise(const Trk::Track& track,
                           std::vector<int>& information,
                           bool doHolesInDet,
                           bool doHolesMuon) const;
};
 
}
 
#include "TrkTrackSummaryTool/TrackSummaryTool.icc"
#endif