TrackParticleCreatorTool.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2024 CERN for the benefit of the ATLAS collaboration
*/
 
/***************************************************************************
TrackParticleCreatorTool.h  -  Description
-------------------
begin   : Autumn 2003
authors : Andreas Wildauer (CERN PH-ATC), Fredrik Akesson (CERN PH-ATC)
email   : andreas.wildauer@cern.ch, fredrik.akesson@cern.ch
changes : 11.02.04 added docu
 
***************************************************************************/
#ifndef TRKPARTICLECREATOR_PARTICLECREATORTOOL_H
#define TRKPARTICLECREATOR_PARTICLECREATORTOOL_H
 
#include "AthenaBaseComps/AthAlgTool.h"
#include "AthContainers/AuxElement.h"
#include "GaudiKernel/ToolHandle.h"
#include "EventPrimitives/EventPrimitivesHelpers.h"
 
#include "BeamSpotConditionsData/BeamSpotData.h"
// MagField cache
#include "MagFieldConditions/AtlasFieldCacheCondObj.h"
#include "MagFieldElements/AtlasFieldCache.h"
 
#include "InDetIdentifier/PixelID.h"
#include "InDetIdentifier/SCT_ID.h"
#include "InDetIdentifier/TRT_ID.h"
#include "PixelGeoModel/IIBLParameterSvc.h"
 
#include "InDetPrepRawData/PixelCluster.h"
#include "InDetRecToolInterfaces/IInDetTestPixelLayerTool.h"
#include "ITrackToVertex/ITrackToVertex.h"
#include "TrkDetDescrInterfaces/ITrackingVolumesSvc.h"
#include "TrkEventPrimitives/FitQuality.h"
#include "TrkEventUtils/ClusterSplitProbabilityContainer.h"
#include "TrkEventUtils/PRDtoTrackMap.h"
#include "TrkExInterfaces/IExtrapolator.h"
#include "TrkParameters/TrackParameters.h"
#include "TrkParticleBase/TrackParticleBase.h" // for TrackParticleOrigin enum
#include "TrkTrack/TrackInfo.h"
#include "TrkTrack/Track.h"
#include "TrkTrackSummary/MuonTrackSummary.h"
#include "TrkTrackSummary/TrackSummary.h"
 
#include "TrkToolInterfaces/IExtendedTrackSummaryTool.h"
#include "TrkToolInterfaces/IPixelToTPIDTool.h" //template parameter to tool handle
#include "TrkToolInterfaces/ITrackParticleCreatorTool.h"
#include "TrkToolInterfaces/ITRT_ElectronPidTool.h" //template parameter to tool handle
 
#include "MuonRecToolInterfaces/IMuonHitSummaryTool.h"
 
#include "xAODTracking/TrackParticle.h"
#include "xAODTracking/TrackParticleContainer.h"
#include "xAODTracking/TrackingPrimitives.h"
#include "xAODTracking/VertexFwd.h"
 
 
namespace Rec {
class TrackParticle;
}
 
namespace InDet {
class BeamSpotData;
}
 
namespace Trk {
class VxCandidate;
 
class TrackParticleCreatorTool final
  : public extends<AthAlgTool, ITrackParticleCreatorTool>
{
public:
  TrackParticleCreatorTool(const std::string&,
                           const std::string&,
                           const IInterface*);
 
  virtual ~TrackParticleCreatorTool() = default;
 
  virtual StatusCode initialize() override;

  virtual xAOD::TrackParticle* createParticle(
    const EventContext& ctx,
    const Rec::TrackParticle& trackParticle,
    xAOD::TrackParticleContainer* container) const override final;

  virtual xAOD::TrackParticle* createParticle(
    const EventContext& ctx,
    const Trk::Track& track,
    xAOD::TrackParticleContainer* container,
    const xAOD::Vertex* vxCandidate,
    xAOD::ParticleHypothesis prtOrigin) const override final;

  virtual xAOD::TrackParticle* createParticle(
    const EventContext& ctx,
    const ElementLink<TrackCollection>& trackLink,
    xAOD::TrackParticleContainer* container,
    const xAOD::Vertex* vxCandidate,
    xAOD::ParticleHypothesis prtOrigin) const override final;

  virtual xAOD::TrackParticle* createParticle(
    const EventContext& ctx,
    const Perigee* perigee,
    const FitQuality* fq,
    const TrackInfo* trackInfo,
    const TrackSummary* summary,
    const std::vector<const Trk::TrackParameters*>& parameters,
    const std::vector<xAOD::ParameterPosition>& positions,
    xAOD::ParticleHypothesis prtOrigin,
    xAOD::TrackParticleContainer* container) const override final;
 
  virtual const InDet::BeamSpotData* CacheBeamSpotData(
    const EventContext& ctx) const override final;

  void setFitQuality(xAOD::TrackParticle& tp, const FitQuality& fq) const;

  void setTrackInfo(xAOD::TrackParticle& tp,
                    const TrackInfo& trackInfo,
                    xAOD::ParticleHypothesis prtOrigin) const;

  void setTrackSummary(xAOD::TrackParticle& tp,
                       const TrackSummary& summary) const;

   void addPIDInformation(const EventContext& ctx, const Track *track, xAOD::TrackParticle& tp) const;

   void addDetailedHitInformation(const Trk::TrackStates* trackStates, xAOD::TrackParticle& tp) const;

   void addExpectedHitInformation(const Perigee* perigee, xAOD::TrackParticle& tp) const;

   void addOutlierHitInformation(const Trk::TrackStates* trackStates, xAOD::TrackParticle& tp) const;

   void addSharedHitInformation(const Track *track, xAOD::TrackParticle& tp) const;

   static void addDummyEndcapSharedHitInformation(xAOD::TrackParticle& tp) ;
 

  void setDefiningParameters(xAOD::TrackParticle& tp,
                             const Perigee& perigee) const;

  void setParameters(
    const EventContext& ctx,
    xAOD::TrackParticle& tp,
    const std::vector<const Trk::TrackParameters*>& parameters,
    const std::vector<xAOD::ParameterPosition>& positions) const;
 
  static void setTilt(xAOD::TrackParticle& tp, float tiltx, float tilty);
 
  static void setHitPattern(xAOD::TrackParticle& tp, unsigned long hitpattern);
 
  static void setNumberOfUsedHits(xAOD::TrackParticle& tp, int hits);
 
  static void setNumberOfOverflowHits(xAOD::TrackParticle& tp, int overflows);

  static const std::string& trtdEdxUsedHitsAuxName()
  {
    return s_trtdEdxUsedHitsDecorationName;
  }
 
protected:
  xAOD::TrackParticle* createParticle(
    const EventContext& ctx,
    const Perigee* perigee,
    const FitQuality* fq,
    const TrackInfo* trackInfo,
    const TrackSummary* summary,
    const std::vector<const Trk::TrackParameters*>& parameters,
    const std::vector<xAOD::ParameterPosition>& positions,
    xAOD::ParticleHypothesis prtOrigin,
    xAOD::TrackParticleContainer* container,
    const Trk::Track *track) const;
 
private:
  void compare(const Rec::TrackParticle& tp,
               const xAOD::TrackParticle& tpx) const;
  void compare(const TrackParameters& tp1, const TrackParameters& tp2) const;
  const AtlasDetectorID* m_detID;
  const PixelID* m_pixelID;
  const SCT_ID* m_sctID;
  const TRT_ID* m_trtID;
 
  // Need to change to private when is safe to do so
  PublicToolHandle<IExtendedTrackSummaryTool> m_trackSummaryTool{
    this,
    "TrackSummaryTool",
    "Trk::TrackSummaryTool/AtlasTrackSummaryTool"
  };
 
  ToolHandle<Reco::ITrackToVertex> m_trackToVertex{
    this,
    "TrackToVertex",
    "Reco::TrackToVertex/TrackToVertex"
  };
  ToolHandle<Muon::IMuonHitSummaryTool> m_hitSummaryTool{
    this,
    "MuonSummaryTool",
    ""
  };
 
  ServiceHandle<IIBLParameterSvc> m_IBLParameterSvc{
    this,
    "IBLParameterSvc",
    "IBLParameterSvc"
  };
  
  ServiceHandle<ITrackingVolumesSvc> m_trackingVolumesSvc{this,"TrackingVolumesSvc","Trk::TrackingVolumesSvc/TrackingVolumesSvc"};
 
 
  SG::ReadCondHandleKey<AtlasFieldCacheCondObj> m_fieldCacheCondObjInputKey{
    this,
    "AtlasFieldCacheCondObj",
    "fieldCondObj",
    "Name of the Magnetic Field conditions object key"
  };

  ToolHandle<ITRT_ElectronPidTool> m_eProbabilityTool{ this,
                                                       "TRT_ElectronPidTool",
                                                       "",
                                                       "" };

  ToolHandle<IPixelToTPIDTool> m_dedxtool{ this, "PixelToTPIDTool", "", "" };

  ToolHandle<InDet::IInDetTestPixelLayerTool> m_testPixelLayerTool{ this,
                                                                    "TestPixelLayerTool",
                                                                    "",
                                                                    "" };

  StringArrayProperty m_copyExtraSummaryName{this, "ExtraSummaryTypes",
      {"eProbabilityComb",  "eProbabilityHT", "eProbabilityNN",
      "TRTTrackOccupancy", "TRTdEdx",        "TRTdEdxUsedHits"}};

  std::vector<Trk::eProbabilityType> m_copyEProbabilities;

  std::vector<std::pair<SG::AuxElement::Accessor<float>, Trk::eProbabilityType>>
    m_decorateEProbabilities;
  std::vector<std::pair<SG::AuxElement::Accessor<uint8_t>, Trk::SummaryType>>
    m_decorateSummaryTypes;

  static const std::string s_trtdEdxUsedHitsDecorationName;
  static const SG::AuxElement::Accessor<uint8_t> s_trtdEdxUsedHitsDecoration;
 
  bool m_doIBL;
  BooleanProperty m_doITk{this, "DoITk", false};
  BooleanProperty m_computeAdditionalInfo{this, "ComputeAdditionalInfo", false};
  BooleanProperty m_doSharedSiHits    {this, "DoSharedSiHits", false};
  BooleanProperty m_doSharedTRTHits   {this, "DoSharedTRTHits", false};
  BooleanProperty m_runningTIDE_Ambi  {this, "RunningTIDE_Ambi", false};
  BooleanProperty m_updateTrackSummary{this, "UpdateTrackSummary", false};

  BooleanProperty m_keepParameters{this, "KeepParameters", false};
  BooleanProperty m_keepFirstParameters{this, "KeepFirstParameters", false};
  BooleanProperty m_keepAllPerigee{this, "KeepAllPerigee", false};
  // BadCluster ID
  // 0 = off, 1 = OOT, 2 = dE/dx, 3 = combination of OOT and dE/dx, 4 =
  // combination of OOT, dE/dx, and size
  IntegerProperty m_badclusterID{this, "BadClusterID", 0};
 
  StringProperty m_perigeeExpression{this, "PerigeeExpression", "BeamLine"};
  std::vector<std::string> m_perigeeOptions{ "BeamLine",
                                             "BeamSpot",
                                             "Vertex",
                                             "Origin" };
 
  BooleanProperty m_checkConversion{this, "CheckConversion", true};
  IntegerProperty m_minSiHits{this, "MinSiHitsForCaloExtrap", 4};
  DoubleProperty m_minPt{this, "MinPtForCaloExtrap", 1000.};
 
  SG::ReadCondHandleKey<InDet::BeamSpotData> m_beamSpotKey { this, "BeamSpotKey", "BeamSpotData", "SG key for beam spot" };
  SG::ReadHandleKey<Trk::ClusterSplitProbabilityContainer> m_clusterSplitProbContainer{ this, "ClusterSplitProbabilityName", "", "" };
  SG::ReadHandleKey<Trk::PRDtoTrackMap> m_assoMapContainer{ this, "AssociationMapName", ""};
 
  const Trk::ClusterSplitProbabilityContainer::ProbabilityInfo& getClusterSplittingProbability(const InDet::PixelCluster* pix) const;
 
};
 
} // end of namespace Trk
#include "TrkParticleCreator/TrackParticleCreatorTool.icc"
#endif