CSCCathodeLCTProcessor.h

Go to the documentation of this file.

#ifndef CSCTriggerPrimitives_CSCCathodeLCTProcessor_h
#define CSCTriggerPrimitives_CSCCathodeLCTProcessor_h

#include <vector>
#include <FWCore/ParameterSet/interface/ParameterSet.h>
#include <DataFormats/CSCDigi/interface/CSCComparatorDigiCollection.h>
#include <DataFormats/CSCDigi/interface/CSCCLCTDigi.h>
#include <CondFormats/CSCObjects/interface/CSCDBL1TPParameters.h>
#include <L1Trigger/CSCCommonTrigger/interface/CSCConstants.h>

class CSCCathodeLCTProcessor
{
 public:
  CSCCathodeLCTProcessor(unsigned endcap, unsigned station, unsigned sector,
             unsigned subsector, unsigned chamber,
             const edm::ParameterSet& conf,
             const edm::ParameterSet& comm,
             const edm::ParameterSet& ctmb);

  CSCCathodeLCTProcessor();

  void setConfigParameters(const CSCDBL1TPParameters* conf);

  void clear();

  std::vector<CSCCLCTDigi> run(const CSCComparatorDigiCollection* compdc);

  void run(const std::vector<int> halfstrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
       const std::vector<int> distrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS]);
 
  bool getDigis(const CSCComparatorDigiCollection* compdc);
  void getDigis(const CSCComparatorDigiCollection* compdc, const CSCDetId& id);

  enum {MAX_CLCT_BINS = 16};

  CSCCLCTDigi bestCLCT[MAX_CLCT_BINS];

  CSCCLCTDigi secondCLCT[MAX_CLCT_BINS];

  std::vector<CSCCLCTDigi> readoutCLCTs();

  std::vector<CSCCLCTDigi> getCLCTs();

  std::vector<int> preTriggerBXs() const {return thePreTriggerBXs;}

  static void distripStagger(int stag_triad[CSCConstants::MAX_NUM_STRIPS],
                 int stag_time[CSCConstants::MAX_NUM_STRIPS],
                 int stag_digi[CSCConstants::MAX_NUM_STRIPS],
                 int i_distrip, bool debug = false);

  void setRing(unsigned r) {theRing = r;}

  enum {NUM_PATTERN_STRIPS = 26};
  static const int pre_hit_pattern[2][NUM_PATTERN_STRIPS];
  static const int pattern[CSCConstants::NUM_CLCT_PATTERNS_PRE_TMB07][NUM_PATTERN_STRIPS+1];

  enum {NUM_PATTERN_HALFSTRIPS = 42};
  static const int pattern2007_offset[NUM_PATTERN_HALFSTRIPS];
  static const int pattern2007[CSCConstants::NUM_CLCT_PATTERNS][NUM_PATTERN_HALFSTRIPS+2];

  enum {MAX_CFEBS = 5};

  // we use these next ones to address the various bits inside the array that's
  // used to make the cathode LCTs.
  enum CLCT_INDICES {CLCT_PATTERN, CLCT_BEND, CLCT_STRIP, CLCT_BX,
             CLCT_STRIP_TYPE, CLCT_QUALITY, CLCT_CFEB};

 private:
  int infoV;

  const unsigned theEndcap;
  const unsigned theStation;
  const unsigned theSector;
  const unsigned theSubsector;
  const unsigned theTrigChamber;
  
  // holders for easy access:
  unsigned int theRing;
  unsigned int theChamber;
  bool isME11;
  
  int numStrips;
  int stagger[CSCConstants::NUM_LAYERS];

  std::vector<CSCComparatorDigi> digiV[CSCConstants::NUM_LAYERS];
  std::vector<int> thePreTriggerBXs;

  bool isMTCC; 

  bool isTMB07;

  bool isSLHC;

  unsigned int fifo_tbins,  fifo_pretrig; // only for test beam mode.
  unsigned int hit_persist, drift_delay;
  unsigned int nplanes_hit_pretrig, nplanes_hit_pattern;
  unsigned int pid_thresh_pretrig,  min_separation;
  unsigned int tmb_l1a_window_size;

  int start_bx_shift;

  bool smartME1aME1b, disableME1a, gangedME1a;

  int early_tbins;

  bool use_dead_time_zoning;
  unsigned int clct_state_machine_zone; // +- around a keystrip
  bool dynamic_state_machine_zone;  //use a pattern dependent zone

  unsigned int pretrig_trig_zone;

  bool use_corrected_bx;

  bool readout_earliest_2;

  static const unsigned int def_fifo_tbins,  def_fifo_pretrig;
  static const unsigned int def_hit_persist, def_drift_delay;
  static const unsigned int def_nplanes_hit_pretrig;
  static const unsigned int def_nplanes_hit_pattern;
  static const unsigned int def_pid_thresh_pretrig, def_min_separation;
  static const unsigned int def_tmb_l1a_window_size;

  void setDefaultConfigParameters();

  void checkConfigParameters();

  static const int cfeb_strips[2];

  //---------------- Methods common to all firmware versions ------------------
  void readComparatorDigis(std::vector<int>halfstrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
               std::vector<int> distrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS]);
  void readComparatorDigis(std::vector<int> halfstrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS]);
  void pulseExtension(
 const std::vector<int> time[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
 const int nStrips,
 unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS]);

  //------------- Functions for idealized version for MC studies --------------
  std::vector<CSCCLCTDigi> findLCTs(
     const std::vector<int> strip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
     int stripType);
  bool preTrigger(
     const std::vector<int> strip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
     const int stripType, const int nStrips, int& first_bx);
  void getKeyStripData(
     const std::vector<int> strip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
     int keystrip_data[CSCConstants::NUM_HALF_STRIPS][7],
     int nStrips, int first_bx, int& best_strip, int stripType);
  void getPattern(int pattern_num, int strip_value[NUM_PATTERN_STRIPS],
          int bx_time, int &quality, int &bend);
  bool hitIsGood(int hitTime, int BX);

  //-------------------- Functions for pre-2007 firmware ----------------------
  std::vector<CSCCLCTDigi> findLCTs(
  const std::vector<int> halfstrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
  const std::vector<int> distrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS]);
  bool preTrigger(
      const std::vector<int> strip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
   unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
      const int stripType, const int nStrips,
      const int start_bx, int& first_bx);
  bool preTrigLookUp(const unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
             const int stripType, const int nStrips,
             const unsigned int bx_time);
  void latchLCTs(const unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
         int keyStrip[MAX_CFEBS], unsigned int nhits[MAX_CFEBS],
         const int stripType, const int nStrips, const int bx_time);
  void priorityEncode(const int h_keyStrip[MAX_CFEBS],
              const unsigned int h_nhits[MAX_CFEBS],
              const int d_keyStrip[MAX_CFEBS],
              const unsigned int d_nhits[MAX_CFEBS],
              int keystrip_data[2][7]);
  void getKeyStripData(const unsigned int h_pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
               const unsigned int d_pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
               int keystrip_data[2][7], const int first_bx);
  void getPattern(unsigned int pattern_num,
          const int strip_value[NUM_PATTERN_STRIPS],
          unsigned int& quality, unsigned int& bend);

  //--------------- Functions for 2007 version of the firmware ----------------
  std::vector<CSCCLCTDigi> findLCTs(
 const std::vector<int> halfstrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS]);
  bool preTrigger(
      const unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
      const int start_bx, int& first_bx);
  bool ptnFinding(
      const unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
      const int nStrips, const unsigned int bx_time);
  void markBusyKeys(const int best_hstrip, const int best_patid,
            int quality[CSCConstants::NUM_HALF_STRIPS]);

  unsigned int best_pid[CSCConstants::NUM_HALF_STRIPS];
  unsigned int nhits[CSCConstants::NUM_HALF_STRIPS];
  int first_bx_corrected[CSCConstants::NUM_HALF_STRIPS];

  //--------------- Functions for SLHC studies ----------------

  std::vector<CSCCLCTDigi> findLCTsSLHC(
    const std::vector<int>  halfstrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS]);

  bool ispretrig[CSCConstants::NUM_HALF_STRIPS];

  //--------------------------- Auxiliary methods -----------------------------
  void dumpConfigParams() const;

  void dumpDigis(
      const std::vector<int> strip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS],
      const int stripType, const int nStrips) const;

  //--------------------------- Methods for tests -----------------------------
  void testDistripStagger();
  void testLCTs();
  void printPatterns();
  void testPatterns();
  int findNumLayersHit(std::vector<int> stripsHit[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS]);
};

#endif