Tracking/TrkEvent/TrkTrackSummary/TrkTrackSummary/TrackSummary.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2023 CERN for the benefit of the ATLAS collaboration
*/
/***************************************************************************
Summary.h  -  description
-------------------
begin                : Tue Feb 17 2004
email                : edward.moyse@cern.ch
***************************************************************************/
 
#ifndef TRKTRACKSUMMARY_H
#define TRKTRACKSUMMARY_H
 
#include "TrkTrackSummary/MuonTrackSummary.h"
#include "TrkEventPrimitives/TrkObjectCounter.h"
#include <atomic>
#include <bitset>
#include <iostream>
#include <memory>
#include <vector>
 
class MsgStream;
class TrackSummaryCnv_p1;
class TrackSummaryCnv_p2;
 
namespace InDet {
class InDetTrackSummaryHelperTool;
}
 
namespace Muon {
class MuonTrackSummaryHelperTool;
}
 
namespace Trk {
 
// forward declarations
class Track;
class TrackSummaryTool;

enum SummaryType
{
  // --- Inner Detector
 
  numberOfContribPixelLayers = 29,
  numberOfBLayerHits = 0,
  numberOfInnermostPixelLayerHits = 53,
  numberOfNextToInnermostPixelLayerHits = 58,
  numberOfPixelHits = 2,
  numberOfPixelHoles = 1,
  numberOfGangedPixels = 14,
  numberOfGangedFlaggedFakes = 32,
  numberOfPixelDeadSensors = 33,
  numberOfPixelSpoiltHits = 35,
  numberOfDBMHits = 63,
  numberOfSCTHits = 3,
  numberOfSCTHoles = 4,
  numberOfSCTDoubleHoles = 28,
  numberOfSCTDeadSensors = 34,
  numberOfSCTSpoiltHits = 36,
  numberOfTRTHits = 5,
  numberOfTRTOutliers = 19,
  numberOfTRTHoles = 40,
  numberOfTRTHighThresholdHits = 6,
  numberOfTRTHighThresholdHitsTotal = 64,
  numberOfTRTHitsUsedFordEdx = 65,
  numberOfTRTHighThresholdOutliers = 20,
  numberOfTRTDeadStraws = 37,
  numberOfTRTTubeHits = 38,
  numberOfTRTXenonHits = 46,
 
  // --- Muon Spectrometer
  numberOfMdtHits = 7,
  numberOfTgcPhiHits = 8,
  numberOfTgcEtaHits = 9,
  numberOfCscPhiHits = 10,
  numberOfCscEtaHits = 11,
  numberOfRpcPhiHits = 12,
  numberOfRpcEtaHits = 13,
  numberOfCscEtaHoles = 21,
  numberOfCscPhiHoles = 22,
  numberOfRpcEtaHoles = 23,
  numberOfRpcPhiHoles = 24,
  numberOfMdtHoles = 25,
  numberOfTgcEtaHoles = 26,
  numberOfTgcPhiHoles = 27,
 
  // New Small Wheel
  numberOfStgcEtaHits = 67,
  numberOfStgcPhiHits = 68,
  numberOfMmHits = 69,
  numberOfStgcEtaHoles = 70,
  numberOfStgcPhiHoles = 71,
  numberOfMmHoles = 72,
  numberOfCscUnspoiltEtaHits = 45,
  // --- all
  numberOfGoodMdtHits = 66,
  numberOfOutliersOnTrack = 15,
  standardDeviationOfChi2OS = 30,
 
  // reserved: added to keep synchronisation with xAOD::TrackSummary in
  // anticipation of the two being merged
  // in the past used to store  pixel and TRT PID information:
  legacy_eProbabilityComb_res = 47,
  legacy_eProbabilityHT_res = 48,
  legacy_eProbabilityToT_res = 49,
  legacy_eProbabilityBrem_res = 50,
  legacy_pixeldEdx_res = 51,
  legacy_eProbabilityNN_res = 73,
  legacy_TRTTrackOccupancy_res = 74,
  legacy_TRTdEdx_res = 75,
 
  // in the past used to store expected inner layer hits
  legacy_expectBLayerHit = 42,
  legacy_expectInnermostPixelLayerHit = 52,
  legacy_expectNextToInnermostPixelLayerHit = 57,
 
  // in the past used to store shared hits
  legacy_numberOfBLayerSharedHits = 16,
  legacy_numberOfPixelSharedHits = 17,
  legacy_numberOfSCTSharedHits = 18,
  legacy_numberOfBLayerSplitHits = 43,
  legacy_numberOfPixelSplitHits = 44,
  legacy_numberOfInnermostPixelLayerSharedHits = 55,
  legacy_numberOfInnermostLayerSplitHits = 56,
  legacy_numberOfNextToInnermostPixelLayerSharedHits = 60,
  legacy_numberOfNextToInnermostLayerSplitHits = 61,
  legacy_numberOfTRTSharedHits = 62,
 
  // in the past used to store pixel and SCT outliers
  legacy_numberOfBLayerOutliers = 31,
  legacy_numberOfInnermostPixelLayerOutliers = 54,
  legacy_numberOfNextToInnermostPixelLayerOutliers = 59,
  legacy_numberOfPixelOutliers = 41,
  legacy_numberOfSCTOutliers = 39,
 
  // -- numbers...
  numberOfTrackSummaryTypes = 76
};
 
// summary types that are stored as float values or filled in TrackParticleCreatorTool
static const std::vector<unsigned int> unusedSummaryTypes = {
  legacy_eProbabilityComb_res,  legacy_eProbabilityHT_res, legacy_eProbabilityToT_res,
  legacy_eProbabilityBrem_res,  legacy_pixeldEdx_res,      legacy_eProbabilityNN_res,
  legacy_TRTTrackOccupancy_res, legacy_TRTdEdx_res,
  legacy_expectBLayerHit, legacy_expectInnermostPixelLayerHit, legacy_expectNextToInnermostPixelLayerHit,
  legacy_numberOfBLayerSharedHits, legacy_numberOfPixelSharedHits, legacy_numberOfSCTSharedHits,
  legacy_numberOfBLayerSplitHits, legacy_numberOfPixelSplitHits,
  legacy_numberOfInnermostPixelLayerSharedHits, legacy_numberOfInnermostLayerSplitHits,
  legacy_numberOfNextToInnermostPixelLayerSharedHits, legacy_numberOfNextToInnermostLayerSplitHits,
  legacy_numberOfTRTSharedHits,
  legacy_numberOfBLayerOutliers, legacy_numberOfInnermostPixelLayerOutliers, legacy_numberOfNextToInnermostPixelLayerOutliers,
  legacy_numberOfPixelOutliers, legacy_numberOfSCTOutliers,
};
 
// Troels.Petersen@cern.ch:
enum eProbabilityType
{
  eProbabilityComb =
    0, 
  eProbabilityHT =
    1, 
  eProbabilityToT =
    2, 
  eProbabilityBrem = 3,  
  eProbabilityNN = 4,    
  TRTTrackOccupancy = 5, 
  TRTdEdx = 6,           
  eProbabilityNumberOfTRTHitsUsedFordEdx =
    7, 
  numberOfeProbabilityTypes = 8
};
 
static const std::vector<float> eProbabilityDefault(numberOfeProbabilityTypes,
                                                    0.5);

enum DetectorType
{
  pixelBarrel0 = 0, 
  pixelBarrel1 = 1,
  pixelBarrel2 = 2,
  pixelBarrel3 = 3,
 
  pixelEndCap0 = 4, 
  pixelEndCap1 = 5,
  pixelEndCap2 = 6,
 
  sctBarrel0 = 7, 
  sctBarrel1 = 8,
  sctBarrel2 = 9,
  sctBarrel3 = 10,
 
  sctEndCap0 = 11, 
  sctEndCap1 = 12,
  sctEndCap2 = 13,
  sctEndCap3 = 14,
  sctEndCap4 = 15,
  sctEndCap5 = 16,
  sctEndCap6 = 17,
  sctEndCap7 = 18,
  sctEndCap8 = 19,
 
  trtBarrel = 20,
  trtEndCap = 21,
 
  DBM0 = 22,
  DBM1 = 23,
  DBM2 = 24,
 
  numberOfDetectorTypes = 25
 
}; // not complete yet

class TrackSummary final : public Trk::ObjectCounter<Trk::TrackSummary>
{
public:
  friend class InDet::InDetTrackSummaryHelperTool;
  friend class Muon::MuonTrackSummaryHelperTool;
  friend class Trk::TrackSummaryTool;

  static const int SummaryTypeNotSet;

  TrackSummary();

  TrackSummary(const std::vector<int>& information,
               std::bitset<numberOfDetectorTypes>& hitPattern);

  TrackSummary(const TrackSummary& rhs);
  TrackSummary& operator=(const TrackSummary&);
  TrackSummary(TrackSummary&& rhs) noexcept = default;
  TrackSummary& operator=(TrackSummary&&) noexcept = default;
 
  ~TrackSummary();

  TrackSummary& operator+=(const TrackSummary& ts);

  int get(const SummaryType& type) const;
 
  unsigned long getHitPattern() const;

  bool isHit(const DetectorType& type) const;

  const MuonTrackSummary* muonTrackSummary() const;

  MuonTrackSummary* muonTrackSummary();

  bool update(Trk::SummaryType type, int new_value);
 
private: // data members
  friend class ::TrackSummaryCnv_p1;
  friend class ::TrackSummaryCnv_p2;

  std::vector<int> m_information;

  unsigned long m_idHitPattern;

  std::unique_ptr<MuonTrackSummary> m_muonTrackSummary;
};

MsgStream&
operator<<(MsgStream& out, const TrackSummary& trackSum);

std::ostream&
operator<<(std::ostream& out, const TrackSummary& trackSum);
}
#include "TrkTrackSummary/TrackSummary.icc"
 
#endif