CSCMotherboard.h

Go to the documentation of this file.

#ifndef L1Trigger_CSCTriggerPrimitives_CSCMotherboard_h
#define L1Trigger_CSCTriggerPrimitives_CSCMotherboard_h

#include "L1Trigger/CSCTriggerPrimitives/src/CSCAnodeLCTProcessor.h"
#include "L1Trigger/CSCTriggerPrimitives/src/CSCCathodeLCTProcessor.h"
#include "DataFormats/CSCDigi/interface/CSCCorrelatedLCTDigi.h"
#include "DataFormats/MuonDetId/interface/CSCTriggerNumbering.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"

class CSCGeometry;

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

  CSCMotherboard();

  virtual ~CSCMotherboard() = default;

  void run(const CSCWireDigiCollection* wiredc, const CSCComparatorDigiCollection* compdc);

  std::vector<CSCCorrelatedLCTDigi> readoutLCTs() const;

  std::vector<CSCCorrelatedLCTDigi> getLCTs() const;

  void clear();

  void setConfigParameters(const CSCDBL1TPParameters* conf);

  void setCSCGeometry(const CSCGeometry *g) { csc_g = g; }

  std::unique_ptr<CSCAnodeLCTProcessor> alctProc;

  std::unique_ptr<CSCCathodeLCTProcessor> clctProc;

 // VK: change to protected, to allow inheritance
 protected:

  /* Containers for reconstructed ALCTs and CLCTs */
  std::vector<CSCALCTDigi> alctV;
  std::vector<CSCCLCTDigi> clctV;

  CSCCorrelatedLCTDigi firstLCT[CSCConstants::MAX_LCT_TBINS];

  CSCCorrelatedLCTDigi secondLCT[CSCConstants::MAX_LCT_TBINS];

  // Parameters common for all boards
  edm::ParameterSet commonParams_;

  // Parameters for processors
  edm::ParameterSet alctParams_;
  edm::ParameterSet clctParams_;

  // Motherboard parameters:
  edm::ParameterSet tmbParams_;

  // helper function to return ALCT with correct central BX
  CSCALCTDigi getBXShiftedALCT(const CSCALCTDigi&) const;

  int infoV;

  const unsigned theEndcap;
  const unsigned theStation;
  const unsigned theSector;
  const unsigned theSubsector;
  const unsigned theTrigChamber;
  unsigned theRing;

  const CSCGeometry* csc_g;

  bool isSLHC_;

  /* Flags to run upgrade algorithms */
  bool runME11ILT_;
  bool runME21ILT_;
  bool runME3141ILT_;

  unsigned int mpc_block_me1a;
  unsigned int alct_trig_enable, clct_trig_enable, match_trig_enable;
  unsigned int match_trig_window_size, tmb_l1a_window_size;

  bool drop_used_alcts;

  bool drop_used_clcts;

  int early_tbins;

  bool readout_earliest_2;

  bool clct_to_alct;

  unsigned int alctClctOffset;

  static const unsigned int def_mpc_block_me1a;
  static const unsigned int def_alct_trig_enable, def_clct_trig_enable;
  static const unsigned int def_match_trig_enable, def_match_trig_window_size;
  static const unsigned int def_tmb_l1a_window_size;

  void checkConfigParameters();

  void correlateLCTs(const CSCALCTDigi& bestALCT, const CSCALCTDigi& secondALCT,
                     const CSCCLCTDigi& bestCLCT, const CSCCLCTDigi& secondCLCT,
                     int type);

  // This method calculates all the TMB words and then passes them to the
  // constructor of correlated LCTs.
  CSCCorrelatedLCTDigi constructLCTs(const CSCALCTDigi& aLCT,
                                     const CSCCLCTDigi& cLCT,
                                     int type, int trknmb) const;

  // CLCT pattern number: encodes the pattern number itself
  unsigned int encodePattern(const int clctPattern) const;

  // 4-bit LCT quality number.Made by TMB lookup tables and used for MPC sorting.
  unsigned int findQuality(const CSCALCTDigi& aLCT, const CSCCLCTDigi& cLCT) const;

  enum LCT_Quality{
    INVALID  = 0,
    NO_CLCT = 1,
    NO_ALCT = 2,
    CLCT_LAYER_TRIGGER = 3,
    LOW_QUALITY = 4,
    MARGINAL_ANODE_CATHODE = 5,
    HQ_ANODE_MARGINAL_CATHODE = 6,
    HQ_CATHODE_MARGINAL_ANODE = 7,
    HQ_ACCEL_ALCT = 8,
    HQ_RESERVED_1 = 9,
    HQ_RESERVED_2 = 10,
    HQ_PATTERN_2_3 = 11,
    HQ_PATTERN_4_5 = 12,
    HQ_PATTERN_6_7 = 13,
    HQ_PATTERN_8_9 = 14,
    HQ_PATTERN_10 = 15
  };

  void dumpConfigParams() const;
};
#endif