L1CaloRegion.h

Go to the documentation of this file.

#ifndef L1CALOREGION_H
#define L1CALOREGION_H

#include <ostream>

#include "DataFormats/L1CaloTrigger/interface/L1CaloRegionDetId.h"

class L1CaloRegion {
public:
  L1CaloRegion();

  L1CaloRegion(
      unsigned et, bool overFlow, bool tauVeto, bool mip, bool quiet, unsigned crate, unsigned card, unsigned rgn);

  L1CaloRegion(unsigned et, bool fineGrain, unsigned crate, unsigned rgn);

  L1CaloRegion(unsigned et, bool overFlow, bool fineGrain, bool mip, bool quiet, unsigned ieta, unsigned iphi);

  L1CaloRegion(uint16_t data, unsigned ieta, unsigned iphi, int16_t bx);

  ~L1CaloRegion();

  // named ctors

  static L1CaloRegion makeHBHERegion(const unsigned et,
                                     const bool overFlow,
                                     const bool tauVeto,
                                     const bool mip,
                                     const bool quiet,
                                     const unsigned crate,
                                     const unsigned card,
                                     const unsigned rgn);

  static L1CaloRegion makeHFRegion(const unsigned et, const bool fineGrain, const unsigned crate, const unsigned rgn);

  static L1CaloRegion makeRegionFromGctIndices(const unsigned et,
                                               const bool overFlow,
                                               const bool fineGrain,
                                               const bool mip,
                                               const bool quiet,
                                               const unsigned ieta,
                                               const unsigned iphi);
  static L1CaloRegion makeRegionFromUnpacker(const uint16_t data,
                                             const unsigned ieta,
                                             const unsigned iphi,
                                             const uint16_t block,
                                             const uint16_t index,
                                             const int16_t bx);

  static L1CaloRegion makeGctJetRegion(const unsigned et,
                                       const bool overFlow,
                                       const bool fineGrain,
                                       const unsigned ieta,
                                       const unsigned iphi,
                                       const int16_t bx);

  // get/set methods for the data

  void reset() { m_data = 0; }

  uint16_t raw() const { return m_data; }

  unsigned et() const { return (isHf() ? m_data & 0xff : m_data & 0x3ff); }

  unsigned etFullScale() const { return m_data & 0xfff; }

  bool overFlow() const { return ((m_data >> 10) & 0x1) != 0; }

  bool tauVeto() const { return (isHf() ? false : fineGrain()); }

  bool fineGrain() const { return ((m_data >> 11) & 0x1) != 0; }

  bool mip() const { return ((m_data >> 12) & 0x1) != 0; }

  bool quiet() const { return ((m_data >> 13) & 0x1) != 0; }

  void setCaptureBlock(uint16_t capBlock) { m_captureBlock = capBlock; }

  void setCaptureIndex(uint16_t capIndex) { m_captureIndex = capIndex; }

  void setBx(int16_t bx);

  void setRawData(uint32_t data) { m_data = data; }

  void setMip(bool mip);

  void setQuiet(bool quiet);

  // get methods for the geographical information

  L1CaloRegionDetId id() const { return m_id; }

  bool isHf() const { return m_id.isHf(); }
  bool isHbHe() const { return !m_id.isHf(); }

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

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

  unsigned rctRegionIndex() const { return m_id.rctRegion(); }

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

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

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

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

  unsigned capBlock() const { return m_captureBlock; }

  unsigned capIndex() const { return m_captureIndex; }

  int16_t bx() const { return m_bx; }

  int operator==(const L1CaloRegion& c) const {
    return ((m_data == c.raw() && m_id == c.id()) || (this->empty() && c.empty()));
  }

  int operator!=(const L1CaloRegion& c) const { return !(*this == c); }

  bool empty() const { return (m_data == 0); }

  friend std::ostream& operator<<(std::ostream& os, const L1CaloRegion& reg);

private:
  void setRegionId(L1CaloRegionDetId id) { m_id = id; }

  void pack(unsigned et, bool overFlow, bool fineGrain, bool mip, bool quiet);

  void pack12BitsEt(unsigned et, bool overFlow, bool fineGrain, bool mip, bool quiet);

  L1CaloRegionDetId m_id;

  uint16_t m_data;
  uint16_t m_captureBlock;
  uint8_t m_captureIndex;
  int16_t m_bx;
};

#endif /*L1CALOREGION_H*/