MuonTrackSummary.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef TRK_MUONTRACKSUMMARY_H
#define TRK_MUONTRACKSUMMARY_H
 
#include "Identifier/Identifier.h"
 
class MsgStream;
class MuonTrackSummaryCnv_p1;
class MuonTrackSummaryCnv_p2;
class TrackSummaryCnv_p2;
 
namespace Muon {
class MuonTrackSummaryHelperTool;
}
 
namespace Trk {

class MuonTrackSummary
{
public:
  friend class Muon::MuonTrackSummaryHelperTool;

  struct ChamberHitSummary
  {
    friend class Muon::MuonTrackSummaryHelperTool;

    struct Projection
    {
      Projection() {}
      int nhits{ 0 };      //<! number of hits on track in the projection
      int nholes{ 0 };     //<! number of holes in the projection
      int noutliers{ 0 };  //<! number of outliers in the projection
      int ndeltas{ 0 };    //<! number of delta electrons in the projection (only filled for MDT chambers)
      int ncloseHits{ 0 }; //<! number of hits within a road around the track in the projection
      int ngoodHits{ 0 };  //<! number of hits that matter for the track
      int noutBounds{ 0 }; //<! number of out-of-bounds hits
    };

    ChamberHitSummary(Identifier chID, bool isMdtTube)
      : m_chId(chID)
      , m_isMdt(isMdtTube)
    {}

    const Identifier& chamberId() const { return m_chId; }

    bool isMdt() const { return m_isMdt; }

    int nhits() const { return m_first.nhits + m_second.nhits; }

    int nholes() const { return m_first.nholes + m_second.nholes; }

    int noutliers() const { return m_first.noutliers + m_second.noutliers; }

    int ndeltas() const { return m_first.ndeltas + m_second.ndeltas; }

    int ncloseHits() const { return m_first.ncloseHits + m_second.ncloseHits; }

    int ngoodHits() const { return m_first.ngoodHits + m_second.ngoodHits; }
 
    // returns the number of out of bounds hits
    int noutBoundsHits() const { return m_first.noutBounds + m_second.noutBounds; }

    int netaHits() const { return isMdt() ? nhits() : m_first.nhits; }

    int nphiHits() const { return isMdt() ? 0 : m_second.nhits; }

    int nMdtHitsMl1() const { return isMdt() ? m_first.nhits : 0; }

    int nMdtHitsMl2() const { return isMdt() ? m_second.nhits : 0; }

    const Projection& mdtMl1() const { return m_first; }

    const Projection& mdtMl2() const { return m_second; }

    const Projection& etaProjection() const { return m_first; }

    const Projection& phiProjection() const { return m_second; }
 
  private:
    friend class ::MuonTrackSummaryCnv_p1;
    friend class ::MuonTrackSummaryCnv_p2;
    friend class ::TrackSummaryCnv_p2;
 
    Identifier m_chId{ 0 }; //<! chamber identifier
    bool m_isMdt{ false };  //<! is this a MDT chamber
 
    Projection m_first;  //<! eta projections for cluster chambers, first multi layer for mdt chambers
    Projection m_second; //<! phi projections for cluster chambers, first multi layer for mdt chambers
  };

  MuonTrackSummary();

  ~MuonTrackSummary();

  unsigned int netaHits() const;

  unsigned int nphiHits() const;

  unsigned int noutliers() const;

  unsigned int nholes() const;

  unsigned int ncloseHits() const;

  unsigned int nscatterers() const { return m_nscatterers; }

  unsigned int npseudoMeasurements() const { return m_npseudoMeasurements; }

  const std::vector<ChamberHitSummary>& chamberHitSummary() const { return m_chamberHitSummary; }
 
private:
  friend class ::MuonTrackSummaryCnv_p1;
  friend class ::MuonTrackSummaryCnv_p2;
  friend class ::TrackSummaryCnv_p2;
 
  unsigned int m_nscatterers;                         //<! number of scattering centres on the track
  unsigned int m_npseudoMeasurements;                 //<! number of pseudomeasurements on the track
  std::vector<ChamberHitSummary> m_chamberHitSummary; //<! vector with chamber hit summaries
};

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

std::ostream&
operator<<(std::ostream& out, const MuonTrackSummary& trackSum);
 
}
#endif