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 CLCTKeyStripMasks { kEightStripMask = 0x1, kQuartStripMask = 0x1, kHalfStripMask = 0x1f };
  enum CLCTKeyStripShifts { kEightStripShift = 6, kQuartStripShift = 5, kHalfStripShift = 0 };
  // temporary to facilitate CCLUT-EMTF/OMTF integration studies
  enum CLCTPatternMasks { kRun3SlopeMask = 0xf, kRun3PatternMask = 0x7, kLegacyPatternMask = 0xf };
  enum CLCTPatternShifts { kRun3SlopeShift = 7, kRun3PatternShift = 4, kLegacyPatternShift = 0 };
  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);
  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;
 
  void setPattern(const uint16_t pattern);
 
  uint16_t getRun3Pattern() const;
 
  void setRun3Pattern(const uint16_t pattern);
 
  uint16_t getSlope() const;
 
  void setSlope(const uint16_t slope);
 
  float getFractionalSlope(const uint16_t slope = 4) 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;
 
  void setStrip(const uint16_t strip) { strip_ = strip; }
 
  void setQuartStrip(const bool quartStrip);
 
  bool getQuartStrip() const;
 
  void setEightStrip(const bool eightStrip);
 
  bool getEightStrip() const;
 
  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_; }
 
  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:
  void setDataWord(const uint16_t newWord, uint16_t& word, const unsigned shift, const unsigned mask);
  uint16_t getDataWord(const uint16_t word, const unsigned shift, const unsigned mask) const;
 
  uint16_t valid_;
  uint16_t quality_;
  // In Run-3, the 4-bit pattern number is reinterpreted as the
  // 4-bit bending value. There will be 16 bending values * 2 (left/right)
  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_;
  // In Run-3, the strip number receives two additional bits
  // strip[4:0] -> 1/2 strip value
  // strip[5]   -> 1/4 strip bit
  // strip[6]   -> 1/8 strip bit
  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 in Run-3: 12-bit comparator code
  // set by default to -1 for Run-1 and Run-2 CLCTs
  int16_t compCode_;
  // which hits are in this CLCT?
  ComparatorContainer hits_;
 
  Version version_;
};
 
std::ostream& operator<<(std::ostream& o, const CSCCLCTDigi& digi);
 
#endif