CSCCathodeLCTProcessor.h

Go to the documentation of this file.

#ifndef L1Trigger_CSCTriggerPrimitives_CSCCathodeLCTProcessor_h
#define L1Trigger_CSCTriggerPrimitives_CSCCathodeLCTProcessor_h

#include "DataFormats/CSCDigi/interface/CSCComparatorDigiCollection.h"
#include "DataFormats/CSCDigi/interface/CSCCLCTDigi.h"
#include "DataFormats/CSCDigi/interface/CSCCLCTPreTriggerDigi.h"
#include "CondFormats/CSCObjects/interface/CSCDBL1TPParameters.h"
#include "L1Trigger/CSCTriggerPrimitives/interface/CSCBaseboard.h"

#include <vector>

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

  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_7CFEBS]);

  std::vector<CSCCLCTDigi> readoutCLCTs() const;
  std::vector<CSCCLCTDigi> readoutCLCTsME1a() const;
  std::vector<CSCCLCTDigi> readoutCLCTsME1b() const;

  std::vector<CSCCLCTDigi> getCLCTs() const;

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

  std::vector<CSCCLCTPreTriggerDigi> preTriggerDigis() const {return thePreTriggerDigis; }
  std::vector<CSCCLCTPreTriggerDigi> preTriggerDigisME1a() const;
  std::vector<CSCCLCTPreTriggerDigi> preTriggerDigisME1b() const;

  CSCCLCTDigi bestCLCT[CSCConstants::MAX_CLCT_TBINS];

  CSCCLCTDigi secondCLCT[CSCConstants::MAX_CLCT_TBINS];

 protected:

  bool getDigis(const CSCComparatorDigiCollection* compdc);
  void getDigis(const CSCComparatorDigiCollection* compdc, const CSCDetId& id);

  void setDefaultConfigParameters();

  void checkConfigParameters();

  //---------------- Methods common to all firmware versions ------------------
  // Single-argument version for TMB07 (halfstrip-only) firmware.
  // Takes the comparator & time info and stuffs it into halfstrip vector.
  // Multiple hits on the same strip are allowed.
  void readComparatorDigis(std::vector<int> halfstrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS_7CFEBS]);
  void pulseExtension(const std::vector<int> time[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS_7CFEBS],
                      const int nStrips,
                      unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS_7CFEBS]);

  //--------------- Functions for post-2007 version of the firmware -----------
  virtual std::vector<CSCCLCTDigi> findLCTs(const std::vector<int> halfstrip[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS_7CFEBS]);

  /* Check all half-strip pattern envelopes simultaneously, on every clock cycle, for a matching pattern */
  virtual bool preTrigger(const unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS_7CFEBS],
                  const int start_bx, int& first_bx);

  /* For a given clock cycle, check each half-strip if a pattern matches */
  bool patternFinding(const unsigned int pulse[CSCConstants::NUM_LAYERS][CSCConstants::NUM_HALF_STRIPS_7CFEBS],
                        const int nStrips, const unsigned int bx_time);

  /* Mark the half-strips around the best half-strip as busy */
  void markBusyKeys(const int best_hstrip, const int best_patid,
                    int quality[CSCConstants::NUM_HALF_STRIPS_7CFEBS]);

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

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

  //--------------------------- Member variables -----------------------------

  /* best pattern Id for a given half-strip */
  unsigned int best_pid[CSCConstants::NUM_HALF_STRIPS_7CFEBS];

  /* number of layers hit on a given half-strip */
  unsigned int nhits[CSCConstants::NUM_HALF_STRIPS_7CFEBS];

  int first_bx_corrected[CSCConstants::NUM_HALF_STRIPS_7CFEBS];

  /* does a given half-strip have a pre-trigger? */
  bool ispretrig[CSCConstants::NUM_HALF_STRIPS_7CFEBS];


 public:
  // New set of halfstrip patterns for 2007 version of the algorithm.
  // For the given pattern, set the unused parts of the pattern to 999.
  // Pattern[i][CSCConstants::MAX_HALFSTRIPS_IN_PATTERN] contains bend direction.
  // Bend of 0 is right/straight and bend of 1 is left.
  // Pattern[i][CSCConstants::MAX_HALFSTRIPS_IN_PATTERN+1] contains pattern maximum width
  static const int pattern2007_offset[CSCConstants::MAX_HALFSTRIPS_IN_PATTERN];
  static const int pattern2007[CSCConstants::NUM_CLCT_PATTERNS][CSCConstants::MAX_HALFSTRIPS_IN_PATTERN+2];

 protected:
  // 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,
                     CLCT_NUM_QUANTITIES= 7};

  /* number of strips used in this processor */
  int numStrips;

  /* Is the layer in the chamber staggered? */
  int stagger[CSCConstants::NUM_LAYERS];

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

  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;

  int early_tbins;

  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;
};

#endif