CMS 3D CMS Logo

List of all members | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes
CSCMotherboard Class Reference

#include <CSCMotherboard.h>

Inheritance diagram for CSCMotherboard:
CSCBaseboard CSCGEMMotherboard

Public Member Functions

void clear ()
 
 CSCMotherboard (unsigned endcap, unsigned station, unsigned sector, unsigned subsector, unsigned chamber, const edm::ParameterSet &conf)
 
virtual std::vector< CSCCorrelatedLCTDigireadoutLCTs () const
 
std::vector< CSCShowerDigireadoutShower () const
 
void run (const CSCWireDigiCollection *wiredc, const CSCComparatorDigiCollection *compdc)
 
void selectLCTs ()
 
void setConfigParameters (const CSCDBL1TPParameters *conf)
 
void setESLookupTables (const CSCL1TPLookupTableCCLUT *conf)
 
void setESLookupTables (const CSCL1TPLookupTableME11ILT *conf)
 
void setESLookupTables (const CSCL1TPLookupTableME21ILT *conf)
 
 ~CSCMotherboard () override=default
 
- Public Member Functions inherited from CSCBaseboard
 CSCBaseboard (unsigned endcap, unsigned station, unsigned sector, unsigned subsector, unsigned chamber, const edm::ParameterSet &conf)
 
 CSCBaseboard ()
 
std::string getCSCName () const
 
CSCDetId id () const
 
void setCSCGeometry (const CSCGeometry *g)
 
virtual ~CSCBaseboard ()=default
 

Public Attributes

std::unique_ptr< CSCAnodeLCTProcessoralctProc
 
std::unique_ptr< CSCCathodeLCTProcessorclctProc
 

Protected Member Functions

void checkConfigParameters ()
 
void constructLCTs (const CSCALCTDigi &aLCT, const CSCCLCTDigi &cLCT, int type, int trknmb, CSCCorrelatedLCTDigi &lct) const
 
void copyValidToInValidALCT (CSCALCTDigi &, CSCALCTDigi &) const
 
void copyValidToInValidCLCT (CSCCLCTDigi &, CSCCLCTDigi &) const
 
void correlateLCTs (const CSCALCTDigi &bestALCT, const CSCALCTDigi &secondALCT, const CSCCLCTDigi &bestCLCT, const CSCCLCTDigi &secondCLCT, CSCCorrelatedLCTDigi &bLCT, CSCCorrelatedLCTDigi &sLCT, int type) const
 
bool doesALCTCrossCLCT (const CSCALCTDigi &, const CSCCLCTDigi &) const
 
void dumpConfigParams () const
 
void encodeHighMultiplicityBits ()
 
unsigned int encodePattern (const int clctPattern) const
 
CSCALCTDigi getBXShiftedALCT (const CSCALCTDigi &) const
 
CSCCLCTDigi getBXShiftedCLCT (const CSCCLCTDigi &) const
 
void matchALCTCLCT ()
 
void matchShowers (CSCShowerDigi *anode_showers, CSCShowerDigi *cathode_showers, bool andlogic)
 
void sortCLCTByQualBend (int alct_bx, std::vector< unsigned > &clctBxVector)
 
- Protected Member Functions inherited from CSCBaseboard
void checkConfigParameters (unsigned int &var, const unsigned int var_max, const unsigned int var_def, const std::string &var_str)
 

Protected Attributes

unsigned int alct_trig_enable
 
std::vector< CSCALCTDigialctV
 
LCTContainer allLCTs_
 
unsigned int clct_trig_enable
 
std::vector< CSCCLCTDigiclctV
 
std::unique_ptr< CSCALCTCrossCLCTcscOverlap_
 
bool drop_used_clcts
 
int early_tbins
 
bool ignoreAlctCrossClct_
 
std::vector< CSCCorrelatedLCTDigilctV
 
const CSCL1TPLookupTableCCLUTlookupTableCCLUT_
 
const CSCL1TPLookupTableME11ILTlookupTableME11ILT_
 
const CSCL1TPLookupTableME21ILTlookupTableME21ILT_
 
bool match_earliest_clct_only_
 
unsigned int match_trig_enable
 
unsigned int match_trig_window_size
 
unsigned maxbx_readout_
 
unsigned minbx_readout_
 
unsigned int mpc_block_me1a
 
std::vector< int > preferred_bx_match_
 
std::unique_ptr< LCTQualityAssignmentqualityAssignment_
 
std::unique_ptr< LCTQualityControlqualityControl_
 
bool readout_earliest_2
 
CSCShowerDigi showers_ [CSCConstants::MAX_LCT_TBINS]
 
std::vector< unsigned > showerSource_
 
bool sort_clct_bx_
 
unsigned thisShowerSource_
 
unsigned int tmb_l1a_window_size
 
- Protected Attributes inherited from CSCBaseboard
edm::ParameterSet alctParams_
 
edm::ParameterSet clctParams_
 
edm::ParameterSet commonParams_
 
const CSCChambercscChamber_
 
const CSCGeometrycscGeometry_
 
CSCDetId cscId_
 
bool disableME1a_
 
bool enableAlctPhase2_
 
bool gangedME1a_
 
int infoV
 
bool isME11_
 
bool isME12_
 
bool isME13_
 
bool isME21_
 
bool isME22_
 
bool isME31_
 
bool isME32_
 
bool isME41_
 
bool isME42_
 
bool run3_
 
bool runCCLUT_
 
bool runCCLUT_OTMB_
 
bool runCCLUT_TMB_
 
bool runME11ILT_
 
bool runME11Up_
 
bool runME21ILT_
 
bool runME21Up_
 
bool runME31Up_
 
bool runME41Up_
 
bool runPhase2_
 
edm::ParameterSet showerParams_
 
unsigned theChamber
 
std::string theCSCName_
 
const unsigned theEndcap
 
int theRegion
 
unsigned theRing
 
const unsigned theSector
 
const unsigned theStation
 
const unsigned theSubsector
 
const unsigned theTrigChamber
 
edm::ParameterSet tmbParams_
 

Static Protected Attributes

static const unsigned int def_alct_trig_enable = 0
 
static const unsigned int def_clct_trig_enable = 0
 
static const unsigned int def_match_trig_enable = 1
 
static const unsigned int def_match_trig_window_size = 7
 
static const unsigned int def_mpc_block_me1a = 1
 
static const unsigned int def_tmb_l1a_window_size = 7
 

Detailed Description

Correlates anode and cathode LCTs from the same chamber.

When the Trigger MotherBoard (TMB) is instantiated it instantiates an ALCT and CLCT board. The MotherBoard takes up to two LCTs from each anode and cathode LCT card and combines them into a single Correlated LCT. The output is up to two Correlated LCTs.

It can be run in either a test mode, where the arguments are a collection of wire times and arrays of halfstrip times, or for general use, with wire digi and comparator digi collections as arguments. In the latter mode, the wire & strip info is passed on the LCTProcessors, where it is decoded and converted into a convenient form. After running the anode and cathode LCTProcessors, TMB correlates the anode and cathode LCTs. At present, it simply matches the best CLCT with the best ALCT; perhaps a better algorithm will be determined in the future. The MotherBoard then determines a few more numbers (such as quality and pattern) from the ALCT and CLCT information, and constructs two correlated LCT "digis".

Author
Benn Tannenbaum 28 August 1999 benn@.nosp@m.phys.nosp@m.ics.u.nosp@m.cla..nosp@m.edu

Based on code by Nick Wisniewski (nw@it.nosp@m.s.ca.nosp@m.ltech.nosp@m..edu) and a framework by Darin Acosta (acost.nosp@m.a@ph.nosp@m.ys.uf.nosp@m.l.ed.nosp@m.u).

Numerous later improvements by Jason Mumford and Slava Valuev (see cvs in ORCA). Porting from ORCA by S. Valuev (Slava.nosp@m..Val.nosp@m.uev@c.nosp@m.ern..nosp@m.ch), May 2006.

Extended for Run-3 and Phase-2 by Vadim Khotilovich, Tao Huang, Sven Dildick and Giovanni Mocellin

Definition at line 50 of file CSCMotherboard.h.

Constructor & Destructor Documentation

◆ CSCMotherboard()

CSCMotherboard::CSCMotherboard ( unsigned  endcap,
unsigned  station,
unsigned  sector,
unsigned  subsector,
unsigned  chamber,
const edm::ParameterSet conf 
)

Normal constructor.

Definition at line 13 of file CSCMotherboard.cc.

References alct_trig_enable, alctProc, allLCTs_, cms::cuda::assert(), relativeConstraints::chamber, checkConfigParameters(), clct_trig_enable, clctProc, cscOverlap_, drop_used_clcts, dumpConfigParams(), early_tbins, CSCBaseboard::enableAlctPhase2_, makeMuonMisalignmentScenario::endcap, edm::ParameterSet::getParameter(), CSCDetId::iChamberType(), ignoreAlctCrossClct_, CSCBaseboard::infoV, CSCConstants::LCT_CENTRAL_BX, match_earliest_clct_only_, match_trig_enable, match_trig_window_size, maxbx_readout_, minbx_readout_, mpc_block_me1a, preferred_bx_match_, qualityAssignment_, qualityControl_, readout_earliest_2, CSCBaseboard::runPhase2_, hgcalTBTopologyTester_cfi::sector, LCTContainer::setMatchTrigWindowSize(), CSCBaseboard::showerParams_, showerSource_, sort_clct_bx_, relativeConstraints::station, CSCBaseboard::theRing, CSCBaseboard::theStation, thisShowerSource_, tmb_l1a_window_size, and CSCBaseboard::tmbParams_.

19  : CSCBaseboard(endcap, station, sector, subsector, chamber, conf) {
20  // Normal constructor. -JM
21  // Pass ALCT, CLCT, and common parameters on to ALCT and CLCT processors.
22  static std::atomic<bool> config_dumped{false};
23 
24  mpc_block_me1a = tmbParams_.getParameter<unsigned int>("mpcBlockMe1a");
25  alct_trig_enable = tmbParams_.getParameter<unsigned int>("alctTrigEnable");
26  clct_trig_enable = tmbParams_.getParameter<unsigned int>("clctTrigEnable");
27  match_trig_enable = tmbParams_.getParameter<unsigned int>("matchTrigEnable");
28  match_trig_window_size = tmbParams_.getParameter<unsigned int>("matchTrigWindowSize");
29  tmb_l1a_window_size = // Common to CLCT and TMB
30  tmbParams_.getParameter<unsigned int>("tmbL1aWindowSize");
31 
32  // configuration handle for number of early time bins
33  early_tbins = tmbParams_.getParameter<int>("tmbEarlyTbins");
34 
35  // whether to not reuse CLCTs that were used by previous matching ALCTs
36  drop_used_clcts = tmbParams_.getParameter<bool>("tmbDropUsedClcts");
37 
38  // whether to readout only the earliest two LCTs in readout window
39  readout_earliest_2 = tmbParams_.getParameter<bool>("tmbReadoutEarliest2");
40 
41  match_earliest_clct_only_ = tmbParams_.getParameter<bool>("matchEarliestClctOnly");
42 
43  infoV = tmbParams_.getParameter<int>("verbosity");
44 
45  alctProc = std::make_unique<CSCAnodeLCTProcessor>(endcap, station, sector, subsector, chamber, conf);
46  clctProc = std::make_unique<CSCCathodeLCTProcessor>(endcap, station, sector, subsector, chamber, conf);
47 
48  // Check and print configuration parameters.
50  if (infoV > 0 && !config_dumped) {
52  config_dumped = true;
53  }
54 
56 
57  // get the preferred CLCT BX match array
58  preferred_bx_match_ = tmbParams_.getParameter<std::vector<int>>("preferredBxMatch");
59 
60  // sort CLCT only by bx or by quality+bending for ALCT-CLCT match
61  sort_clct_bx_ = tmbParams_.getParameter<bool>("sortClctBx");
62 
63  // quality assignment
64  qualityAssignment_ = std::make_unique<LCTQualityAssignment>(endcap, station, sector, subsector, chamber, conf);
65 
66  // quality control of stubs
67  qualityControl_ = std::make_unique<LCTQualityControl>(endcap, station, sector, subsector, chamber, conf);
68 
69  // shower-trigger source
70  showerSource_ = showerParams_.getParameter<std::vector<unsigned>>("source");
71 
72  unsigned csc_idx = CSCDetId::iChamberType(theStation, theRing) - 2;
74 
75  // shower readout window
79 
80  // enable the upgrade processors for ring 1 stations
81  if (runPhase2_ and theRing == 1) {
82  clctProc = std::make_unique<CSCUpgradeCathodeLCTProcessor>(endcap, station, sector, subsector, chamber, conf);
83  if (enableAlctPhase2_) {
84  alctProc = std::make_unique<CSCUpgradeAnodeLCTProcessor>(endcap, station, sector, subsector, chamber, conf);
85  }
86  }
87 
88  // set up helper class to check if ALCT and CLCT cross
89  ignoreAlctCrossClct_ = tmbParams_.getParameter<bool>("ignoreAlctCrossClct");
90  if (!ignoreAlctCrossClct_) {
91  cscOverlap_ = std::make_unique<CSCALCTCrossCLCT>(endcap, station, theRing, ignoreAlctCrossClct_, conf);
92  }
93 }
LCTContainer allLCTs_
T getParameter(std::string const &) const
Definition: ParameterSet.h:303
unsigned thisShowerSource_
unsigned maxbx_readout_
unsigned int clct_trig_enable
unsigned int match_trig_window_size
bool enableAlctPhase2_
Definition: CSCBaseboard.h:94
std::unique_ptr< CSCCathodeLCTProcessor > clctProc
unsigned short iChamberType() const
Definition: CSCDetId.h:96
assert(be >=bs)
void setMatchTrigWindowSize(unsigned trig_window_size)
Definition: LCTContainer.h:41
unsigned int mpc_block_me1a
unsigned minbx_readout_
std::vector< int > preferred_bx_match_
bool match_earliest_clct_only_
std::unique_ptr< CSCALCTCrossCLCT > cscOverlap_
void dumpConfigParams() const
unsigned int tmb_l1a_window_size
void checkConfigParameters()
unsigned int match_trig_enable
std::vector< unsigned > showerSource_
edm::ParameterSet tmbParams_
Definition: CSCBaseboard.h:78
const unsigned theStation
Definition: CSCBaseboard.h:43
unsigned int alct_trig_enable
std::unique_ptr< CSCAnodeLCTProcessor > alctProc
unsigned theRing
Definition: CSCBaseboard.h:48
edm::ParameterSet showerParams_
Definition: CSCBaseboard.h:87
std::unique_ptr< LCTQualityControl > qualityControl_
std::unique_ptr< LCTQualityAssignment > qualityAssignment_

◆ ~CSCMotherboard()

CSCMotherboard::~CSCMotherboard ( )
overridedefault

Default destructor.

Member Function Documentation

◆ checkConfigParameters()

void CSCMotherboard::checkConfigParameters ( )
protected

Make sure that the parameter values are within the allowed range.

Definition at line 611 of file CSCMotherboard.cc.

References alct_trig_enable, cms::cuda::assert(), CSCBaseboard::checkConfigParameters(), clct_trig_enable, def_alct_trig_enable, def_clct_trig_enable, def_match_trig_enable, def_match_trig_window_size, def_mpc_block_me1a, def_tmb_l1a_window_size, CSCConstants::LCT_CENTRAL_BX, match_trig_enable, match_trig_window_size, mpc_block_me1a, and tmb_l1a_window_size.

Referenced by CSCMotherboard(), and setConfigParameters().

611  {
612  // Make sure that the parameter values are within the allowed range.
613 
614  // Max expected values.
615  static const unsigned int max_mpc_block_me1a = 1 << 1;
616  static const unsigned int max_alct_trig_enable = 1 << 1;
617  static const unsigned int max_clct_trig_enable = 1 << 1;
618  static const unsigned int max_match_trig_enable = 1 << 1;
619  static const unsigned int max_match_trig_window_size = 1 << 4;
620  static const unsigned int max_tmb_l1a_window_size = 1 << 4;
621 
622  // Checks.
623  CSCBaseboard::checkConfigParameters(mpc_block_me1a, max_mpc_block_me1a, def_mpc_block_me1a, "mpc_block_me1a");
624  CSCBaseboard::checkConfigParameters(alct_trig_enable, max_alct_trig_enable, def_alct_trig_enable, "alct_trig_enable");
625  CSCBaseboard::checkConfigParameters(clct_trig_enable, max_clct_trig_enable, def_clct_trig_enable, "clct_trig_enable");
627  match_trig_enable, max_match_trig_enable, def_match_trig_enable, "match_trig_enable");
629  match_trig_window_size, max_match_trig_window_size, def_match_trig_window_size, "match_trig_window_size");
631  tmb_l1a_window_size, max_tmb_l1a_window_size, def_tmb_l1a_window_size, "tmb_l1a_window_size");
633 }
unsigned int clct_trig_enable
unsigned int match_trig_window_size
static const unsigned int def_alct_trig_enable
void checkConfigParameters(unsigned int &var, const unsigned int var_max, const unsigned int var_def, const std::string &var_str)
static const unsigned int def_mpc_block_me1a
static const unsigned int def_clct_trig_enable
assert(be >=bs)
unsigned int mpc_block_me1a
static const unsigned int def_tmb_l1a_window_size
unsigned int tmb_l1a_window_size
unsigned int match_trig_enable
static const unsigned int def_match_trig_window_size
unsigned int alct_trig_enable
static const unsigned int def_match_trig_enable

◆ clear()

void CSCMotherboard::clear ( void  )

Clears correlated LCT and passes clear signal on to cathode and anode LCT processors.

Definition at line 95 of file CSCMotherboard.cc.

References alctProc, alctV, allLCTs_, simKBmtfDigis_cfi::bx, clctProc, clctV, CSCShowerDigi::clear(), LCTContainer::clear(), lctV, CSCConstants::MAX_LCT_TBINS, and showers_.

Referenced by CSCGEMMotherboard::clear(), and run().

95  {
96  // clear the processors
97  if (alctProc)
98  alctProc->clear();
99  if (clctProc)
100  clctProc->clear();
101 
102  // clear the ALCT and CLCT containers
103  alctV.clear();
104  clctV.clear();
105  lctV.clear();
106 
107  allLCTs_.clear();
108 
109  for (int bx = 0; bx < CSCConstants::MAX_LCT_TBINS; bx++) {
110  showers_[bx].clear();
111  }
112 }
LCTContainer allLCTs_
std::vector< CSCCLCTDigi > clctV
CSCShowerDigi showers_[CSCConstants::MAX_LCT_TBINS]
std::vector< CSCCorrelatedLCTDigi > lctV
std::unique_ptr< CSCCathodeLCTProcessor > clctProc
std::vector< CSCALCTDigi > alctV
std::unique_ptr< CSCAnodeLCTProcessor > alctProc
void clear()
clear this Shower

◆ constructLCTs()

void CSCMotherboard::constructLCTs ( const CSCALCTDigi aLCT,
const CSCCLCTDigi cLCT,
int  type,
int  trknmb,
CSCCorrelatedLCTDigi lct 
) const
protected

Definition at line 504 of file CSCMotherboard.cc.

References simKBmtfDigis_cfi::bx, encodePattern(), CSCCLCTDigi::getBend(), CSCALCTDigi::getBX(), CSCCLCTDigi::getBX(), getBXShiftedALCT(), getBXShiftedCLCT(), CSCCLCTDigi::getEighthStripBit(), CSCCLCTDigi::getKeyStrip(), CSCALCTDigi::getKeyWG(), CSCCLCTDigi::getPattern(), CSCCLCTDigi::getQuartStripBit(), CSCCLCTDigi::getRun3Pattern(), CSCCLCTDigi::getSlope(), CSCALCTDigi::isValid(), qualityAssignment_, CSCBaseboard::runCCLUT_, CSCCorrelatedLCTDigi::setALCT(), CSCCorrelatedLCTDigi::setBend(), CSCCorrelatedLCTDigi::setBX(), CSCCorrelatedLCTDigi::setBX0(), CSCCorrelatedLCTDigi::setCLCT(), CSCCorrelatedLCTDigi::setCSCID(), CSCCorrelatedLCTDigi::setEighthStripBit(), CSCCorrelatedLCTDigi::setMPCLink(), CSCCorrelatedLCTDigi::setPattern(), CSCCorrelatedLCTDigi::setQuality(), CSCCorrelatedLCTDigi::setQuartStripBit(), CSCCorrelatedLCTDigi::setRun3(), CSCCorrelatedLCTDigi::setRun3Pattern(), CSCCorrelatedLCTDigi::setSlope(), CSCCorrelatedLCTDigi::setStrip(), CSCCorrelatedLCTDigi::setSyncErr(), CSCCorrelatedLCTDigi::setTrknmb(), CSCCorrelatedLCTDigi::setType(), CSCCorrelatedLCTDigi::setValid(), CSCCorrelatedLCTDigi::setWireGroup(), and CSCBaseboard::theTrigChamber.

Referenced by correlateLCTs().

505  {
506  thisLCT.setValid(true);
507  thisLCT.setType(type);
508  // make sure to shift the ALCT BX from 8 to 3 and the CLCT BX from 8 to 7!
509  thisLCT.setALCT(getBXShiftedALCT(aLCT));
510  thisLCT.setCLCT(getBXShiftedCLCT(cLCT));
511  thisLCT.setPattern(encodePattern(cLCT.getPattern()));
512  thisLCT.setMPCLink(0);
513  thisLCT.setBX0(0);
514  thisLCT.setSyncErr(0);
515  thisLCT.setCSCID(theTrigChamber);
516  thisLCT.setTrknmb(trknmb);
517  thisLCT.setWireGroup(aLCT.getKeyWG());
518  thisLCT.setStrip(cLCT.getKeyStrip());
519  thisLCT.setBend(cLCT.getBend());
520  // Bunch crossing: get it from cathode LCT if anode LCT is not there.
521  int bx = aLCT.isValid() ? aLCT.getBX() : cLCT.getBX();
522  thisLCT.setBX(bx);
523  thisLCT.setQuality(qualityAssignment_->findQuality(aLCT, cLCT));
524  if (runCCLUT_) {
525  thisLCT.setRun3(true);
526  // 4-bit slope value derived with the CCLUT algorithm
527  thisLCT.setSlope(cLCT.getSlope());
528  thisLCT.setQuartStripBit(cLCT.getQuartStripBit());
529  thisLCT.setEighthStripBit(cLCT.getEighthStripBit());
530  thisLCT.setRun3Pattern(cLCT.getRun3Pattern());
531  }
532 }
bool isValid() const
check ALCT validity (1 - valid ALCT)
Definition: CSCALCTDigi.h:40
uint16_t getBX() const
return BX - five low bits of BXN counter tagged by the ALCT
Definition: CSCALCTDigi.h:73
unsigned int encodePattern(const int clctPattern) const
uint16_t getKeyStrip(const uint16_t n=2) const
Definition: CSCCLCTDigi.cc:107
bool getEighthStripBit() const
get single eighth strip bit
Definition: CSCCLCTDigi.h:114
CSCCLCTDigi getBXShiftedCLCT(const CSCCLCTDigi &) const
bool getQuartStripBit() const
get single quart strip bit
Definition: CSCCLCTDigi.h:108
const unsigned theTrigChamber
Definition: CSCBaseboard.h:46
uint16_t getKeyWG() const
return key wire group
Definition: CSCALCTDigi.h:67
uint16_t getBend() const
Definition: CSCCLCTDigi.h:93
uint16_t getBX() const
return BX
Definition: CSCCLCTDigi.h:123
uint16_t getPattern() const
return pattern
Definition: CSCCLCTDigi.h:62
uint16_t getSlope() const
return the slope
Definition: CSCCLCTDigi.h:74
uint16_t getRun3Pattern() const
return pattern
Definition: CSCCLCTDigi.h:68
CSCALCTDigi getBXShiftedALCT(const CSCALCTDigi &) const
std::unique_ptr< LCTQualityAssignment > qualityAssignment_

◆ copyValidToInValidALCT()

void CSCMotherboard::copyValidToInValidALCT ( CSCALCTDigi bestALCT,
CSCALCTDigi secondALCT 
) const
protected

Definition at line 484 of file CSCMotherboard.cc.

References CSCALCTDigi::isValid().

Referenced by correlateLCTs().

484  {
485  if (bestALCT.isValid() and !secondALCT.isValid())
486  secondALCT = bestALCT;
487 }
bool isValid() const
check ALCT validity (1 - valid ALCT)
Definition: CSCALCTDigi.h:40

◆ copyValidToInValidCLCT()

void CSCMotherboard::copyValidToInValidCLCT ( CSCCLCTDigi bestCLCT,
CSCCLCTDigi secondCLCT 
) const
protected

Definition at line 490 of file CSCMotherboard.cc.

References CSCCLCTDigi::isValid().

Referenced by correlateLCTs().

490  {
491  if (bestCLCT.isValid() and !secondCLCT.isValid())
492  secondCLCT = bestCLCT;
493 }
bool isValid() const
check CLCT validity (1 - valid CLCT)
Definition: CSCCLCTDigi.h:50

◆ correlateLCTs()

void CSCMotherboard::correlateLCTs ( const CSCALCTDigi bestALCT,
const CSCALCTDigi secondALCT,
const CSCCLCTDigi bestCLCT,
const CSCCLCTDigi secondCLCT,
CSCCorrelatedLCTDigi bLCT,
CSCCorrelatedLCTDigi sLCT,
int  type 
) const
protected

Definition at line 414 of file CSCMotherboard.cc.

References alct_trig_enable, clct_trig_enable, CSCCLCTDigi::clear(), constructLCTs(), copyValidToInValidALCT(), copyValidToInValidCLCT(), doesALCTCrossCLCT(), CSCCLCTDigi::getQuality(), CSCALCTDigi::isValid(), CSCCLCTDigi::isValid(), match_trig_enable, and or.

Referenced by matchALCTCLCT().

420  {
421  CSCALCTDigi bestALCT = bALCT;
422  CSCALCTDigi secondALCT = sALCT;
423  CSCCLCTDigi bestCLCT = bCLCT;
424  CSCCLCTDigi secondCLCT = sCLCT;
425 
426  // extra check to make sure that both CLCTs have at least 4 layers
427  // for regular ALCT-CLCT type LCTs. A check was already done on the
428  // best CLCT, but not yet on the second best CLCT. The check on best
429  // CLCT is repeated for completeness
430  if (bestCLCT.getQuality() <= 3)
431  bestCLCT.clear();
432  if (secondCLCT.getQuality() <= 3)
433  secondCLCT.clear();
434 
435  // if the best ALCT/CLCT is valid, but the second ALCT/CLCT is not,
436  // the information is copied over
437  copyValidToInValidALCT(bestALCT, secondALCT);
438  copyValidToInValidCLCT(bestCLCT, secondCLCT);
439 
440  // ALCT-only LCTs
441  const bool bestCase1(alct_trig_enable and bestALCT.isValid());
442  // CLCT-only LCTs
443  const bool bestCase2(clct_trig_enable and bestCLCT.isValid());
444  /*
445  Normal case: ALCT-CLCT matched LCTs. We require ALCT and CLCT to be valid.
446  Optionally, we can check if the ALCT cross the CLCT. This check will always return true
447  for a valid ALCT-CLCT pair in non-ME1/1 chambers. For ME1/1 chambers, it returns true,
448  only when the ALCT-CLCT pair crosses and when the parameter "checkAlctCrossClct" is set to True.
449  It is recommended to keep "checkAlctCrossClct" set to False, so that the EMTF receives
450  all information, even if it's unphysical.
451  */
452  const bool bestCase3(match_trig_enable and bestALCT.isValid() and bestCLCT.isValid() and
453  doesALCTCrossCLCT(bestALCT, bestCLCT));
454 
455  // at least one of the cases must be valid
456  if (bestCase1 or bestCase2 or bestCase3) {
457  constructLCTs(bestALCT, bestCLCT, type, 1, bLCT);
458  }
459 
460  // ALCT-only LCTs
461  const bool secondCase1(alct_trig_enable and secondALCT.isValid());
462  // CLCT-only LCTs
463  const bool secondCase2(clct_trig_enable and secondCLCT.isValid());
464  /*
465  Normal case: ALCT-CLCT matched LCTs. We require ALCT and CLCT to be valid.
466  Optionally, we can check if the ALCT cross the CLCT. This check will always return true
467  for a valid ALCT-CLCT pair in non-ME1/1 chambers. For ME1/1 chambers, it returns true,
468  only when the ALCT-CLCT pair crosses and when the parameter "checkAlctCrossClct" is set to True.
469  It is recommended to keep "checkAlctCrossClct" set to False, so that the EMTF receives
470  all information, even if it's unphysical.
471  */
472  const bool secondCase3(match_trig_enable and secondALCT.isValid() and secondCLCT.isValid() and
473  doesALCTCrossCLCT(secondALCT, secondCLCT));
474 
475  // at least one component must be different in order to consider the secondLCT
476  if ((secondALCT != bestALCT) or (secondCLCT != bestCLCT)) {
477  // at least one of the cases must be valid
478  if (secondCase1 or secondCase2 or secondCase3)
479  constructLCTs(secondALCT, secondCLCT, type, 2, sLCT);
480  }
481 }
bool isValid() const
check ALCT validity (1 - valid ALCT)
Definition: CSCALCTDigi.h:40
unsigned int clct_trig_enable
uint16_t getQuality() const
return quality of a pattern (number of layers hit!)
Definition: CSCCLCTDigi.h:56
void copyValidToInValidALCT(CSCALCTDigi &, CSCALCTDigi &) const
The Signals That Services Can Subscribe To This is based on ActivityRegistry and is current per Services can connect to the signals distributed by the ActivityRegistry in order to monitor the activity of the application Each possible callback has some defined which we here list in angle e< void, edm::EventID const &, edm::Timestamp const & > We also list in braces which AR_WATCH_USING_METHOD_ is used for those or
Definition: Activities.doc:12
unsigned int match_trig_enable
void copyValidToInValidCLCT(CSCCLCTDigi &, CSCCLCTDigi &) const
bool isValid() const
check CLCT validity (1 - valid CLCT)
Definition: CSCCLCTDigi.h:50
bool doesALCTCrossCLCT(const CSCALCTDigi &, const CSCCLCTDigi &) const
unsigned int alct_trig_enable
void clear()
clear this CLCT
Definition: CSCCLCTDigi.cc:73
void constructLCTs(const CSCALCTDigi &aLCT, const CSCCLCTDigi &cLCT, int type, int trknmb, CSCCorrelatedLCTDigi &lct) const

◆ doesALCTCrossCLCT()

bool CSCMotherboard::doesALCTCrossCLCT ( const CSCALCTDigi alct,
const CSCCLCTDigi clct 
) const
protected

Definition at line 495 of file CSCMotherboard.cc.

References cscOverlap_, and ignoreAlctCrossClct_.

Referenced by correlateLCTs(), and CSCGEMMotherboard::correlateLCTsGEM().

495  {
497  return true;
498  else
499  return cscOverlap_->doesALCTCrossCLCT(alct, clct);
500 }
std::unique_ptr< CSCALCTCrossCLCT > cscOverlap_

◆ dumpConfigParams()

void CSCMotherboard::dumpConfigParams ( ) const
protected

Dump TMB/MPC configuration parameters.

Definition at line 635 of file CSCMotherboard.cc.

References alct_trig_enable, clct_trig_enable, LogDebug, match_trig_enable, match_trig_window_size, mpc_block_me1a, and tmb_l1a_window_size.

Referenced by CSCMotherboard(), and setConfigParameters().

635  {
636  std::ostringstream strm;
637  strm << "\n";
638  strm << "++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n";
639  strm << "+ TMB configuration parameters: +\n";
640  strm << "++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n";
641  strm << " mpc_block_me1a [block/not block triggers which come from ME1/A] = " << mpc_block_me1a << "\n";
642  strm << " alct_trig_enable [allow ALCT-only triggers] = " << alct_trig_enable << "\n";
643  strm << " clct_trig_enable [allow CLCT-only triggers] = " << clct_trig_enable << "\n";
644  strm << " match_trig_enable [allow matched ALCT-CLCT triggers] = " << match_trig_enable << "\n";
645  strm << " match_trig_window_size [ALCT-CLCT match window width, in 25 ns] = " << match_trig_window_size << "\n";
646  strm << " tmb_l1a_window_size [L1Accept window width, in 25 ns bins] = " << tmb_l1a_window_size << "\n";
647  strm << "++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n";
648  LogDebug("CSCMotherboard") << strm.str();
649 }
unsigned int clct_trig_enable
unsigned int match_trig_window_size
unsigned int mpc_block_me1a
unsigned int tmb_l1a_window_size
unsigned int match_trig_enable
unsigned int alct_trig_enable
#define LogDebug(id)

◆ encodeHighMultiplicityBits()

void CSCMotherboard::encodeHighMultiplicityBits ( )
protected

Definition at line 712 of file CSCMotherboard.cc.

References alctProc, clctProc, filterCSVwithJSON::copy, matchShowers(), CSCConstants::MAX_ALCT_TBINS, CSCConstants::MAX_CLCT_TBINS, showers_, and thisShowerSource_.

Referenced by CSCGEMMotherboard::run(), and run().

712  {
713  // get the high multiplicity
714  // for anode this reflects what is already in the anode CSCShowerDigi object
717  auto cshowers_v = clctProc->getAllShower();
718  auto ashowers_v = alctProc->getAllShower();
719 
720  std::copy(cshowers_v.begin(), cshowers_v.end(), cathode_showers);
721  std::copy(ashowers_v.begin(), ashowers_v.end(), anode_showers);
722 
723  // set the value according to source
724  switch (thisShowerSource_) {
725  case 0:
726  std::copy(std::begin(cathode_showers), std::end(cathode_showers), std::begin(showers_));
727  break;
728  case 1:
729  std::copy(std::begin(anode_showers), std::end(anode_showers), std::begin(showers_));
730  break;
731  case 2:
732  matchShowers(anode_showers, cathode_showers, false);
733  break;
734  case 3:
735  matchShowers(anode_showers, cathode_showers, true);
736  break;
737  default:
738  std::copy(std::begin(anode_showers), std::end(anode_showers), std::begin(showers_));
739  break;
740  };
741 }
unsigned thisShowerSource_
CSCShowerDigi showers_[CSCConstants::MAX_LCT_TBINS]
void matchShowers(CSCShowerDigi *anode_showers, CSCShowerDigi *cathode_showers, bool andlogic)
std::unique_ptr< CSCCathodeLCTProcessor > clctProc
std::unique_ptr< CSCAnodeLCTProcessor > alctProc

◆ encodePattern()

unsigned int CSCMotherboard::encodePattern ( const int  clctPattern) const
protected

Definition at line 535 of file CSCMotherboard.cc.

References funct::abs(), and topSingleLeptonDQM_PU_cfi::pattern.

Referenced by constructLCTs(), and CSCGEMMotherboard::constructLCTsGEM().

535  {
536  const int kPatternBitWidth = 4;
537 
538  // In the TMB07 firmware, LCT pattern is just a 4-bit CLCT pattern.
539  unsigned int pattern = (abs(ptn) & ((1 << kPatternBitWidth) - 1));
540 
541  return pattern;
542 }
Abs< T >::type abs(const T &t)
Definition: Abs.h:22

◆ getBXShiftedALCT()

CSCALCTDigi CSCMotherboard::getBXShiftedALCT ( const CSCALCTDigi aLCT) const
protected

Definition at line 651 of file CSCMotherboard.cc.

References CSCConstants::ALCT_CENTRAL_BX, CSCALCTDigi::getBX(), CSCConstants::LCT_CENTRAL_BX, and CSCALCTDigi::setBX().

Referenced by constructLCTs(), and CSCGEMMotherboard::constructLCTsGEM().

651  {
652  CSCALCTDigi aLCT_shifted = aLCT;
653  aLCT_shifted.setBX(aLCT_shifted.getBX() - (CSCConstants::LCT_CENTRAL_BX - CSCConstants::ALCT_CENTRAL_BX));
654  return aLCT_shifted;
655 }
uint16_t getBX() const
return BX - five low bits of BXN counter tagged by the ALCT
Definition: CSCALCTDigi.h:73
void setBX(const uint16_t BX)
set BX
Definition: CSCALCTDigi.h:76

◆ getBXShiftedCLCT()

CSCCLCTDigi CSCMotherboard::getBXShiftedCLCT ( const CSCCLCTDigi cLCT) const
protected

Definition at line 657 of file CSCMotherboard.cc.

References CSCConstants::ALCT_CLCT_OFFSET, CSCCLCTDigi::getBX(), and CSCCLCTDigi::setBX().

Referenced by constructLCTs(), and CSCGEMMotherboard::constructLCTsGEM().

657  {
658  CSCCLCTDigi cLCT_shifted = cLCT;
659  cLCT_shifted.setBX(cLCT_shifted.getBX() - CSCConstants::ALCT_CLCT_OFFSET);
660  return cLCT_shifted;
661 }
uint16_t getBX() const
return BX
Definition: CSCCLCTDigi.h:123
void setBX(const uint16_t bx)
set bx
Definition: CSCCLCTDigi.h:129

◆ matchALCTCLCT()

void CSCMotherboard::matchALCTCLCT ( )
protected

Definition at line 183 of file CSCMotherboard.cc.

References CSCConstants::ALCT_CLCT_OFFSET, alct_trig_enable, CSCCorrelatedLCTDigi::ALCTCLCT, CSCCorrelatedLCTDigi::ALCTONLY, alctProc, allLCTs_, clct_trig_enable, CSCCorrelatedLCTDigi::CLCTONLY, clctProc, correlateLCTs(), drop_used_clcts, CSCBaseboard::infoV, LogTrace, match_earliest_clct_only_, match_trig_window_size, CSCConstants::MAX_ALCT_TBINS, CSCConstants::MAX_CLCT_TBINS, or, preferred_bx_match_, sort_clct_bx_, and sortCLCTByQualBend().

Referenced by run().

183  {
184  // array to mask CLCTs
185  bool used_clct_mask[CSCConstants::MAX_CLCT_TBINS] = {false};
186 
187  // Step 3: ALCT-centric ALCT-to-CLCT matching
188  int bx_clct_matched = 0; // bx of last matched CLCT
189  for (int bx_alct = 0; bx_alct < CSCConstants::MAX_ALCT_TBINS; bx_alct++) {
190  // There should be at least one valid CLCT or ALCT for a
191  // correlated LCT to be formed. Decision on whether to reject
192  // non-complete LCTs (and if yes of which type) is made further
193  // upstream.
194  if (alctProc->getBestALCT(bx_alct).isValid()) {
195  // Look for CLCTs within the match-time window. The window is
196  // centered at the ALCT bx; therefore, we make an assumption
197  // that anode and cathode hits are perfectly synchronized. This
198  // is always true for MC, but only an approximation when the
199  // data is analyzed (which works fairly good as long as wide
200  // windows are used). To get rid of this assumption, one would
201  // need to access "full BX" words, which are not readily
202  // available.
203  bool is_matched = false;
204  // we can use single value to best CLCT but here use vector to keep the
205  // the future option to do multiple ALCT-CLCT matches wiht CLCT from different bx
206  std::vector<unsigned> clctBx_qualbend_match;
207  sortCLCTByQualBend(bx_alct, clctBx_qualbend_match);
208 
209  bool hasLocalShower = false;
210  for (unsigned ibx = 1; ibx <= match_trig_window_size / 2; ibx++)
211  hasLocalShower =
212  (hasLocalShower or clctProc->getLocalShowerFlag(bx_alct - CSCConstants::ALCT_CLCT_OFFSET - ibx));
213 
214  // loop on the preferred "delta BX" array
215  for (unsigned mbx = 0; mbx < match_trig_window_size; mbx++) {
216  // evaluate the preffered CLCT BX, taking into account that there is an offset in the simulation
217  //bx_clct_run2 would be overflow when bx_alct is small but it is okay
218  unsigned bx_clct_run2 = bx_alct + preferred_bx_match_[mbx] - CSCConstants::ALCT_CLCT_OFFSET;
219  unsigned bx_clct_qualbend = clctBx_qualbend_match[mbx];
220  unsigned bx_clct = (sort_clct_bx_ or not(hasLocalShower)) ? bx_clct_run2 : bx_clct_qualbend;
221  // check that the CLCT BX is valid
222  if (bx_clct >= CSCConstants::MAX_CLCT_TBINS)
223  continue;
224  // do not consider previously matched CLCTs
225  if (drop_used_clcts && used_clct_mask[bx_clct])
226  continue;
227  // only consider >=4 layer CLCTs for ALCT-CLCT type LCTs
228  // this condition is lowered to >=3 layers for CLCTs in the
229  // matchALCTCLCTGEM function
230  if (clctProc->getBestCLCT(bx_clct).getQuality() <= 3)
231  continue;
232  // a valid CLCT with sufficient layers!
233  if (clctProc->getBestCLCT(bx_clct).isValid()) {
234  if (infoV > 1)
235  LogTrace("CSCMotherboard") << "Successful ALCT-CLCT match: bx_alct = " << bx_alct
236  << "; bx_clct = " << bx_clct << "; mbx = " << mbx;
237  // now correlate the ALCT and CLCT into LCT.
238  // smaller mbx means more preferred!
239  correlateLCTs(alctProc->getBestALCT(bx_alct),
240  alctProc->getSecondALCT(bx_alct),
241  clctProc->getBestCLCT(bx_clct),
242  clctProc->getSecondCLCT(bx_clct),
243  allLCTs_(bx_alct, mbx, 0),
244  allLCTs_(bx_alct, mbx, 1),
246  // when the first LCT is valid, you can mask the matched CLCT and/or
247  // move on to the next ALCT if match_earliest_clct_only_ is set to true
248  if (allLCTs_(bx_alct, mbx, 0).isValid()) {
249  is_matched = true;
250  used_clct_mask[bx_clct] = true;
251  bx_clct_matched = bx_clct;
253  break;
254  }
255  }
256  }
257  // No CLCT within the match time interval found: report ALCT-only LCT
258  // (use dummy CLCTs).
259  if (!is_matched) {
260  if (infoV > 1)
261  LogTrace("CSCMotherboard") << "Unsuccessful ALCT-CLCT match (ALCT only): bx_alct = " << bx_alct
262  << " first ALCT " << alctProc->getBestALCT(bx_alct);
263  if (alct_trig_enable)
264  correlateLCTs(alctProc->getBestALCT(bx_alct),
265  alctProc->getSecondALCT(bx_alct),
266  clctProc->getBestCLCT(bx_alct),
267  clctProc->getSecondCLCT(bx_alct),
268  allLCTs_(bx_alct, 0, 0),
269  allLCTs_(bx_alct, 0, 1),
271  }
272  }
273  // No valid ALCTs; attempt to make CLCT-only LCT. Use only CLCTs
274  // which have zeroth chance to be matched at later cathode times.
275  // (I am not entirely sure this perfectly matches the firmware logic.)
276  // Use dummy ALCTs.
277  else {
278  int bx_clct = bx_alct - match_trig_window_size / 2;
279  if (bx_clct >= 0 && bx_clct > bx_clct_matched) {
280  if (clctProc->getBestCLCT(bx_clct).isValid() and clct_trig_enable) {
281  if (infoV > 1)
282  LogTrace("CSCMotherboard") << "Unsuccessful ALCT-CLCT match (CLCT only): bx_clct = " << bx_clct;
283  correlateLCTs(alctProc->getBestALCT(bx_alct),
284  alctProc->getSecondALCT(bx_alct),
285  clctProc->getBestCLCT(bx_clct),
286  clctProc->getSecondCLCT(bx_clct),
287  allLCTs_(bx_clct, 0, 0),
288  allLCTs_(bx_clct, 0, 1),
290  }
291  }
292  }
293  }
294 }
LCTContainer allLCTs_
unsigned int clct_trig_enable
unsigned int match_trig_window_size
std::unique_ptr< CSCCathodeLCTProcessor > clctProc
#define LogTrace(id)
void correlateLCTs(const CSCALCTDigi &bestALCT, const CSCALCTDigi &secondALCT, const CSCCLCTDigi &bestCLCT, const CSCCLCTDigi &secondCLCT, CSCCorrelatedLCTDigi &bLCT, CSCCorrelatedLCTDigi &sLCT, int type) const
std::vector< int > preferred_bx_match_
bool match_earliest_clct_only_
The Signals That Services Can Subscribe To This is based on ActivityRegistry and is current per Services can connect to the signals distributed by the ActivityRegistry in order to monitor the activity of the application Each possible callback has some defined which we here list in angle e< void, edm::EventID const &, edm::Timestamp const & > We also list in braces which AR_WATCH_USING_METHOD_ is used for those or
Definition: Activities.doc:12
void sortCLCTByQualBend(int alct_bx, std::vector< unsigned > &clctBxVector)
unsigned int alct_trig_enable
std::unique_ptr< CSCAnodeLCTProcessor > alctProc

◆ matchShowers()

void CSCMotherboard::matchShowers ( CSCShowerDigi anode_showers,
CSCShowerDigi cathode_showers,
bool  andlogic 
)
protected

Definition at line 663 of file CSCMotherboard.cc.

References CSCConstants::ALCT_CLCT_OFFSET, simKBmtfDigis_cfi::bx, CSCShowerDigi::getComparatorNHits(), CSCShowerDigi::getCSCID(), CSCShowerDigi::getWireNHits(), CSCShowerDigi::isLooseInTime(), CSCShowerDigi::isNominalInTime(), CSCShowerDigi::isTightInTime(), CSCShowerDigi::isValid(), sistrip::SpyUtilities::isValid(), match_trig_window_size, CSCConstants::MAX_ALCT_TBINS, CSCConstants::MAX_CLCT_TBINS, or, preferred_bx_match_, and showers_.

Referenced by encodeHighMultiplicityBits().

663  {
664  CSCShowerDigi ashower, cshower;
665  bool used_cshower_mask[CSCConstants::MAX_CLCT_TBINS] = {false};
666  for (unsigned bx = 0; bx < CSCConstants::MAX_ALCT_TBINS; bx++) {
667  ashower = anode_showers[bx];
668  cshower = CSCShowerDigi(); //use empty shower digi to initialize cshower
669  if (ashower.isValid()) {
670  for (unsigned mbx = 0; mbx < match_trig_window_size; mbx++) {
672  //check bx range [0, CSCConstants::MAX_LCT_TBINS]
673  if (cbx < 0 || cbx >= CSCConstants::MAX_CLCT_TBINS)
674  continue;
675  if (cathode_showers[cbx].isValid() and not used_cshower_mask[cbx]) {
676  cshower = cathode_showers[cbx];
677  used_cshower_mask[cbx] = true;
678  break;
679  }
680  }
681  } else
682  cshower = cathode_showers[bx]; //if anode shower is not valid, use the cshower from this bx
683 
684  //matched HMT, with and/or logic
685  unsigned matchHMT = 0;
686  if (andlogic) {
687  if (ashower.isTightInTime() and cshower.isTightInTime())
688  matchHMT = 3;
689  else if (ashower.isNominalInTime() and cshower.isNominalInTime())
690  matchHMT = 2;
691  else if (ashower.isLooseInTime() and cshower.isLooseInTime())
692  matchHMT = 1;
693  } else {
694  if (ashower.isTightInTime() or cshower.isTightInTime())
695  matchHMT = 3;
696  else if (ashower.isNominalInTime() or cshower.isNominalInTime())
697  matchHMT = 2;
698  else if (ashower.isLooseInTime() or cshower.isLooseInTime())
699  matchHMT = 1;
700  }
701  //LCTShower with showerType = 3
702  showers_[bx] = CSCShowerDigi(matchHMT & 3,
703  false,
704  ashower.getCSCID(),
705  bx,
706  CSCShowerDigi::ShowerType::kLCTShower,
707  ashower.getWireNHits(),
708  cshower.getComparatorNHits());
709  }
710 }
const bool isValid(const Frame &aFrame, const FrameQuality &aQuality, const uint16_t aExpectedPos)
unsigned int match_trig_window_size
bool isValid() const
data
uint16_t getComparatorNHits() const
Definition: CSCShowerDigi.h:55
CSCShowerDigi showers_[CSCConstants::MAX_LCT_TBINS]
bool isLooseInTime() const
bool isTightInTime() const
std::vector< int > preferred_bx_match_
The Signals That Services Can Subscribe To This is based on ActivityRegistry and is current per Services can connect to the signals distributed by the ActivityRegistry in order to monitor the activity of the application Each possible callback has some defined which we here list in angle e< void, edm::EventID const &, edm::Timestamp const & > We also list in braces which AR_WATCH_USING_METHOD_ is used for those or
Definition: Activities.doc:12
bool isNominalInTime() const
uint16_t getCSCID() const
Definition: CSCShowerDigi.h:52
uint16_t getWireNHits() const
Definition: CSCShowerDigi.h:54

◆ readoutLCTs()

std::vector< CSCCorrelatedLCTDigi > CSCMotherboard::readoutLCTs ( ) const
virtual

Definition at line 299 of file CSCMotherboard.cc.

References simKBmtfDigis_cfi::bx, CSCBaseboard::infoV, CSCBaseboard::isME11_, CSCConstants::LCT_CENTRAL_BX, lctV, LogDebug, CSCConstants::MAX_HALF_STRIP_ME1B, CSCConstants::MAX_LCT_TBINS, mpc_block_me1a, qualityControl_, readout_earliest_2, and tmb_l1a_window_size.

Referenced by CSCTriggerPrimitivesBuilder::build().

299  {
300  // temporary container for further selection
301  std::vector<CSCCorrelatedLCTDigi> tmpV;
302 
303  /*
304  LCTs in the BX window [early_tbin,...,late_tbin] are considered good for physics
305  The central LCT BX is time bin 8.
306  For tmb_l1a_window_size set to 7 (Run-1, Run-2), the window is [5, 6, 7, 8, 9, 10, 11]
307  For tmb_l1a_window_size set to 5 (Run-3), the window is [6, 7, 8, 9, 10]
308  For tmb_l1a_window_size set to 3 (Run-4?), the window is [ 7, 8, 9]
309  */
310  const unsigned delta_tbin = tmb_l1a_window_size / 2;
311  int early_tbin = CSCConstants::LCT_CENTRAL_BX - delta_tbin;
312  int late_tbin = CSCConstants::LCT_CENTRAL_BX + delta_tbin;
313  /*
314  Special case for an even-numbered time-window,
315  For instance tmb_l1a_window_size set to 6: [5, 6, 7, 8, 9, 10]
316  */
317  if (tmb_l1a_window_size % 2 == 0)
318  late_tbin = CSCConstants::LCT_CENTRAL_BX + delta_tbin - 1;
319  const int max_late_tbin = CSCConstants::MAX_LCT_TBINS - 1;
320 
321  // debugging messages when early_tbin or late_tbin has a suspicious value
322  if (early_tbin < 0) {
323  edm::LogWarning("CSCMotherboard|SuspiciousParameters")
324  << "Early time bin (early_tbin) smaller than minimum allowed, which is 0. set early_tbin to 0.";
325  early_tbin = 0;
326  }
327  if (late_tbin > max_late_tbin) {
328  edm::LogWarning("CSCMotherboard|SuspiciousParameters")
329  << "Late time bin (late_tbin) larger than maximum allowed, which is " << max_late_tbin
330  << ". set early_tbin to max allowed";
331  late_tbin = CSCConstants::MAX_LCT_TBINS - 1;
332  }
333 
334  // Start from the vector of all found correlated LCTs and select
335  // those within the LCT*L1A coincidence window.
336  int bx_readout = -1;
337  for (const auto& lct : lctV) {
338  // extra check on invalid LCTs
339  if (!lct.isValid()) {
340  continue;
341  }
342 
343  const int bx = lct.getBX();
344  // Skip LCTs found too early relative to L1Accept.
345  if (bx < early_tbin) {
346  if (infoV > 1)
347  LogDebug("CSCMotherboard") << " Do not report correlated LCT on key halfstrip " << lct.getStrip()
348  << " and key wire " << lct.getKeyWG() << ": found at bx " << bx
349  << ", whereas the earliest allowed bx is " << early_tbin;
350  continue;
351  }
352 
353  // Skip LCTs found too late relative to L1Accept.
354  if (bx > late_tbin) {
355  if (infoV > 1)
356  LogDebug("CSCMotherboard") << " Do not report correlated LCT on key halfstrip " << lct.getStrip()
357  << " and key wire " << lct.getKeyWG() << ": found at bx " << bx
358  << ", whereas the latest allowed bx is " << late_tbin;
359  continue;
360  }
361 
362  // Do not report LCTs found in ME1/A if mpc_block_me1a is set.
363  if (mpc_block_me1a and isME11_ and lct.getStrip() > CSCConstants::MAX_HALF_STRIP_ME1B) {
364  continue;
365  }
366 
367  // If (readout_earliest_2) take only LCTs in the earliest bx in the read-out window:
368  // in digi->raw step, LCTs have to be packed into the TMB header, and
369  // currently there is room just for two.
370  if (readout_earliest_2) {
371  if (bx_readout == -1 || bx == bx_readout) {
372  tmpV.push_back(lct);
373  if (bx_readout == -1)
374  bx_readout = bx;
375  }
376  }
377  // if readout_earliest_2 == false, save all LCTs
378  else {
379  tmpV.push_back(lct);
380  }
381  }
382 
383  // do a final check on the LCTs in readout
384  qualityControl_->checkMultiplicityBX(tmpV);
385  for (const auto& lct : tmpV) {
386  qualityControl_->checkValid(lct);
387  /*std::cout << "\n########################################## Emu LCT ##########################################\n" << std::endl;
388  std::cout << "Emu LCT: " << lct << std::endl;
389  std::cout << "\n########################################## THE END ##########################################\n" << std::endl;*/
390  }
391 
392  return tmpV;
393 }
std::vector< CSCCorrelatedLCTDigi > lctV
unsigned int mpc_block_me1a
unsigned int tmb_l1a_window_size
Log< level::Warning, false > LogWarning
std::unique_ptr< LCTQualityControl > qualityControl_
#define LogDebug(id)

◆ readoutShower()

std::vector< CSCShowerDigi > CSCMotherboard::readoutShower ( ) const

Returns shower bits

Definition at line 395 of file CSCMotherboard.cc.

References simKBmtfDigis_cfi::bx, sistrip::SpyUtilities::isValid(), CSCConstants::LCT_CENTRAL_BX, maxbx_readout_, hltL1TEGammaFilteredCollectionProducer_cfi::minBX, minbx_readout_, showers_, and tmb_l1a_window_size.

Referenced by CSCTriggerPrimitivesBuilder::build().

395  {
396  unsigned minBXdiff = 2 * tmb_l1a_window_size; //impossible value
397  unsigned minBX = 0;
398  std::vector<CSCShowerDigi> showerOut;
399  for (unsigned bx = minbx_readout_; bx < maxbx_readout_; bx++) {
402  if (showers_[bx].isValid() and bx_diff < minBXdiff) {
403  minBXdiff = bx_diff;
404  minBX = bx;
405  }
406  }
407 
408  for (unsigned bx = minbx_readout_; bx < maxbx_readout_; bx++)
409  if (bx == minBX)
410  showerOut.push_back(showers_[bx]);
411  return showerOut;
412 }
unsigned maxbx_readout_
const bool isValid(const Frame &aFrame, const FrameQuality &aQuality, const uint16_t aExpectedPos)
CSCShowerDigi showers_[CSCConstants::MAX_LCT_TBINS]
unsigned minbx_readout_
unsigned int tmb_l1a_window_size

◆ run()

void CSCMotherboard::run ( const CSCWireDigiCollection wiredc,
const CSCComparatorDigiCollection compdc 
)

Run function for normal usage. Runs cathode and anode LCT processors, takes results and correlates into CorrelatedLCT.

Definition at line 146 of file CSCMotherboard.cc.

References alctProc, alctV, clctProc, clctV, clear(), CSCBaseboard::cscGeometry_, encodeHighMultiplicityBits(), lookupTableCCLUT_, matchALCTCLCT(), CSCBaseboard::runCCLUT_, and selectLCTs().

Referenced by CSCTriggerPrimitivesBuilder::build().

146  {
147  // Step 1: Setup
148  clear();
149 
150  // Check for existing processors
151  if (!(alctProc && clctProc)) {
152  edm::LogError("CSCMotherboard|SetupError") << "+++ run() called for non-existing ALCT/CLCT processor! +++ \n";
153  return;
154  }
155 
156  // set geometry
157  alctProc->setCSCGeometry(cscGeometry_);
158  clctProc->setCSCGeometry(cscGeometry_);
159 
160  // set CCLUT parameters if necessary
161  if (runCCLUT_) {
162  clctProc->setESLookupTables(lookupTableCCLUT_);
163  }
164 
165  // Step 2: Run the processors
166  alctV = alctProc->run(wiredc); // run anodeLCT
167  clctV = clctProc->run(compdc); // run cathodeLCT
168 
169  // Step 2b: encode high multiplicity bits (independent of LCT construction)
171 
172  // if there are no ALCTs and no CLCTs, it does not make sense to run this TMB
173  if (alctV.empty() and clctV.empty())
174  return;
175 
176  // step 3: match the ALCTs to the CLCTs
177  matchALCTCLCT();
178 
179  // Step 4: Select at most 2 LCTs per BX
180  selectLCTs();
181 }
std::vector< CSCCLCTDigi > clctV
std::unique_ptr< CSCCathodeLCTProcessor > clctProc
Log< level::Error, false > LogError
std::vector< CSCALCTDigi > alctV
const CSCGeometry * cscGeometry_
Definition: CSCBaseboard.h:71
std::unique_ptr< CSCAnodeLCTProcessor > alctProc
const CSCL1TPLookupTableCCLUT * lookupTableCCLUT_
void encodeHighMultiplicityBits()

◆ selectLCTs()

void CSCMotherboard::selectLCTs ( )

Definition at line 544 of file CSCMotherboard.cc.

References allLCTs_, simKBmtfDigis_cfi::bx, mps_fire::i, CSCBaseboard::infoV, sistrip::SpyUtilities::isValid(), lctV, LogDebug, match_trig_window_size, CSCConstants::MAX_LCT_TBINS, and CSCConstants::MAX_LCTS_PER_CSC.

Referenced by CSCGEMMotherboard::run(), and run().

544  {
545  // in each of the LCT time bins
546  for (int bx = 0; bx < CSCConstants::MAX_LCT_TBINS; bx++) {
547  unsigned nLCTs = 0;
548 
549  std::vector<CSCCorrelatedLCTDigi> tempV;
550  // check each of the preferred combinations
551  for (unsigned int mbx = 0; mbx < match_trig_window_size; mbx++) {
552  // select at most 2
553  for (int i = 0; i < CSCConstants::MAX_LCTS_PER_CSC; i++) {
554  if (allLCTs_(bx, mbx, i).isValid() and nLCTs < 2) {
555  tempV.push_back(allLCTs_(bx, mbx, i));
556  ++nLCTs;
557  }
558  }
559  }
560  // store the best 2
561  for (const auto& lct : tempV) {
562  lctV.push_back(lct);
563  }
564  }
565 
566  // Show the pre-selected LCTs. They're not final yet. Some selection is done in the readoutLCTs function
567  if (infoV > 0) {
568  for (const auto& lct : lctV) {
569  LogDebug("CSCMotherboard") << "Selected LCT" << lct;
570  }
571  }
572 }
LCTContainer allLCTs_
const bool isValid(const Frame &aFrame, const FrameQuality &aQuality, const uint16_t aExpectedPos)
unsigned int match_trig_window_size
std::vector< CSCCorrelatedLCTDigi > lctV
#define LogDebug(id)

◆ setConfigParameters()

void CSCMotherboard::setConfigParameters ( const CSCDBL1TPParameters conf)

Set configuration parameters obtained via EventSetup mechanism.

Definition at line 115 of file CSCMotherboard.cc.

References alct_trig_enable, alctProc, checkConfigParameters(), clct_trig_enable, clctProc, dumpConfigParams(), CSCConstants::LCT_CENTRAL_BX, match_trig_enable, match_trig_window_size, maxbx_readout_, minbx_readout_, mpc_block_me1a, tmb_l1a_window_size, CSCDBL1TPParameters::tmbAlctTrigEnable(), CSCDBL1TPParameters::tmbClctTrigEnable(), CSCDBL1TPParameters::tmbMatchTrigEnable(), CSCDBL1TPParameters::tmbMatchTrigWindowSize(), CSCDBL1TPParameters::tmbMpcBlockMe1a(), and CSCDBL1TPParameters::tmbTmbL1aWindowSize().

115  {
116  static std::atomic<bool> config_dumped{false};
117 
118  // Config. parameters for the TMB itself.
125 
126  // Config. paramteres for ALCT and CLCT processors.
127  alctProc->setConfigParameters(conf);
128  clctProc->setConfigParameters(conf);
129 
130  // Check and print configuration parameters.
132  if (!config_dumped) {
134  config_dumped = true;
135  }
138 }
unsigned maxbx_readout_
unsigned int clct_trig_enable
unsigned int match_trig_window_size
unsigned int tmbMpcBlockMe1a() const
std::unique_ptr< CSCCathodeLCTProcessor > clctProc
unsigned int tmbTmbL1aWindowSize() const
unsigned int mpc_block_me1a
unsigned minbx_readout_
unsigned int tmbMatchTrigWindowSize() const
void dumpConfigParams() const
unsigned int tmb_l1a_window_size
void checkConfigParameters()
unsigned int match_trig_enable
unsigned int tmbMatchTrigEnable() const
unsigned int alct_trig_enable
std::unique_ptr< CSCAnodeLCTProcessor > alctProc
unsigned int tmbClctTrigEnable() const
unsigned int tmbAlctTrigEnable() const

◆ setESLookupTables() [1/3]

void CSCMotherboard::setESLookupTables ( const CSCL1TPLookupTableCCLUT conf)

Definition at line 140 of file CSCMotherboard.cc.

References lookupTableCCLUT_.

140 { lookupTableCCLUT_ = conf; }
const CSCL1TPLookupTableCCLUT * lookupTableCCLUT_

◆ setESLookupTables() [2/3]

void CSCMotherboard::setESLookupTables ( const CSCL1TPLookupTableME11ILT conf)

Definition at line 142 of file CSCMotherboard.cc.

References lookupTableME11ILT_.

142 { lookupTableME11ILT_ = conf; }
const CSCL1TPLookupTableME11ILT * lookupTableME11ILT_

◆ setESLookupTables() [3/3]

void CSCMotherboard::setESLookupTables ( const CSCL1TPLookupTableME21ILT conf)

Definition at line 144 of file CSCMotherboard.cc.

References lookupTableME21ILT_.

144 { lookupTableME21ILT_ = conf; }
const CSCL1TPLookupTableME21ILT * lookupTableME21ILT_

◆ sortCLCTByQualBend()

void CSCMotherboard::sortCLCTByQualBend ( int  alct_bx,
std::vector< unsigned > &  clctBxVector 
)
protected

Definition at line 574 of file CSCMotherboard.cc.

References CSCConstants::ALCT_CLCT_OFFSET, simKBmtfDigis_cfi::bx, clctProc, CSCCLCTDigi::getPattern(), CSCCLCTDigi::getQuality(), CSCCLCTDigi::getSlope(), CSCCLCTDigi::isRun3(), match_trig_window_size, CSCConstants::MAX_CLCT_TBINS, and preferred_bx_match_.

Referenced by matchALCTCLCT(), and CSCGEMMotherboard::matchALCTCLCTGEM().

574  {
575  //find clct bx range in [centerbx-window_size/2, center_bx+window_size/2]
576  //Then sort CLCT based quality+bend within the match window
577  //if two CLCTs from different BX has same qual+bend, the in-time one has higher priority
578  clctBxVector.clear();
579  int clctQualBendArray[CSCConstants::MAX_CLCT_TBINS + 1] = {0};
580  for (unsigned mbx = 0; mbx < match_trig_window_size; mbx++) {
581  unsigned bx_clct = bx_alct + preferred_bx_match_[mbx] - CSCConstants::ALCT_CLCT_OFFSET;
582  int tempQualBend = 0;
583  if (bx_clct >= CSCConstants::MAX_CLCT_TBINS)
584  continue;
585  if (!clctProc->getBestCLCT(bx_clct).isValid()) {
586  clctQualBendArray[bx_clct] = tempQualBend;
587  continue;
588  }
589  CSCCLCTDigi bestCLCT = clctProc->getBestCLCT(bx_clct);
590  //for run2 pattern, ignore direction and use &0xe
591  //for run3, slope=0 is straighest pattern
592  int clctBend = bestCLCT.isRun3() ? (16 - bestCLCT.getSlope()) : (bestCLCT.getPattern() & 0xe);
593  //shift quality to left for 4 bits
594  int clctQualBend = clctBend | (bestCLCT.getQuality() << 5);
595  clctQualBendArray[bx_clct] = clctQualBend;
596  if (clctBxVector.empty())
597  clctBxVector.push_back(bx_clct);
598  else {
599  for (auto it = clctBxVector.begin(); it != clctBxVector.end(); it++)
600  if (clctQualBend > clctQualBendArray[*it]) { //insert the Bx with better clct
601  clctBxVector.insert(it, bx_clct);
602  break;
603  }
604  }
605  }
606  //fill rest of vector with MAX_CLCT_TBINS
607  for (unsigned bx = clctBxVector.size(); bx < match_trig_window_size; bx++)
608  clctBxVector.push_back(CSCConstants::MAX_CLCT_TBINS);
609 }
unsigned int match_trig_window_size
uint16_t getQuality() const
return quality of a pattern (number of layers hit!)
Definition: CSCCLCTDigi.h:56
std::unique_ptr< CSCCathodeLCTProcessor > clctProc
bool isRun3() const
Distinguish Run-1/2 from Run-3.
Definition: CSCCLCTDigi.h:195
std::vector< int > preferred_bx_match_
uint16_t getPattern() const
return pattern
Definition: CSCCLCTDigi.h:62
uint16_t getSlope() const
return the slope
Definition: CSCCLCTDigi.h:74

Member Data Documentation

◆ alct_trig_enable

unsigned int CSCMotherboard::alct_trig_enable
protected

◆ alctProc

std::unique_ptr<CSCAnodeLCTProcessor> CSCMotherboard::alctProc

◆ alctV

std::vector<CSCALCTDigi> CSCMotherboard::alctV
protected

Definition at line 117 of file CSCMotherboard.h.

Referenced by clear(), CSCGEMMotherboard::run(), and run().

◆ allLCTs_

LCTContainer CSCMotherboard::allLCTs_
protected

Container with all LCTs prior to sorting and selecting.

Definition at line 121 of file CSCMotherboard.h.

Referenced by clear(), CSCMotherboard(), matchALCTCLCT(), CSCGEMMotherboard::matchALCTCLCTGEM(), and selectLCTs().

◆ clct_trig_enable

unsigned int CSCMotherboard::clct_trig_enable
protected

◆ clctProc

std::unique_ptr<CSCCathodeLCTProcessor> CSCMotherboard::clctProc

◆ clctV

std::vector<CSCCLCTDigi> CSCMotherboard::clctV
protected

Definition at line 118 of file CSCMotherboard.h.

Referenced by clear(), CSCGEMMotherboard::run(), and run().

◆ cscOverlap_

std::unique_ptr<CSCALCTCrossCLCT> CSCMotherboard::cscOverlap_
protected

Definition at line 185 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), and doesALCTCrossCLCT().

◆ def_alct_trig_enable

const unsigned int CSCMotherboard::def_alct_trig_enable = 0
staticprotected

Definition at line 169 of file CSCMotherboard.h.

Referenced by checkConfigParameters().

◆ def_clct_trig_enable

const unsigned int CSCMotherboard::def_clct_trig_enable = 0
staticprotected

Definition at line 169 of file CSCMotherboard.h.

Referenced by checkConfigParameters().

◆ def_match_trig_enable

const unsigned int CSCMotherboard::def_match_trig_enable = 1
staticprotected

Definition at line 170 of file CSCMotherboard.h.

Referenced by checkConfigParameters().

◆ def_match_trig_window_size

const unsigned int CSCMotherboard::def_match_trig_window_size = 7
staticprotected

Definition at line 170 of file CSCMotherboard.h.

Referenced by checkConfigParameters().

◆ def_mpc_block_me1a

const unsigned int CSCMotherboard::def_mpc_block_me1a = 1
staticprotected

Default values of configuration parameters.

Definition at line 168 of file CSCMotherboard.h.

Referenced by checkConfigParameters().

◆ def_tmb_l1a_window_size

const unsigned int CSCMotherboard::def_tmb_l1a_window_size = 7
staticprotected

Definition at line 171 of file CSCMotherboard.h.

Referenced by checkConfigParameters().

◆ drop_used_clcts

bool CSCMotherboard::drop_used_clcts
protected

Phase2: whether to not reuse CLCTs that were used by previous matching ALCTs

Definition at line 138 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), and matchALCTCLCT().

◆ early_tbins

int CSCMotherboard::early_tbins
protected

Phase2: separate handle for early time bins

Definition at line 141 of file CSCMotherboard.h.

Referenced by CSCMotherboard().

◆ ignoreAlctCrossClct_

bool CSCMotherboard::ignoreAlctCrossClct_
protected

Definition at line 155 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), and doesALCTCrossCLCT().

◆ lctV

std::vector<CSCCorrelatedLCTDigi> CSCMotherboard::lctV
protected

Definition at line 124 of file CSCMotherboard.h.

Referenced by clear(), readoutLCTs(), and selectLCTs().

◆ lookupTableCCLUT_

const CSCL1TPLookupTableCCLUT* CSCMotherboard::lookupTableCCLUT_
protected

Definition at line 112 of file CSCMotherboard.h.

Referenced by CSCGEMMotherboard::run(), run(), and setESLookupTables().

◆ lookupTableME11ILT_

const CSCL1TPLookupTableME11ILT* CSCMotherboard::lookupTableME11ILT_
protected

Definition at line 113 of file CSCMotherboard.h.

Referenced by CSCGEMMotherboard::run(), and setESLookupTables().

◆ lookupTableME21ILT_

const CSCL1TPLookupTableME21ILT* CSCMotherboard::lookupTableME21ILT_
protected

Definition at line 114 of file CSCMotherboard.h.

Referenced by CSCGEMMotherboard::run(), and setESLookupTables().

◆ match_earliest_clct_only_

bool CSCMotherboard::match_earliest_clct_only_
protected

Definition at line 147 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), and matchALCTCLCT().

◆ match_trig_enable

unsigned int CSCMotherboard::match_trig_enable
protected

◆ match_trig_window_size

unsigned int CSCMotherboard::match_trig_window_size
protected

◆ maxbx_readout_

unsigned CSCMotherboard::maxbx_readout_
protected

Definition at line 153 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), readoutShower(), and setConfigParameters().

◆ minbx_readout_

unsigned CSCMotherboard::minbx_readout_
protected

Definition at line 152 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), readoutShower(), and setConfigParameters().

◆ mpc_block_me1a

unsigned int CSCMotherboard::mpc_block_me1a
protected

Configuration parameters.

Definition at line 133 of file CSCMotherboard.h.

Referenced by checkConfigParameters(), CSCMotherboard(), dumpConfigParams(), readoutLCTs(), and setConfigParameters().

◆ preferred_bx_match_

std::vector<int> CSCMotherboard::preferred_bx_match_
protected

◆ qualityAssignment_

std::unique_ptr<LCTQualityAssignment> CSCMotherboard::qualityAssignment_
protected

◆ qualityControl_

std::unique_ptr<LCTQualityControl> CSCMotherboard::qualityControl_
protected

Definition at line 177 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), and readoutLCTs().

◆ readout_earliest_2

bool CSCMotherboard::readout_earliest_2
protected

Phase2: whether to readout only the earliest two LCTs in readout window

Definition at line 144 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), and readoutLCTs().

◆ showers_

CSCShowerDigi CSCMotherboard::showers_[CSCConstants::MAX_LCT_TBINS]
protected

Definition at line 126 of file CSCMotherboard.h.

Referenced by clear(), encodeHighMultiplicityBits(), matchShowers(), and readoutShower().

◆ showerSource_

std::vector<unsigned> CSCMotherboard::showerSource_
protected

Definition at line 150 of file CSCMotherboard.h.

Referenced by CSCMotherboard().

◆ sort_clct_bx_

bool CSCMotherboard::sort_clct_bx_
protected

◆ thisShowerSource_

unsigned CSCMotherboard::thisShowerSource_
protected

Definition at line 151 of file CSCMotherboard.h.

Referenced by CSCMotherboard(), and encodeHighMultiplicityBits().

◆ tmb_l1a_window_size

unsigned int CSCMotherboard::tmb_l1a_window_size
protected