PFJet.h

Go to the documentation of this file.

#ifndef DataFormats_L1TParticleFlow_PFJet_h
#define DataFormats_L1TParticleFlow_PFJet_h

#include <vector>
#include "DataFormats/L1Trigger/interface/L1Candidate.h"
#include "DataFormats/L1TParticleFlow/interface/PFCandidate.h"
#include "DataFormats/Common/interface/Ptr.h"

namespace l1t {

  class PFJet : public L1Candidate {
  public:
    typedef std::vector<edm::Ptr<l1t::PFCandidate>> Constituents;

    PFJet() {}
    PFJet(float pt, float eta, float phi, float mass = 0, int hwpt = 0, int hweta = 0, int hwphi = 0)
        : L1Candidate(PolarLorentzVector(pt, eta, phi, mass), hwpt, hweta, hwphi, /*hwQuality=*/0), rawPt_(pt) {}

    PFJet(const LorentzVector& p4, int hwpt = 0, int hweta = 0, int hwphi = 0)
        : L1Candidate(p4, hwpt, hweta, hwphi, /*hwQuality=*/0), rawPt_(p4.Pt()) {}

    // change the pt (but doesn't change the raw pt)
    void calibratePt(float newpt);

    // return the raw pT()
    float rawPt() const { return rawPt_; }

    const Constituents& constituents() const { return constituents_; }
    void addConstituent(const edm::Ptr<l1t::PFCandidate>& cand) { constituents_.emplace_back(cand); }

    // candidate interface
    size_t numberOfDaughters() const override { return constituents_.size(); }
    const reco::Candidate* daughter(size_type i) const override { return constituents_[i].get(); }
    using reco::LeafCandidate::daughter;  // avoid hiding the base
    edm::Ptr<l1t::PFCandidate> daughterPtr(size_type i) const { return constituents_[i]; }

    // Get and set the encodedJet_ bits. The Jet is encoded in 128 bits as a 2-element array of uint64_t
    // We store encodings both for Correlator internal usage and for Global Trigger
    enum class HWEncoding { CT, GT };
    typedef std::array<uint64_t, 2> PackedJet;
    const PackedJet& encodedJet(const HWEncoding encoding = HWEncoding::GT) const {
      return encodedJet_[static_cast<int>(encoding)];
    }
    void setEncodedJet(const HWEncoding encoding, const PackedJet jet) {
      encodedJet_[static_cast<int>(encoding)] = jet;
    }

    // Accessors to HW objects with ap_* types from encoded words
    const PackedJet& getHWJetGT() const { return encodedJet(HWEncoding::GT); }
    const PackedJet& getHWJetCT() const { return encodedJet(HWEncoding::CT); }

  private:
    float rawPt_;
    Constituents constituents_;
    std::array<PackedJet, 2> encodedJet_ = {{{{0, 0}}, {{0, 0}}}};
  };

  typedef std::vector<l1t::PFJet> PFJetCollection;
  typedef edm::Ref<l1t::PFJetCollection> PFJetRef;
  typedef std::vector<l1t::PFJetRef> PFJetVectorRef;
}  // namespace l1t
#endif