L1GctJet.h

Go to the documentation of this file.

#ifndef L1GCTJET_H_
#define L1GCTJET_H_

#include <functional>
#include <vector>
#include <ostream>
#include <memory>

#include "DataFormats/L1CaloTrigger/interface/L1CaloRegionDetId.h"
#include <cstdint>

class L1GctJetCand;
class L1GctJetEtCalibrationLut;

class L1GctJet {
public:
  //Statics
  enum numberOfBits { kRawsumBitWidth = 10, kRawsumMaxValue = (1 << kRawsumBitWidth) - 1 };

  //Typedefs
  typedef std::shared_ptr<L1GctJetEtCalibrationLut> lutPtr;

  //Constructors/destructors
  L1GctJet(const uint16_t rawsum = 0,
           const unsigned eta = 0,
           const unsigned phi = 0,
           const bool overFlow = false,
           const bool forwardJet = true,
           const bool tauVeto = true,
           const int16_t bx = 0);
  ~L1GctJet();

  // set rawsum and position bits
  void setRawsum(const uint16_t rawsum) {
    m_rawsum = rawsum & kRawsumMaxValue;
    m_overFlow |= (rawsum > kRawsumMaxValue);
  }
  void setDetId(const L1CaloRegionDetId detId) { m_id = detId; }
  void setOverFlow(const bool overFlow) { m_overFlow = overFlow; }
  void setTauVeto(const bool tauVeto) { m_tauVeto = tauVeto; }
  void setForward(const bool forward) { m_forwardJet = forward; }
  void setBx(const int16_t bx) { m_bx = bx; }

  // get rawsum and position bits
  uint16_t rawsum() const { return m_rawsum; }
  L1CaloRegionDetId id() const { return m_id(); }
  bool tauVeto() const { return m_tauVeto; }

  bool overFlow() const { return m_overFlow; }

  bool isTauJet() const { return (!m_forwardJet && !m_tauVeto); }

  bool isCentralJet() const { return (!m_forwardJet && m_tauVeto); }

  bool isForwardJet() const { return m_forwardJet; }

  bool isNullJet() const { return ((m_rawsum == 0) && (globalEta() == 0) && (globalPhi() == 0)); }

  friend std::ostream& operator<<(std::ostream& os, const L1GctJet& cand);

  bool operator==(const L1GctJet& cand) const;

  bool operator!=(const L1GctJet& cand) const;

  void setupJet(const uint16_t rawsum,
                const unsigned eta,
                const unsigned phi,
                const bool overFlow,
                const bool forwardJet,
                const bool tauVeto = true,
                const int16_t bx = 0);

  unsigned globalEta() const { return m_id.ieta(); }

  unsigned globalPhi() const { return m_id.iphi(); }

  unsigned rctEta() const { return m_id.rctEta(); }

  unsigned rctPhi() const { return m_id.rctPhi(); }

  unsigned hwEta() const;

  unsigned hwPhi() const;

  int16_t bx() const { return m_bx; }

  L1GctJetCand jetCand(const lutPtr lut) const;
  L1GctJetCand jetCand(const std::vector<lutPtr>& luts) const;

  uint16_t rank(const lutPtr lut) const;
  unsigned calibratedEt(const lutPtr lut) const;

private:
  uint16_t m_rawsum;
  L1CaloRegionDetId m_id;
  bool m_overFlow;
  bool m_forwardJet;
  bool m_tauVeto;
  int16_t m_bx;

  uint16_t lutValue(const lutPtr lut) const;
};

std::ostream& operator<<(std::ostream& os, const L1GctJet& cand);

#endif /*L1GCTJET_H_*/