TrackingPrimitives.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
 
/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
// $Id: xAODPrimitives.h 576255 2013-12-19 12:54:41Z emoyse $
#ifndef XAODTRACKING_XAODPRIMITIVES_H
#define XAODTRACKING_XAODPRIMITIVES_H
 
// EDM include(s):
#include "EventPrimitives/EventPrimitives.h"
#include "xAODMeasurementBase/EigenZeroDefs.h"
#include "AthContainers/tools/AuxDataTraits.h"
#include "CxxUtils/checker_macros.h"
 
#ifndef AmgMatrixDef
#define AmgMatrixDef
#define AmgMatrix(col, row) Eigen::Matrix<double,col,row,0,col,row>
#define AmgSymMatrix(dim) Eigen::Matrix<double,dim,dim,0,dim,dim>
#endif
 
#ifndef AmgVectorDef
#define AmgVectorDef
#define AmgVector(col) Eigen::Matrix<double, col, 1, 0, col, 1>
#define AmgRowVector(row) Eigen::Matrix<double, 1, row, 0, 1, row>
#endif
 
namespace xAOD {
 
  //typedef ROOT::Math::SMatrix<float,5,5,ROOT::Math::MatRepSym<float,5> >     ParametersCovMatrix_t;
  //typedef ROOT::Math::SVector<float,5>                                       DefiningParameters_t;
  //typedef ROOT::Math::SVector<float,6>                                       CurvilinearParameters_t;
  typedef AmgSymMatrix(5)                                                       ParametersCovMatrix_t;
  typedef Eigen::Matrix< bool, 5, 5, 0, 5, 5 >                                  ParametersCovMatrixFilled_t;
  typedef AmgVector(5)                                                          DefiningParameters_t;
  typedef AmgVector(6)                                                          CurvilinearParameters_t;
  enum TrackFitter
  {
    Unknown        = 0,
      iPatTrackFitter      = 1,
      xKalman        = 2,
      KalmanFitter       = 3,
      GaussianSumFilter      = 4,
      GlobalChi2Fitter       = 5,
      DistributedKalmanFilter    = 6,
      DeterministicAnnealingFilter = 7,
      KalmanDNAFitter            = 8,
      MuonboyFitter                = 9,
      NumberOfTrackFitters     = 10
  };
 
  enum TrackProperties
  {
      BremFit         = 1,
      BremFitSuccessful       = 2,
      StraightTrack       = 3,
      SlimmedTrack      = 4,
      HardScatterOrKink       = 5,
      LowPtTrack        = 6,
      NumberOfTrackProperties = 7
  };
 
  enum TrackPatternRecoInfo
  {
    SiSPSeededFinder             = 0,
    SiCTBTracking                = 1,
    InDetAmbiguitySolver         = 2,
    InDetExtensionProcessor      = 3,
    TRTSeededTrackFinder         = 4,
    Muonboy                      = 5,
    MuGirlUnrefitted             = 6,
    STACO                        = 7,
    StacoLowPt                   = 8,
    MuTag                        = 9,
    MooreToTrackTool             = 10,
    TrigIDSCAN                   = 11,
    TrigSiTrack                  = 12,
    TrigTRTxK                    = 13,
    TrigTRTLUT                   = 14,
    Fatras                       = 15,
    iPatLegacyCnv                = 16,
    xKalmanLegacyCnv             = 17,
    SimpleAmbiguityProcessorTool = 18,
    InDetAmbiTrackSelectionTool  = 19,
    TRTStandalone                = 20,
    MuidStandAlone               = 21,
    TRTSeededSingleSpTrackFinder = 22,
    MooreLegacyCnv               = 23,
    MuidComb                     = 24,
    Moore                        = 25,
    MuidCombined           = 26,
    MuidVertexAssociator         = 27,
    MuGirl                       = 28,
    iPatRec                      = 29,
    MuGirlLowBeta                = 30,
    FatrasSimulation             = 31,
    ReverseOrderedTrack         = 32,
    MuonNotHittingTileVolume    = 33,
    SiSpacePointsSeedMaker_Cosmic          = 34,
    SiSpacePointsSeedMaker_HeavyIon        = 35,
    SiSpacePointsSeedMaker_LowMomentum     = 36,
    SiSpacePointsSeedMaker_BeamGas         = 37,
    SiSpacePointsSeedMaker_VeryLowMomentum = 38,
    MuidMuonRecoveryTool        = 39,
    MuidStandaloneRefit         = 40,
    TrackInCaloROI              = 41,
    SiSpacePointsSeedMaker_ForwardTracks   = 42,
    strategyA                              = 43,
    strategyB                              = 44,
    strategyC                              = 45,
    FTK                                    = 46,
    FastTrackFinderSeed                    = 47,
    //    for tracks processed by the trigger version of the SiSPSeededFinder
    SiSPSeededFinderSimple                 = 48,
    // Large d0 for displaced vertex searches
    SiSpacePointsSeedMaker_LargeD0         = 49,
    // ITkConversion Track flag
    SiSpacePointsSeedMaker_ITkConversionTracks = 50,
    // Pseudotracking
    Pseudotracking               = 51,
    NumberOfTrackRecoInfo                  = 52
  };
 
  enum ParticleHypothesis { nonInteracting  = 0,
    geantino        = 0,
    electron        = 1,
    muon            = 2,
    pion            = 3,
    kaon            = 4,
    proton          = 5,
    photon          = 6,  
    neutron         = 7,  
    pi0             = 8, 
    k0              = 9, 
    nonInteractingMuon = 10, 
    noHypothesis    = 99,
    undefined       = 99
  };

  enum ParameterPosition {
    BeamLine,
    FirstMeasurement,
    LastMeasurement,
    CalorimeterEntrance,
    CalorimeterExit,
    MuonSpectrometerEntrance
  };
 

  enum SummaryType {
    // --- Inner Detector
    numberOfContribPixelLayers      =29,  
    numberOfBLayerHits              = 0,  
    numberOfBLayerOutliers          =31,  
    numberOfBLayerSharedHits        =16,  
    numberOfBLayerSplitHits         =43,  
    expectBLayerHit                 =42,  
    expectInnermostPixelLayerHit                 =52,  
    numberOfInnermostPixelLayerHits              =53,  
    numberOfInnermostPixelLayerOutliers          =54,  
    numberOfInnermostPixelLayerSharedHits        =55,  
    numberOfInnermostPixelLayerSplitHits         =56,  
 
    numberOfInnermostPixelLayerEndcapHits        =77,  
    numberOfInnermostPixelLayerEndcapOutliers    =80,  
    numberOfInnermostPixelLayerSharedEndcapHits  =81,  
    numberOfInnermostPixelLayerSplitEndcapHits   =82,  
 
    expectNextToInnermostPixelLayerHit                 =57,  
    numberOfNextToInnermostPixelLayerHits              =58,  
    numberOfNextToInnermostPixelLayerOutliers          =59,  
    numberOfNextToInnermostPixelLayerSharedHits        =60,  
    numberOfNextToInnermostPixelLayerSplitHits         =61,  
 
    numberOfNextToInnermostPixelLayerEndcapHits        =78,  
    numberOfNextToInnermostPixelLayerEndcapOutliers    =83,  
    numberOfNextToInnermostPixelLayerSharedEndcapHits  =84,  
    numberOfNextToInnermostPixelLayerSplitEndcapHits   =85,  
 
    numberOfDBMHits                 = 63, 
    numberOfPixelHits               = 2,  
    numberOfPixelOutliers           =41,  
    numberOfPixelHoles              = 1,  
    numberOfPixelSharedHits         =17,  
    numberOfPixelSplitHits          =44,  
    numberOfGangedPixels            =14,  
    numberOfGangedFlaggedFakes      =32,  
    numberOfPixelDeadSensors        =33,  
    numberOfPixelSpoiltHits         =35,  
    numberOfSCTHits                 = 3,  
    numberOfSCTOutliers             =39,  
    numberOfSCTHoles                = 4,  
    numberOfSCTDoubleHoles          =28,  
    numberOfSCTSharedHits           =18,  
    numberOfSCTDeadSensors          =34,  
    numberOfSCTSpoiltHits           =36,  
    numberOfTRTHits                 = 5,  
    numberOfTRTOutliers             =19,  
    numberOfTRTHoles                =40,  
    numberOfTRTHighThresholdHits    = 6,  
    numberOfTRTHighThresholdHitsTotal= 64,  
    //    numberOfTRTHitsUsedFordEdx      = 65, //!< number of TRT hits used for dE/dx computation
    numberOfTRTHighThresholdOutliers=20,  
    numberOfTRTDeadStraws           =37,  
    numberOfTRTTubeHits             =38,  
    numberOfTRTXenonHits            =46,  
    numberOfTRTSharedHits           =62,  
 
    // --- Muon Spectrometer
    numberOfPrecisionLayers = 7,       
    numberOfPrecisionHoleLayers = 8,   
    numberOfPhiLayers = 9,             
    numberOfPhiHoleLayers = 10,        
    numberOfTriggerEtaLayers = 11,     
    numberOfTriggerEtaHoleLayers = 12, 
    numberOfGoodPrecisionLayers = 66,  
 
    // --- all
    numberOfOutliersOnTrack         =15,  
    standardDeviationOfChi2OS       = 30, 
    // --- float values
    eProbabilityComb                = 47, 
    eProbabilityHT                  = 48, 
    // removed:   eProbabilityToT                 = 49, //!< Electron probability from Time-Over-Threshold (ToT) information [float].    
    // removed:   eProbabilityBrem                = 50, //!< Electron probability from Brem fitting (DNA) [float].  
    pixeldEdx                       = 51, 
    TRTTrackOccupancy               = 67,  
 
    // New ITk SummaryTypes, not inherited from Trk::TrkSummary
    numberOfContribPixelBarrelFlatLayers     = 68,  
    numberOfContribPixelBarrelInclinedLayers = 69,  
    numberOfContribPixelEndcap               = 70,  
    numberOfPixelBarrelFlatHits              = 71,  
    numberOfPixelBarrelInclinedHits          = 72,  
    numberOfPixelEndcapHits                  = 73,  
    numberOfPixelBarrelFlatHoles             = 74,  
    numberOfPixelBarrelInclinedHoles         = 75,  
    numberOfPixelEndcapHoles                 = 76,  
 
    // -- numbers...
    numberOfTrackSummaryTypes       = 86
  };

  enum MuonSummaryType {
 
    // global hit counts
    primarySector = 0,                 
    secondarySector = 1,               
 
    innerSmallHits = 2,        
    innerLargeHits = 3,        
    middleSmallHits = 4,      
    middleLargeHits = 5,      
    outerSmallHits = 6,      
    outerLargeHits = 7,       
    extendedSmallHits = 8,    
    extendedLargeHits = 9,    
 
    innerSmallHoles = 10,       
    innerLargeHoles = 11,       
    middleSmallHoles = 12,      
    middleLargeHoles = 13,      
    outerSmallHoles = 14,      
    outerLargeHoles = 15,       
    extendedSmallHoles = 16,    
    extendedLargeHoles = 17,    
 
    phiLayer1Hits = 18,         
    phiLayer2Hits = 19,         
    phiLayer3Hits = 20,         
    phiLayer4Hits = 21,         
 
    etaLayer1Hits = 22,         
    etaLayer2Hits = 23,         
    etaLayer3Hits = 24,         
    etaLayer4Hits = 25,         
 
    phiLayer1Holes = 26,         
    phiLayer2Holes = 27,         
    phiLayer3Holes = 28,         
    phiLayer4Holes = 29,         
 
    etaLayer1Holes = 30,         
    etaLayer2Holes = 31,         
    etaLayer3Holes = 32,         
    etaLayer4Holes = 33,         
 
    innerClosePrecisionHits = 34,         
    middleClosePrecisionHits = 35,        
    outerClosePrecisionHits = 36,         
    extendedClosePrecisionHits = 37,      
 
    innerOutBoundsPrecisionHits = 38,     
    middleOutBoundsPrecisionHits = 39,    
    outerOutBoundsPrecisionHits = 40,     
    extendedOutBoundsPrecisionHits = 41,  
    combinedTrackOutBoundsPrecisionHits = 42, 
 
    isEndcapGoodLayers = 43,                
    isSmallGoodSectors = 44,                
 
    phiLayer1RPCHits  = 45,  
    phiLayer2RPCHits  = 46,  
    phiLayer3RPCHits  = 47,  
    phiLayer4RPCHits  = 48,  
 
    etaLayer1RPCHits  = 49,  
    etaLayer2RPCHits  = 50,  
    etaLayer3RPCHits  = 51,  
    etaLayer4RPCHits  = 52,  
 
    phiLayer1RPCHoles = 53,  
    phiLayer2RPCHoles = 54,  
    phiLayer3RPCHoles = 55,  
    phiLayer4RPCHoles = 56,  
 
    etaLayer1RPCHoles = 57,  
    etaLayer2RPCHoles = 58,  
    etaLayer3RPCHoles = 59,  
    etaLayer4RPCHoles = 60,  
 
    phiLayer1TGCHits  = 61,  
    phiLayer2TGCHits  = 62,  
    phiLayer3TGCHits  = 63,  
    phiLayer4TGCHits  = 64,  
 
    etaLayer1TGCHits  = 65,  
    etaLayer2TGCHits  = 66,  
    etaLayer3TGCHits  = 67,  
    etaLayer4TGCHits  = 68,  
 
    phiLayer1TGCHoles = 69,  
    phiLayer2TGCHoles = 70,  
    phiLayer3TGCHoles = 71,  
    phiLayer4TGCHoles = 72,  
 
    etaLayer1TGCHoles = 73,  
    etaLayer2TGCHoles = 74,  
    etaLayer3TGCHoles = 75,  
    etaLayer4TGCHoles = 76,  
 
    // New Small Wheel
    //STGC
    phiLayer1STGCHits  = 79,  
    phiLayer2STGCHits  = 80,  
 
    etaLayer1STGCHits  = 81,  
    etaLayer2STGCHits  = 82,  
 
    phiLayer1STGCHoles = 83,  
    phiLayer2STGCHoles = 84,  
 
    etaLayer1STGCHoles = 85,  
    etaLayer2STGCHoles = 86,  
 
    //MM
    MMHits = 87,
    MMHoles = 88,
    // Note: there is currently no MuonStationIndex for the two MM layers
    // In the future it might be needed to add them in order to have 
    // separate counters as follows
    // Layer1MMHits  = 87,  //!< number of eta hits  in the first  MM layer
    // Layer2MMHits  = 88,  //!< number of eta hits  in the second MM layer
    // Layer1MMHoles = 89,  //!< number of eta holes in the first  MM layer
    // Layer2MMHoles = 90,  //!< number of eta holes in the second MM layer
 
 
    //CSC debugging
    cscEtaHits = 77,           
    cscUnspoiledEtaHits = 78,  
 
    // -- numbers...
    numberOfMuonSummaryTypes       = 89
  };
 
  // Enums for rejection locations
  enum RejectionStep {
    // Rejections within DenseEnvironmentsAmbiguityProcessorTool::solveTracks
    solveTracks,
    // Rejections within DenseEnvironmentsAmbiguityScoreProcessorTool::addNewTracks
    addNewTracks,
    // Rejections within AmbiguityProcessorBase::refitTrack
    refitTrack,
    // Rejections within AmbiguityProcessorBase::addTrack
    addTrack,
    // Rejections within InDetDenseEnvAmbiTrackSelectionTool::decideWhichHitsToKeep
    decideWhichHitsToKeep,
    // Rejections within InDetDenseEnvAmbiTrackSelectionTool::getCleanedOutTrack
    getCleanedOutTrack
  };
  enum RejectionReason {
    acceptedTrack,
    // Reason for rejection within DenseEnvironmentsAmbiguityProcessorTool::solveTracks
    stillBeingProcessed,
    // Reason for rejection within DenseEnvironmentsAmbiguityScoreProcessorTool::addNewTracks
    trackScoreZero,
    duplicateTrack,
    // Reason for rejection within AmbiguityProcessorBase::refitTrack
    subtrackCreated,
    refitFailed,
    // Reason for rejection within AmbiguityProcessorBase::addTrack
    bremRefitFailed,
    bremRefitSubtrackCreated,
    bremRefitTrackScoreZero,
    refitTrackScoreZero,
    // Reason for rejection within decideWhichHitsToKeep
    TSOSRejectedHit,
    TSOSOutlierShared,
    pixelSplitButTooManyShared2Ptc,
    pixelSplitButTooManyShared3Ptc,
    tooManySharedRecoverable,
    tooManySharedNonRecoverable,
    sharedSCT,
    sharedHitsBadChi2,
    sharedHitsNotEnoughUniqueHits,
    firstHitSharedAndPixIBL,
    firstHitSharedAndExtraShared,
    sharedHitsNotEnoughUniqueSiHits,
    sharedIBLSharedWithNoIBLTrack,
    sharedPixelSharedWithDifferentIBLTrack,
    tooManySharedAfterIncreasingShared,
    // Reason for rejection within getCleanedOutTrack
    notEnoughSiHits,
    notEnoughTRTHits,
    notEnoughUniqueSiHits,
    tooFewHits,
    failedSubtrackCreation,
    subtrackCreatedWithRecoveredShared,
    other
  };
  enum ObserverToolIndex {
    track,
    score,
    rejectStep,
    rejectReason,
    parentId,
    numPixelHoles,
    numSCTHoles,
    numSplitSharedPixel,
    numSplitSharedSCT,
    numSharedOrSplit,
    numSharedOrSplitPixels,
    numShared,
    isPatternTrack,
    totalSiHits,
    inROI,
    hasIBLHit,
    hasSharedIBLHit,
    hasSharedPixel,
    firstPixIsShared,
    numPixelDeadSensor,
    numSCTDeadSensor,
    numPixelHits,
    numSCTHits,
    numUnused,
    numTRT_Unused,
    numSCT_Unused,
    numPseudo,
    averageSplit1,
    averageSplit2,
    numWeightedShared,
    rejectStep_full,
    rejectReason_full,
  };
 

  enum SurfaceType {
    Cone = 0,
    Cylinder = 1,
    Disc = 2,
    Perigee = 3,
    Plane = 4,
    Straw = 5,
    Curvilinear = 6,
    Other = 7
  };

  namespace VxType {
    enum VertexType {
      NoVtx   = 0, 
        PriVtx  = 1, 
        SecVtx  = 2, 
        PileUp  = 3, 
        ConvVtx = 4, 
        V0Vtx   = 5, 
        KinkVtx = 6, 
        NotSpecified = -99 
    };
  } // namespace VxType
} //  namespace xAOD 
 

inline xAOD::ParametersCovMatrixFilled_t makeFullCovMatrix() {
  xAOD::ParametersCovMatrixFilled_t result;
  result.setOnes();
  return result;
}

inline xAOD::ParametersCovMatrixFilled_t makeDiagCovMatrix() {
  xAOD::ParametersCovMatrixFilled_t result;
  for( int i = 0; i < result.rows(); ++i ) {
    result( i, i ) = true;
  }
  return result;
}
 
namespace xAOD {

  static const xAOD::ParametersCovMatrixFilled_t FullCovMatrixAvailable =
    makeFullCovMatrix();
  static const xAOD::ParametersCovMatrixFilled_t DiagCovMatrixAvailable =
    makeDiagCovMatrix();
 
} // namespace xAOD
 
 
#endif // XAODTRACKING_XAODPRIMITIVES_H