Use CSCConstants in CSC trigger, packer, unpacker and track-finders

DataFormats/CSCDigi/interface/CSCComparatorDigi.h

@@ -1,10 +1,10 @@
-#ifndef CSCComparatorDigi_CSCComparatorDigi_h
-#define CSCComparatorDigi_CSCComparatorDigi_h
+#ifndef DataFormats_CSCDigi_CSCComparatorDigi_h
+#define DataFormats_CSCDigi_CSCComparatorDigi_h
 
 /** \class CSCComparatorDigi
  *
  * Digi for CSC Comparators.
- *  
+ *
  *
  * \author M. Schmitt, Northwestern
  *
@@ -28,9 +28,15 @@ class CSCComparatorDigi {
   /// sort by time first, then by strip
   bool operator<(const CSCComparatorDigi& digi) const;
 
+  /// Get the distrip number. Counts from 0.
+  int getDiStrip() const;
+
   /// Get the strip number. Counts from 1.
   int getStrip() const { return strip_; }
 
+  /// Get the CFEB number. Counts from 0.
+  int getCFEB() const;
+
   /// Get Comparator readings. Can be 0 or 1.
   int getComparator() const { return comparator_; }
 

DataFormats/CSCDigi/interface/CSCConstants.h

@@ -0,0 +1,133 @@
+#ifndef DataFormats_CSCDigi_CSCConstants_h
+#define DataFormats_CSCDigi_CSCConstants_h
+
+/**
+ * \class CSCConstants
+ *
+ * Static interface to basic chamber constants.
+ */
+
+class CSCConstants {
+public:
+  enum DDU_Info { NUM_DDUS = 5 };
+
+  enum CFEB_Info {
+    // Run-1: Maximum number of cathode front-end boards
+    MAX_CFEBS_RUN1 = 5,
+    // ME1/1 cases
+    NUM_CFEBS_ME1A_GANGED = 1,
+    NUM_CFEBS_ME1A_UNGANGED = 3,
+    NUM_CFEBS_ME1B = 4,
+    NUM_CFEBS_ME11_GANGED = NUM_CFEBS_ME1A_GANGED + NUM_CFEBS_ME1B,      // 5
+    NUM_CFEBS_ME11_UNGANGED = NUM_CFEBS_ME1A_UNGANGED + NUM_CFEBS_ME1B,  // 7
+    // Run-2: Maximum number of cathode front-end boards
+    MAX_CFEBS_RUN2 = NUM_CFEBS_ME11_UNGANGED,  // 7
+  };
+
+  enum FPGA_Latency { CLCT_EMUL_TIME_OFFSET = 3, ALCT_EMUL_TIME_OFFSET = 6 };
+
+  // Numbers obtained from https://twiki.cern.ch/twiki/pub/CMS/CSCDPGGeometry/table_of_csc_properties_150730.pdf
+  enum WG_Info {
+    NUM_WIREGROUPS_ME11 = 48,
+    NUM_WIREGROUPS_ME12 = 64,
+    NUM_WIREGROUPS_ME13 = 32,
+    NUM_WIREGROUPS_ME21 = 112,
+    NUM_WIREGROUPS_ME22 = 64,
+    NUM_WIREGROUPS_ME31 = 96,
+    NUM_WIREGROUPS_ME32 = 64,
+    NUM_WIREGROUPS_ME41 = 96,
+    NUM_WIREGROUPS_ME42 = 64,
+    // this number should really be 112, but has always been 119 since the
+    // CSC trigger was developed in 2006. Probably it would not hurt to change it to 112
+    MAX_NUM_WIREGROUPS = 119
+  };
+
+  // distrips, strips, half-strips
+  enum Strip_Info {
+    // Each CFEB reads out 8 distrips...
+    NUM_DISTRIPS_PER_CFEB = 8,
+    //...16 strips...
+    NUM_STRIPS_PER_CFEB = 2 * NUM_DISTRIPS_PER_CFEB,
+    //...32 half-strips.
+    NUM_HALF_STRIPS_PER_CFEB = 2 * NUM_STRIPS_PER_CFEB,
+    // There are exactly 80 or 112 strips...
+    MAX_NUM_STRIPS_RUN1 = MAX_CFEBS_RUN1 * NUM_STRIPS_PER_CFEB,  // 80
+    MAX_NUM_STRIPS_RUN2 = MAX_CFEBS_RUN2 * NUM_STRIPS_PER_CFEB,  // 112
+    //...and 160 or 224 half-strips for 5 or 7 CFEBs...
+    MAX_NUM_HALF_STRIPS_RUN1 = MAX_CFEBS_RUN1 * NUM_HALF_STRIPS_PER_CFEB,  // 160
+    MAX_NUM_HALF_STRIPS_RUN2 = MAX_CFEBS_RUN2 * NUM_HALF_STRIPS_PER_CFEB,  // 224
+    // ...but depending on the chamber, there may or may not be strip staggering.
+    /* CMS-MUO-16-001: "[..] alternate layers in a CSC are staggered by half a strip width, except
+       in the ME1/1 chambers where the strips are narrower and the effect is small" */
+    // _TRIGGER is added at the end, because these constants are only used in the trigger
+    MAX_NUM_HALF_STRIPS_RUN1_TRIGGER = 1 + MAX_NUM_HALF_STRIPS_RUN1,  // 161
+    MAX_NUM_HALF_STRIPS_RUN2_TRIGGER = 1 + MAX_NUM_HALF_STRIPS_RUN2,  // 225
+    // Number of strips in ME11 (special case)
+    NUM_STRIPS_ME1A_GANGED = NUM_CFEBS_ME1A_GANGED * NUM_STRIPS_PER_CFEB,      // 16
+    NUM_STRIPS_ME1A_UNGANGED = NUM_CFEBS_ME1A_UNGANGED * NUM_STRIPS_PER_CFEB,  // 48
+    NUM_STRIPS_ME1B = NUM_CFEBS_ME1B * NUM_STRIPS_PER_CFEB,                    // 64
+    // Number of half-strips in ME11 (special case)
+    NUM_HALF_STRIPS_ME1A_GANGED = NUM_CFEBS_ME1A_GANGED * NUM_HALF_STRIPS_PER_CFEB,      // 32
+    NUM_HALF_STRIPS_ME1A_UNGANGED = NUM_CFEBS_ME1A_UNGANGED * NUM_HALF_STRIPS_PER_CFEB,  // 96
+    NUM_HALF_STRIPS_ME1B = NUM_CFEBS_ME1B * NUM_HALF_STRIPS_PER_CFEB,                    // 128
+    // max halfstrip number in ME1/1 chambers
+    MAX_HALF_STRIP_ME1A_GANGED = NUM_HALF_STRIPS_ME1A_GANGED - 1,      // 31
+    MAX_HALF_STRIP_ME1A_UNGANGED = NUM_HALF_STRIPS_ME1A_UNGANGED - 1,  // 95
+    MAX_HALF_STRIP_ME1B = NUM_HALF_STRIPS_ME1B - 1,                    // 127
+  };
+
+  // CSCs have 6 layers. The key (reference) layer is the third layer
+  enum Layer_Info { NUM_LAYERS = 6, KEY_CLCT_LAYER = 3, KEY_ALCT_LAYER = 3 };
+
+  // Both ALCT and CLCTs have patterns. CLCTs have a better granularity than ALCTs, thus more patterns
+  enum Pattern_Info {
+    NUM_ALCT_PATTERNS = 3,
+    ALCT_PATTERN_WIDTH = 5,
+    NUM_CLCT_PATTERNS = 11,
+    CLCT_PATTERN_WIDTH = 11,
+    // Max number of wires participating in a pattern
+    MAX_WIRES_IN_PATTERN = 14,
+    NUM_COMPARATOR_CODES = 4096
+  };
+
+  enum Digis_Info { MAX_DIGIS_PER_ALCT = 10, MAX_DIGIS_PER_CLCT = 8 };
+
+  enum LCT_stubs {
+    // CSC local trigger considers 4-bit BX window (16 numbers) in the readout
+    MAX_CLCT_TBINS = 16,
+    MAX_ALCT_TBINS = 16,
+    MAX_LCT_TBINS = 16,
+    // Maximum allowed matching window size
+    MAX_MATCH_WINDOW_SIZE = 15,
+    // Each CLCT processor can send up to 2 CLCTs to TMB per BX
+    MAX_CLCTS_PER_PROCESSOR = 2,
+    MAX_CLCTS_READOUT = 2,
+    // Each ALCT processor can send up to 2 ALCTs to TMB per BX
+    MAX_ALCTS_PER_PROCESSOR = 2,
+    MAX_ALCTS_READOUT = 2,
+    // Each CSC can send up to 2 LCTs to the MPC per BX
+    MAX_LCTS_PER_CSC = 2,
+    // An MPC receives up to 18 LCTs from 9 CSCs in the trigger sector
+    MAX_LCTS_PER_MPC = 18,
+    // Reference BX for LCTs in simulation and firmware
+    LCT_CENTRAL_BX = 8,
+    /*
+      Reference BX for ALCTs in firmware. In the ALCT simulation,
+      and in the motherboard simulation the ALCT central BX is 8.
+      However, ALCT BX is shifted before they are inserted into the EDM
+      ROOT file to have a central BX of 3 and be consistent with the firmware.
+     */
+    ALCT_CENTRAL_BX = 3,
+    /*
+      Reference BX for CLCTs in firmware. In the CLCT simulation, the central
+      CLCT BX is 7. In the motherboard simulation they are shifted to 8 (in order
+      to matched with ALCTs). But in the EDM ROOT file the CLCT central BX is 7
+      to be consistent with the firmware.
+     */
+    CLCT_CENTRAL_BX = 7,
+    // Offset between the ALCT and CLCT central BX in simulation
+    ALCT_CLCT_OFFSET = 1
+  };
+};
+
+#endif

DataFormats/CSCDigi/interface/CSCStripDigi.h

@@ -1,5 +1,5 @@
-#ifndef CSCStripDigi_CSCStripDigi_h
-#define CSCStripDigi_CSCStripDigi_h
+#ifndef DataFormats_CSCDigi_CSCStripDigi_h
+#define DataFormats_CSCDigi_CSCStripDigi_h
 
 /** \class CSCStripDigi
  *
@@ -40,6 +40,9 @@ class CSCStripDigi {
   // Get the strip number. counts from 1.
   int getStrip() const { return strip; }
 
+  /// Get the CFEB number. Counts from 0.
+  int getCFEB() const;
+
   /// Get ADC readings
   std::vector<int> const& getADCCounts() const { return ADCCounts; }
 

DataFormats/CSCDigi/src/CSCComparatorDigi.cc

@@ -4,6 +4,7 @@
  * \author M.Schmitt, Northwestern
  */
 #include "DataFormats/CSCDigi/interface/CSCComparatorDigi.h"
+#include "DataFormats/CSCDigi/interface/CSCConstants.h"
 #include "FWCore/MessageLogger/interface/MessageLogger.h"
 #include <iostream>
 #include <algorithm>
@@ -61,6 +62,14 @@ int CSCComparatorDigi::getTimeBin() const {
   return tbin;
 }
 
+/// Get the distrip number. Counts from 0.
+// originally defined in EventFilter/CSCRawToDigi/src/CSCComparatorData.cc
+int CSCComparatorDigi::getDiStrip() const { return ((strip_ - 1) % CSCConstants::NUM_STRIPS_PER_CFEB) / 2; }
+
+/// Get the CFEB number. Counts from 0.
+// originally defined in EventFilter/CSCRawToDigi/src/CSCComparatorData.cc
+int CSCComparatorDigi::getCFEB() const { return (strip_ - 1) / CSCConstants::NUM_STRIPS_PER_CFEB; }
+
 // This definition is consistent with the one used in
 // the function CSCComparatorData::add() in EventFilter/CSCRawToDigi
 // The halfstrip counts from 0!

DataFormats/CSCDigi/src/CSCStripDigi.cc

@@ -4,6 +4,7 @@
  * \author M.Schmitt, Northwestern
  */
 #include "DataFormats/CSCDigi/interface/CSCStripDigi.h"
+#include "DataFormats/CSCDigi/interface/CSCConstants.h"
 #include "FWCore/MessageLogger/interface/MessageLogger.h"
 #include <iostream>
 #include <cstdint>
@@ -19,6 +20,10 @@ bool CSCStripDigi::operator==(const CSCStripDigi& digi) const {
   return true;
 }
 
+/// Get the CFEB number. Counts from 0.
+// originally defined in EventFilter/CSCRawToDigi/src/CSCComparatorData.cc
+int CSCStripDigi::getCFEB() const { return (strip - 1) / CSCConstants::NUM_STRIPS_PER_CFEB; }
+
 void CSCStripDigi::setADCCounts(const std::vector<int>& vADCCounts) {
   bool badVal = false;
   for (int i = 0; i < (int)vADCCounts.size(); i++) {

DataFormats/L1TMuon/src/EMTFHit.cc

@@ -1,5 +1,5 @@
 #include "DataFormats/L1TMuon/interface/EMTFHit.h"
-#include "DataFormats/L1TMuon/interface/CSCConstants.h"
+#include "DataFormats/CSCDigi/interface/CSCConstants.h"
 
 namespace l1t {
 

EventFilter/CSCRawToDigi/interface/CSCAnodeData.h

@@ -1,9 +1,8 @@
 #ifndef EventFilter_CSCRawToDigi_CSCAnodeData_h
 #define EventFilter_CSCRawToDigi_CSCAnodeData_h
-#include <vector>
-#include <memory>
-#include "DataFormats/CSCDigi/interface/CSCWireDigi.h"
+
 #include "EventFilter/CSCRawToDigi/interface/CSCAnodeDataFormat.h"
+#include <memory>
 
 class CSCALCTHeader;
 

EventFilter/CSCRawToDigi/interface/CSCAnodeDataFormat.h

@@ -1,7 +1,9 @@
 #ifndef EventFilter_CSCRawToDigi_CSCAnodeDataFormat_h
 #define EventFilter_CSCRawToDigi_CSCAnodeDataFormat_h
+
 #include "DataFormats/CSCDigi/interface/CSCWireDigi.h"
 #include <vector>
+
 class CSCAnodeDataFormat {
 public:
   virtual ~CSCAnodeDataFormat() {}

EventFilter/CSCRawToDigi/interface/CSCEventData.h

@@ -23,9 +23,6 @@ class CSCStripDigi;
 #include "DataFormats/MuonDetId/interface/GEMDetId.h"
 #include <boost/dynamic_bitset.hpp>
 
-/// Maximum available CFEBs per chamber (for old system 5, for new ME11 should be 7)
-#define MAX_CFEB 7
-
 class CSCEventData {
 public:
   explicit CSCEventData(int chamberType, uint16_t format_version = 2005);
@@ -159,7 +156,7 @@ class CSCEventData {
   CSCTMBData *theTMBData;
 
   /// for up to MAX_CFEB CFEB boards
-  CSCCFEBData *theCFEBData[MAX_CFEB];
+  CSCCFEBData *theCFEBData[CSCConstants::MAX_CFEBS_RUN2];
 
   CSCDMBTrailer theDMBTrailer;
 

EventFilter/CSCRawToDigi/interface/CSCVTMBHeaderFormat.h

@@ -5,6 +5,7 @@
 #include "DataFormats/CSCDigi/interface/CSCALCTDigi.h"
 #include "DataFormats/CSCDigi/interface/CSCCorrelatedLCTDigi.h"
 #include "DataFormats/MuonDetId/interface/CSCDetId.h"
+#include "DataFormats/CSCDigi/interface/CSCConstants.h"
 #include <vector>
 #include <iosfwd>
 #include <strings.h>