CSCCLCTDigi.h

Go to the documentation of this file.

#ifndef DataFormats_CSCDigi_CSCCLCTDigi_h
#define DataFormats_CSCDigi_CSCCLCTDigi_h

#include <cstdint>
#include <iosfwd>
#include <vector>
#include <limits>

class CSCCLCTDigi {
public:
  typedef std::vector<std::vector<uint16_t>> ComparatorContainer;

  enum class Version { Legacy = 0, Run3 };
  // for data vs emulator studies
  enum CLCTBXMask { kBXDataMask = 0x3 };

  CSCCLCTDigi(const uint16_t valid,
              const uint16_t quality,
              const uint16_t pattern,
              const uint16_t striptype,
              const uint16_t bend,
              const uint16_t strip,
              const uint16_t cfeb,
              const uint16_t bx,
              const uint16_t trknmb = 0,
              const uint16_t fullbx = 0,
              const int16_t compCode = -1,
              const Version version = Version::Legacy,
              const bool run3_quart_strip_bit = false,
              const bool run3_eighth_strip_bit = false,
              const uint16_t run3_pattern = 0,
              const uint16_t run3_slope = 0);

  CSCCLCTDigi();

  void clear();

  bool isValid() const { return valid_; }

  void setValid(const uint16_t valid) { valid_ = valid; }

  uint16_t getQuality() const { return quality_; }

  void setQuality(const uint16_t quality) { quality_ = quality; }

  uint16_t getPattern() const { return pattern_; }

  void setPattern(const uint16_t pattern) { pattern_ = pattern; }

  uint16_t getRun3Pattern() const { return run3_pattern_; }

  void setRun3Pattern(const uint16_t pattern) { run3_pattern_ = pattern; }

  uint16_t getSlope() const { return run3_slope_; }

  void setSlope(const uint16_t slope) { run3_slope_ = slope; }

  float getFractionalSlope() const;

  uint16_t getStripType() const { return striptype_; }

  void setStripType(const uint16_t stripType) { striptype_ = stripType; }

  uint16_t getBend() const { return bend_; }

  void setBend(const uint16_t bend) { bend_ = bend; }

  uint16_t getStrip() const { return strip_; }

  void setStrip(const uint16_t strip) { strip_ = strip; }

  void setQuartStripBit(const bool quartStripBit) { run3_quart_strip_bit_ = quartStripBit; }

  bool getQuartStripBit() const { return run3_quart_strip_bit_; }

  void setEighthStripBit(const bool eighthStripBit) { run3_eighth_strip_bit_ = eighthStripBit; }

  bool getEighthStripBit() const { return run3_eighth_strip_bit_; }

  uint16_t getCFEB() const { return cfeb_; }

  void setCFEB(const uint16_t cfeb) { cfeb_ = cfeb; }

  uint16_t getBX() const { return bx_; }

  uint16_t getBXData() const { return bx_ & kBXDataMask; }

  void setBX(const uint16_t bx) { bx_ = bx; }

  uint16_t getTrknmb() const { return trknmb_; }

  uint16_t getKeyStrip(const uint16_t n = 2) const;

  /*
    Strips are numbered starting from 1 in CMSSW
    Half-strips, quarter-strips and eighth-strips are numbered starting from 0
    The table below shows the correct numbering
    ---------------------------------------------------------------------------------
    strip     |               1               |                 2                   |
    ---------------------------------------------------------------------------------
    1/2-strip |       0       |       1       |       2         |         3         |
    ---------------------------------------------------------------------------------
    1/4-strip |   0   |   1   |   2   |   3   |   4   |    5    |    6    |    7    |
    ---------------------------------------------------------------------------------
    1/8-strip | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 |
    ---------------------------------------------------------------------------------

    Note: the CSC geometry also has a strip offset of +/- 0.25 strips. When comparing the
    CLCT/LCT position with the true muon position, take the offset into account!
   */
  float getFractionalStrip(const uint16_t n = 2) const;

  void setTrknmb(const uint16_t number) { trknmb_ = number; }

  uint16_t getFullBX() const { return fullbx_; }

  void setFullBX(const uint16_t fullbx) { fullbx_ = fullbx; }

  // 12-bit comparator code
  int16_t getCompCode() const { return (isRun3() ? compCode_ : -1); }

  void setCompCode(const int16_t code) { compCode_ = code; }

  // comparator hits in this CLCT
  const ComparatorContainer& getHits() const { return hits_.empty() ? emptyContainer() : hits_; }

  void setHits(const ComparatorContainer& hits) { hits_ = hits; }

  bool operator>(const CSCCLCTDigi&) const;

  bool operator==(const CSCCLCTDigi&) const;

  bool operator!=(const CSCCLCTDigi&) const;

  void print() const;

  bool isRun3() const { return version_ == Version::Run3; }

  void setRun3(bool isRun3);

private:
  static const ComparatorContainer& emptyContainer();
  uint16_t valid_;
  uint16_t quality_;
  // Run-1/2 pattern number.
  // For Run-3 CLCTs, please use run3_pattern_. For some backward
  // compatibility the trigger emulator translates run3_pattern_
  // approximately into pattern_ with a lookup table
  uint16_t pattern_;
  uint16_t striptype_;  // not used since mid-2008
  // Common definition for left/right bending in Run-1, Run-2 and Run-3.
  // 0: right; 1: left
  uint16_t bend_;
  // actually the half-strip number
  uint16_t strip_;
  // There are up to 7 (D)CFEBs in a chamber
  uint16_t cfeb_;
  uint16_t bx_;
  uint16_t trknmb_;
  uint16_t fullbx_;

  // new members in Run-3:

  // 12-bit comparator code
  // set by default to -1 for Run-1 and Run-2 CLCTs
  int16_t compCode_;
  // 1/4-strip bit set by CCLUT (see DN-19-059)
  bool run3_quart_strip_bit_;
  // 1/8-strip bit set by CCLUT
  bool run3_eighth_strip_bit_;
  // In Run-3, the CLCT digi has 3-bit pattern ID, 0 through 4
  uint16_t run3_pattern_;
  // 4-bit bending value. There will be 16 bending values * 2 (left/right)
  uint16_t run3_slope_;

  // which hits are in this CLCT?
  ComparatorContainer hits_;
  Version version_;
};

std::ostream& operator<<(std::ostream& o, const CSCCLCTDigi& digi);

#endif