IsolatedTrack.h

Go to the documentation of this file.

#ifndef __DataFormats_PatCandidates_IsolatedTrack_h__
#define __DataFormats_PatCandidates_IsolatedTrack_h__

/*
  \class    pat::IsolatedTrack IsolatedTrack.h "DataFormats/PatCandidates/interface/IsolatedTrack.h"
  \brief Small class to store key info on isolated tracks
   pat::IsolatedTrack stores important info on isolated tracks. Draws from
   packedPFCandidates, lostTracks, and generalTracks.
  \author   Bennett Marsh
*/

#include "DataFormats/Candidate/interface/LeafCandidate.h"
#include "DataFormats/TrackReco/interface/Track.h"
#include "DataFormats/TrackReco/interface/TrackBase.h"
#include "DataFormats/TrackReco/interface/HitPattern.h"
#include "DataFormats/PatCandidates/interface/PackedCandidate.h"
#include "DataFormats/PatCandidates/interface/PFIsolation.h"

namespace pat {

  class IsolatedTrack : public reco::LeafCandidate {
  public:
    IsolatedTrack()
        : LeafCandidate(0, LorentzVector(0, 0, 0, 0)),
          pfIsolationDR03_(pat::PFIsolation()),
          miniIsolation_(pat::PFIsolation()),
          matchedCaloJetEmEnergy_(0.),
          matchedCaloJetHadEnergy_(0.),
          pfLepOverlap_(false),
          pfNeutralSum_(0.),
          dz_(0.),
          dxy_(0.),
          dzError_(0.),
          dxyError_(0.),
          fromPV_(-1),
          trackQuality_(0),
          dEdxStrip_(0),
          dEdxPixel_(0),
          hitPattern_(reco::HitPattern()),
          crossedEcalStatus_(std::vector<uint16_t>()),
          crossedHcalStatus_(std::vector<uint32_t>()),
          deltaEta_(0),
          deltaPhi_(0),
          packedCandRef_(PackedCandidateRef()),
          nearestPFPackedCandRef_(PackedCandidateRef()),
          nearestLostTrackPackedCandRef_(PackedCandidateRef()) {}

    explicit IsolatedTrack(const PFIsolation& iso,
                           const PFIsolation& miniiso,
                           float caloJetEm,
                           float caloJetHad,
                           bool pfLepOverlap,
                           float pfNeutralSum,
                           const LorentzVector& p4,
                           int charge,
                           int id,
                           float dz,
                           float dxy,
                           float dzError,
                           float dxyError,
                           const reco::HitPattern& hp,
                           float dEdxS,
                           float dEdxP,
                           int fromPV,
                           int tkQual,
                           const std::vector<uint16_t>& ecalst,
                           const std::vector<uint32_t>& hcalst,
                           int dEta,
                           int dPhi,
                           const PackedCandidateRef& pcref,
                           const PackedCandidateRef& refToNearestPF,
                           const PackedCandidateRef& refToNearestLostTrack)
        : LeafCandidate(charge, p4, Point(0., 0., 0.), id),
          pfIsolationDR03_(iso),
          miniIsolation_(miniiso),
          matchedCaloJetEmEnergy_(caloJetEm),
          matchedCaloJetHadEnergy_(caloJetHad),
          pfLepOverlap_(pfLepOverlap),
          pfNeutralSum_(pfNeutralSum),
          dz_(dz),
          dxy_(dxy),
          dzError_(dzError),
          dxyError_(dxyError),
          fromPV_(fromPV),
          trackQuality_(tkQual),
          dEdxStrip_(dEdxS),
          dEdxPixel_(dEdxP),
          hitPattern_(hp),
          crossedEcalStatus_(ecalst),
          crossedHcalStatus_(hcalst),
          deltaEta_(dEta),
          deltaPhi_(dPhi),
          packedCandRef_(pcref),
          nearestPFPackedCandRef_(refToNearestPF),
          nearestLostTrackPackedCandRef_(refToNearestLostTrack) {}

    ~IsolatedTrack() override {}

    const PFIsolation& pfIsolationDR03() const { return pfIsolationDR03_; }

    const PFIsolation& miniPFIsolation() const { return miniIsolation_; }

    float matchedCaloJetEmEnergy() const { return matchedCaloJetEmEnergy_; }
    float matchedCaloJetHadEnergy() const { return matchedCaloJetHadEnergy_; }

    bool pfLepOverlap() const { return pfLepOverlap_; }
    float pfNeutralSum() const { return pfNeutralSum_; }

    float dz() const { return dz_; }
    float dzError() const override { return dzError_; }
    float dxy() const { return dxy_; }
    float dxyError() const override { return dxyError_; }

    int fromPV() const { return fromPV_; }

    bool isHighPurityTrack() const {
      return (trackQuality_ & (1 << reco::TrackBase::highPurity)) >> reco::TrackBase::highPurity;
    }
    bool isTightTrack() const { return (trackQuality_ & (1 << reco::TrackBase::tight)) >> reco::TrackBase::tight; }
    bool isLooseTrack() const { return (trackQuality_ & (1 << reco::TrackBase::loose)) >> reco::TrackBase::loose; }

    const reco::HitPattern& hitPattern() const { return hitPattern_; }

    int lostInnerLayers() const {
      return hitPattern_.trackerLayersWithoutMeasurement(reco::HitPattern::MISSING_INNER_HITS);
    }
    int lostLayers() const { return hitPattern_.trackerLayersWithoutMeasurement(reco::HitPattern::TRACK_HITS); }
    int lostOuterLayers() const {
      return hitPattern_.trackerLayersWithoutMeasurement(reco::HitPattern::MISSING_OUTER_HITS);
    }

    float dEdxStrip() const { return dEdxStrip_; }
    float dEdxPixel() const { return dEdxPixel_; }

    const std::vector<uint16_t>& crossedEcalStatus() const { return crossedEcalStatus_; }
    const std::vector<uint32_t>& crossedHcalStatus() const { return crossedHcalStatus_; }

    float deltaEta() const { return float(deltaEta_) / 500.f; }
    float deltaPhi() const { return float(deltaPhi_) / 500.f; }

    const PackedCandidateRef& packedCandRef() const { return packedCandRef_; }
    const PackedCandidateRef& nearestPFPackedCandRef() const { return nearestPFPackedCandRef_; }
    const PackedCandidateRef& nearestLostTrackPackedCandRef() const { return nearestPFPackedCandRef_; }

  protected:
    PFIsolation pfIsolationDR03_;
    PFIsolation miniIsolation_;
    float matchedCaloJetEmEnergy_;  //energy of nearest calojet within a given dR;
    float matchedCaloJetHadEnergy_;
    bool pfLepOverlap_;
    float pfNeutralSum_;
    float dz_, dxy_, dzError_, dxyError_;
    int fromPV_;  //only stored for packedPFCandidates
    int trackQuality_;
    float dEdxStrip_, dEdxPixel_;  //in MeV/mm

    reco::HitPattern hitPattern_;

    std::vector<uint16_t> crossedEcalStatus_;
    std::vector<uint32_t> crossedHcalStatus_;
    int deltaEta_, deltaPhi_;

    PackedCandidateRef packedCandRef_;  // stored only for packedPFCands/lostTracks. NULL for generalTracks
    PackedCandidateRef nearestPFPackedCandRef_;
    PackedCandidateRef nearestLostTrackPackedCandRef_;
  };

  typedef std::vector<IsolatedTrack> IsolatedTrackCollection;

}  // namespace pat

#endif