CMS 3D CMS Logo

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
List of all members | Public Types | Public Member Functions | Static Public Attributes | Private Member Functions | Private Attributes | Static Private Attributes
EcalSelectiveReadout Class Reference

#include <EcalSelectiveReadout.h>

Public Types

enum  towerInterest_t {
  UNKNOWN = -1 & ~FORCED_MASK, LOWINTEREST = 0x0, SINGLE = 0x1, NEIGHBOUR = 0x2,
  CENTER = 0x3, FORCED_LOWINTEREST = 0x4, FORCED_SINGLE = 0x5, FORCED_NEIGHBOUR = 0x6,
  FORCED_CENTER = 0x7
}
 
enum  ttFlag_t {
  TTF_UNKNOWN = -1, TTF_LOW_INTEREST = 0x0, TTF_MID_INTEREST = 0x1, TTF_HIGH_INTEREST = 0X3,
  TTF_FORCED_LOW_INTEREST = 0x4, TTF_FORCED_MID_INTEREST = 0x5, TTF_FORCED_HIGH_INTEREST = 0x7
}
 

Public Member Functions

 EcalSelectiveReadout (int dEta=1, int dPhi=1)
 
towerInterest_t getCrystalInterest (const EBDetId &ebDetId) const
 
towerInterest_t getCrystalInterest (const EEDetId &eeDetId) const
 
towerInterest_t getSuperCrystalInterest (const EcalScDetId &scDetId) const
 
towerInterest_t getTowerInterest (const EcalTrigTowerDetId &towerId) const
 
void print (std::ostream &os) const
 print out the map More...
 
void printBarrel (std::ostream &os) const
 
void printEndcap (int endcap, std::ostream &s) const
 
void printHeader (std::ostream &os) const
 print out header for the map: see print(std::ostream&) More...
 
void runSelectiveReadout0 (const ttFlag_t towerFlags[nTriggerTowersInEta][nTriggerTowersInPhi])
 
void setElecMap (const EcalElectronicsMapping *map)
 
void setTriggerMap (const EcalTrigTowerConstituentsMap *map)
 the mapping of which cell goes with which trigger tower More...
 

Static Public Attributes

static const int FORCED_MASK = 0x4
 
static const int maxDccChs = 68
 
static const size_t nBarrelEtaBins = 170
 
static const size_t nBarrelPhiBins = 360
 
static const size_t nBarrelTowerEtaBins = nBarrelEtaBins / 5
 
static const size_t nBarrelTowerPhiBins = nBarrelPhiBins / 5
 
static const size_t nBarrelTriggerTowersInEta = 34
 
static const int nDccPerEe = 9
 
static const size_t nEndcaps = 2
 
static const size_t nEndcapTriggerTowersInEta = 11
 
static const size_t nEndcapXBins = 100
 
static const size_t nEndcapYBins = 100
 
static const size_t nSupercrystalXBins = nEndcapXBins / supercrystalEdge
 
static const size_t nSupercrystalYBins = nEndcapYBins / supercrystalEdge
 
static const size_t nTriggerTowersInEta = 2 * nEndcapTriggerTowersInEta + nBarrelTriggerTowersInEta
 
static const size_t nTriggerTowersInPhi = 72
 
static const size_t supercrystalEdge = 5
 
static const int TTF_FORCED_RO_MASK = FORCED_MASK
 

Private Member Functions

void classifyTriggerTowers (const ttFlag_t ttFlags[nTriggerTowersInEta][nTriggerTowersInPhi])
 
template<class T >
void combineFlags (T &var, T val) const
 
towerInterest_teeRuInterest (const EEDetId &id)
 
towerInterest_teeRuInterest (const EcalScDetId &id)
 
void printDccChMap (std::ostream &os) const
 
void resetEeRuInterest ()
 
template<class T >
void setHigher (T &var, T val) const
 
void setLower (int &var, int val) const
 

Private Attributes

int dEta
 
int dPhi
 
towerInterest_t eeRuInterest_ [nEndcaps][nDccPerEe][maxDccChs]
 
const EcalElectronicsMappingtheElecMap
 
const EcalTrigTowerConstituentsMaptheTriggerMap
 
towerInterest_t towerInterest [nTriggerTowersInEta][nTriggerTowersInPhi]
 

Static Private Attributes

static const char srpFlagMarker [] = {'.', 'S', 'N', 'C', '4', '5', '6', '7'}
 

Detailed Description

This class is used to run the selective readout processing on the electromagnetic calorimeter. Normal user do not need to access directly this class: the selective readout is made at digitization by the CaloDataFrameFormatter class which uses the EcalSelectiveReadout class for this purpose: see CaloDataFrameFormatter class documentation. The ECAL event size must be reduced by a factor ~1/20th online at the LV1 rate. This reduction is achieved by suppressing channels whose energy, evaluated on line by a FIR, is below a threshold ("zero suppression"). This threshold is dynamic and determined for the channel of each readout unit. A readout unit is a group of 5x5 crystals: a trigger tower for the barrel and a supercrystal for the endcap) basis. The selective readout classifies the readout units in three classes:

. Single, neighbour and center classes consitute the "high interest" readout units and their channels the "high interest" channels. Two zero suppresion thresholds, eventually -/+ infinity, are defined: one for the "Low interest" channels and one for the "high interest" channels. The low interest threshold must be higher than the high interest one.

Note: Forced bit processing:

The trigger tower flag (TTF) issued by the TCC and indicating the level of transverse deposited energy (classified is three levels called low interest, mid interest, high interest), the selective readout flags (SRF) are made of 2 bits. An additionnal bit, called force bit, is used to indicate if some information was missing to compute the flag and if therefore some default value was used. TCC can substitute a default value to a TTF. In such case the forced bit is set. Similarly SRP can substitute a default value to a SRF and set the forced bit accordingly. If the TTF forced bit of a trigger tower is set the SRP propagates it to the SRF by setting the forced bit of every readout unit overlapping with the trigger tower. Note that for the barrel readout units match with trigger towers.

Definition at line 62 of file EcalSelectiveReadout.h.

Member Enumeration Documentation

◆ towerInterest_t

trigger tower classification ("SRP flags")

Enumerator
UNKNOWN 
LOWINTEREST 
SINGLE 
NEIGHBOUR 
CENTER 
FORCED_LOWINTEREST 
FORCED_SINGLE 
FORCED_NEIGHBOUR 
FORCED_CENTER 

Definition at line 69 of file EcalSelectiveReadout.h.

◆ ttFlag_t

Enumerator
TTF_UNKNOWN 
TTF_LOW_INTEREST 
TTF_MID_INTEREST 
TTF_HIGH_INTEREST 
TTF_FORCED_LOW_INTEREST 
TTF_FORCED_MID_INTEREST 
TTF_FORCED_HIGH_INTEREST 

Definition at line 81 of file EcalSelectiveReadout.h.

81  {
82  TTF_UNKNOWN = -1,
83  TTF_LOW_INTEREST = 0x0,
84  TTF_MID_INTEREST = 0x1,
85  /* 0x2 not used */
86  TTF_HIGH_INTEREST = 0X3,
87  TTF_FORCED_LOW_INTEREST = 0x4, //0x0 | 0x4
88  TTF_FORCED_MID_INTEREST = 0x5, //0x1 | 0x4
89  /* 0x6 not used*/
90  TTF_FORCED_HIGH_INTEREST = 0x7 //0x3 | 0x4
91  // TTF_FORCED_RO_LINK_SYNC_ERR = 0x4,
92  // TTF_FORCED_RO_HAMMING_ERR = 0X5,
93  // TTF_FORCED_RO_OTHER1 = 0X6,
94  // TTF_FORCED_RO_OTHER2 = 0X7
95  } ttFlag_t;

Constructor & Destructor Documentation

◆ EcalSelectiveReadout()

EcalSelectiveReadout::EcalSelectiveReadout ( int  dEta = 1,
int  dPhi = 1 
)

Constructs a ecalselectivereadout. Neighbours are taken in a trigger tower matrix of size 2(dEta+1))x2(dPhi+1) around a 'center' tower.

Parameters
dEtaneighborhood extend in number of trigger towers along eta
dPhineighborgooh extend in number if trigger towers along phi in 'low interest', 'single' or 'center. First element is the lower threshold, second element is the higher one.

Definition at line 20 of file EcalSelectiveReadout.cc.

21  : theTriggerMap(nullptr), theElecMap(nullptr), dEta(dEta_), dPhi(dPhi_) {}
const EcalElectronicsMapping * theElecMap
const EcalTrigTowerConstituentsMap * theTriggerMap

Member Function Documentation

◆ classifyTriggerTowers()

void EcalSelectiveReadout::classifyTriggerTowers ( const ttFlag_t  ttFlags[nTriggerTowersInEta][nTriggerTowersInPhi])
private

Classifies trigger tower in three classes:

  • low interest: value 'lowInterest'
  • middle interest: value 'single'
  • high interest: value 'center'

Definition at line 187 of file EcalSelectiveReadout.cc.

References CENTER, combineFlags(), dEta, dPhi, FORCED_MASK, mps_fire::i, l1tPhase2CaloJetEmulator_cfi::iEta, createfilelist::int, LOWINTEREST, SiStripPI::max, NEIGHBOUR, nTriggerTowersInEta, nTriggerTowersInPhi, SINGLE, towerInterest, TTF_HIGH_INTEREST, and TTF_MID_INTEREST.

Referenced by runSelectiveReadout0().

187  {
188  //starts with a all low interest map:
189  for (int iEta = 0; iEta < (int)nTriggerTowersInEta; ++iEta) {
190  for (int iPhi = 0; iPhi < (int)nTriggerTowersInPhi; ++iPhi) {
191  towerInterest[iEta][iPhi] = LOWINTEREST;
192  }
193  }
194 
195  for (int iEta = 0; iEta < (int)nTriggerTowersInEta; ++iEta) {
196  for (int iPhi = 0; iPhi < (int)nTriggerTowersInPhi; ++iPhi) {
197  //copy forced bit from ttFlags to towerInterests:
198  towerInterest[iEta][iPhi] = (towerInterest_t)(towerInterest[iEta][iPhi] | (ttFlags[iEta][iPhi] & FORCED_MASK));
199  if ((ttFlags[iEta][iPhi] & ~FORCED_MASK) == TTF_HIGH_INTEREST) {
200  //flags this tower as a center tower
201  towerInterest[iEta][iPhi] = CENTER;
202  //flags the neighbours of this tower
203  for (int iEtaNeigh = std::max<int>(0, iEta - dEta);
204  iEtaNeigh <= std::min<int>(nTriggerTowersInEta - 1, iEta + dEta);
205  ++iEtaNeigh) {
206  for (int iPhiNeigh = iPhi - dPhi; iPhiNeigh <= iPhi + dPhi; ++iPhiNeigh) {
207  //beware, iPhiNeigh must be moved to [0,72] interval
208  //=> %nTriggerTowersInPhi required
209  int iPhiNeigh_ = iPhiNeigh % (int)nTriggerTowersInPhi;
210  if (iPhiNeigh_ < 0) {
211  iPhiNeigh_ += nTriggerTowersInPhi;
212  }
213  combineFlags(towerInterest[iEtaNeigh][iPhiNeigh_], NEIGHBOUR);
214  }
215  }
216  } else if ((ttFlags[iEta][iPhi] & ~FORCED_MASK) == TTF_MID_INTEREST) {
218  }
219  }
220  }
221 
222  //dealing with pseudo-TT in the two innest eta-ring of the endcaps
223  //=>choose the highest priority SRF of the 2 pseudo-TT constituting
224  //a TT. Note that for S and C, the 2 pseudo-TT must already have the
225  //same mask.
226  const size_t innerEtas[] = {0, 1, nTriggerTowersInEta - 2, nTriggerTowersInEta - 1};
227  for (size_t i = 0; i < 4; ++i) {
228  size_t iEta = innerEtas[i];
229  for (size_t iPhi = 0; iPhi < nTriggerTowersInPhi; iPhi += 2) {
230  const towerInterest_t srf = std::max(towerInterest[iEta][iPhi], towerInterest[iEta][iPhi + 1]);
231  towerInterest[iEta][iPhi] = srf;
232  towerInterest[iEta][iPhi + 1] = srf;
233  }
234  }
235 }
static const int FORCED_MASK
void combineFlags(T &var, T val) const
static const size_t nTriggerTowersInEta
static const size_t nTriggerTowersInPhi
towerInterest_t towerInterest[nTriggerTowersInEta][nTriggerTowersInPhi]

◆ combineFlags()

template<class T >
void EcalSelectiveReadout::combineFlags ( T var,
T  val 
) const
inlineprivate

Combine two flags. Forced bit and actual flag fields are treated separately. For both fields, the highst value is selected.

Parameters
var[in,out] flag to change in place
valflag to combine with the first.
Template Parameters
TtowerInterest_t or

Definition at line 299 of file EcalSelectiveReadout.h.

References gather_cfg::cout, SiStripPI::max, TTF_FORCED_RO_MASK, heppy_batch::val, and trigObjTnPSource_cfi::var.

Referenced by classifyTriggerTowers(), and runSelectiveReadout0().

299  {
300  var = (T)(std::max(val & ~TTF_FORCED_RO_MASK, //actual flag value:
301  // take highest
302  var & ~TTF_FORCED_RO_MASK) //beware: must work also
303  // for UNKNOW=-1
304  // ->compare the whole
305  // integer but with
306  // the forced bit masked.
307  | ((val | var) & 0x4)); //forced bit: set it if any of the two is
308  // already set
309 
310  if (var < 0 || var > 7) {
311  std::cout << __FILE__ << ":" << __LINE__ << ": ---------->" << var << " " << val << " "
312  << std::max(val & 0x3, var & 0x3) << " " << (val | var) << " " << ((val | var) & 0x4) << " "
313  << (std::max(val & 0x3, var & 0x3) | ((val | var) & 0x4)) << " "
314  << (T)(std::max(val & 0x3, var & 0x3) | ((val | var) & 0x4)) << "\n";
315  }
316  }
static const int TTF_FORCED_RO_MASK
long double T

◆ eeRuInterest() [1/2]

EcalSelectiveReadout::towerInterest_t & EcalSelectiveReadout::eeRuInterest ( const EEDetId id)
private

Get access to eeRuInterest element corresponding to an EE det Id

Parameters
idthe EE det id
Returns
reference to the eeRuInterest array element

Definition at line 148 of file EcalSelectiveReadout.cc.

References cms::cuda::assert(), eeRuInterest_, EcalElectronicsMapping::getElectronicsId(), maxDccChs, nDccPerEe, theElecMap, UNKNOWN, and EcalElectronicsId::zside().

Referenced by getCrystalInterest(), getSuperCrystalInterest(), and runSelectiveReadout0().

148  {
149  const EcalElectronicsId& id = theElecMap->getElectronicsId(eeDetId);
150  const int iZ0 = id.zside() > 0 ? 1 : 0;
151  const int iDcc0 = id.dccId() - 1;
152  const int iDccPhi0 = (iDcc0 < 9) ? iDcc0 : (iDcc0 - 45);
153  const int iDccCh0 = id.towerId() - 1;
154  assert(0 <= iDccPhi0 && iDccPhi0 < nDccPerEe);
155  assert(0 <= iDccCh0 && iDccCh0 < maxDccChs);
156 
157  assert(eeRuInterest_[iZ0][iDccPhi0][iDccCh0] == UNKNOWN ||
158  (0 <= eeRuInterest_[iZ0][iDccPhi0][iDccCh0] && eeRuInterest_[iZ0][iDccPhi0][iDccCh0] <= 7));
159 
160  return eeRuInterest_[iZ0][iDccPhi0][iDccCh0];
161 }
int zside() const
zside = +1 or -1
Ecal readout channel identification [32:20] Unused (so far) [19:13] DCC id [12:6] tower [5:3] strip [...
assert(be >=bs)
static const int nDccPerEe
static const int maxDccChs
const EcalElectronicsMapping * theElecMap
towerInterest_t eeRuInterest_[nEndcaps][nDccPerEe][maxDccChs]
EcalElectronicsId getElectronicsId(const DetId &id) const
Get the electronics id for this det id.

◆ eeRuInterest() [2/2]

EcalSelectiveReadout::towerInterest_t & EcalSelectiveReadout::eeRuInterest ( const EcalScDetId id)
private

Get access to eeRuInterest element corresponding to an SC det Id

Parameters
idthe SC det id
Returns
reference to the eeRuInterest array element

Definition at line 163 of file EcalSelectiveReadout.cc.

References cms::cuda::assert(), eeRuInterest_, EcalElectronicsMapping::getDCCandSC(), maxDccChs, nDccPerEe, theElecMap, and EcalScDetId::zside().

163  {
164  std::pair<int, int> dccAndDccCh = theElecMap->getDCCandSC(scDetId);
165  const int iZ0 = (scDetId.zside() > 0) ? 1 : 0;
166  const int iDcc0 = dccAndDccCh.first - 1;
167  const int iDccPhi0 = (iDcc0 < 9) ? iDcc0 : (iDcc0 - 45);
168  const int iDccCh0 = dccAndDccCh.second - 1;
169  assert(0 <= iDccPhi0 && iDccPhi0 <= nDccPerEe);
170  assert(0 <= iDccCh0 && iDccCh0 <= maxDccChs);
171 
172  assert(-1 <= eeRuInterest_[iZ0][iDccPhi0][iDccCh0] && eeRuInterest_[iZ0][iDccPhi0][iDccCh0] <= 7);
173 
174  return eeRuInterest_[iZ0][iDccPhi0][iDccCh0];
175 }
std::pair< int, int > getDCCandSC(EcalScDetId id) const
assert(be >=bs)
static const int nDccPerEe
static const int maxDccChs
const EcalElectronicsMapping * theElecMap
towerInterest_t eeRuInterest_[nEndcaps][nDccPerEe][maxDccChs]

◆ getCrystalInterest() [1/2]

EcalSelectiveReadout::towerInterest_t EcalSelectiveReadout::getCrystalInterest ( const EBDetId ebDetId) const

Gets the SR interest classification of an EB channel

Parameters
ebDetIdid of the crystal
interest

Definition at line 131 of file EcalSelectiveReadout.cc.

References getTowerInterest(), theTriggerMap, and EcalTrigTowerConstituentsMap::towerOf().

131  {
132  EcalTrigTowerDetId thisTower = theTriggerMap->towerOf(ebDetId);
133  return getTowerInterest(thisTower);
134 }
EcalTrigTowerDetId towerOf(const DetId &id) const
Get the tower id for this det id (or null if not known)
const EcalTrigTowerConstituentsMap * theTriggerMap
towerInterest_t getTowerInterest(const EcalTrigTowerDetId &towerId) const

◆ getCrystalInterest() [2/2]

EcalSelectiveReadout::towerInterest_t EcalSelectiveReadout::getCrystalInterest ( const EEDetId eeDetId) const

Gets the SR interest classification of an EE channel

Parameters
eeDetIdid of the crystal
Returns
interest

Definition at line 136 of file EcalSelectiveReadout.cc.

References eeRuInterest().

136  {
137  // int iz = (eeDetId.zside() > 0) ? 1 : 0;
138  // int superCrystalX = (eeDetId.ix()-1) / 5;
139  // int superCrystalY = (eeDetId.iy()-1) / 5;
140  // return supercrystalInterest[iz][superCrystalX][superCrystalY];
141  return const_cast<EcalSelectiveReadout*>(this)->eeRuInterest(eeDetId);
142 }
towerInterest_t & eeRuInterest(const EEDetId &id)

◆ getSuperCrystalInterest()

EcalSelectiveReadout::towerInterest_t EcalSelectiveReadout::getSuperCrystalInterest ( const EcalScDetId scDetId) const

Gets the SR interest classification of an EE supercrystal

Parameters
scDetIdid of the crystal
Returns
interest

Definition at line 144 of file EcalSelectiveReadout.cc.

References eeRuInterest().

Referenced by printEndcap().

144  {
145  return const_cast<EcalSelectiveReadout*>(this)->eeRuInterest(scDetId);
146 }
towerInterest_t & eeRuInterest(const EEDetId &id)

◆ getTowerInterest()

EcalSelectiveReadout::towerInterest_t EcalSelectiveReadout::getTowerInterest ( const EcalTrigTowerDetId towerId) const

Gets the SR interest classification of a trigger tower (TT).

Parameters
iEtaindex of the TT along eta
iPhiindex of the TT along phi
Returns
interest

Definition at line 177 of file EcalSelectiveReadout.cc.

References cms::cuda::assert(), l1tPhase2CaloJetEmulator_cfi::iEta, nTriggerTowersInEta, l1tHGCalTowerProducer_cfi::tower, and towerInterest.

Referenced by getCrystalInterest(), and runSelectiveReadout0().

177  {
178  // remember, array indices start at zero
179  int iEta = tower.ieta() < 0 ? tower.ieta() + nTriggerTowersInEta / 2 : tower.ieta() + nTriggerTowersInEta / 2 - 1;
180  int iPhi = tower.iphi() - 1;
181 
182  assert(-1 <= towerInterest[iEta][iPhi] && int(towerInterest[iEta][iPhi]) < 8);
183 
184  return towerInterest[iEta][iPhi];
185 }
assert(be >=bs)
static const size_t nTriggerTowersInEta
towerInterest_t towerInterest[nTriggerTowersInEta][nTriggerTowersInPhi]

◆ print()

void EcalSelectiveReadout::print ( std::ostream &  os) const

print out the map

Definition at line 266 of file EcalSelectiveReadout.cc.

References printBarrel(), and printEndcap().

Referenced by operator<<(), and EcalSelectiveReadoutProducer::produce().

266  {
267  //EE-
268  printEndcap(0, os);
269 
270  //EB
271  printBarrel(os);
272 
273  //EE+
274  printEndcap(1, os);
275 }
void printEndcap(int endcap, std::ostream &s) const
void printBarrel(std::ostream &os) const

◆ printBarrel()

void EcalSelectiveReadout::printBarrel ( std::ostream &  os) const

Definition at line 277 of file EcalSelectiveReadout.cc.

References l1tPhase2CaloJetEmulator_cfi::iEta, nBarrelTriggerTowersInEta, nEndcapTriggerTowersInEta, nTriggerTowersInPhi, srpFlagMarker, and towerInterest.

Referenced by print().

277  {
279  for (size_t iPhi = 0; iPhi < nTriggerTowersInPhi; ++iPhi) {
280  towerInterest_t srFlag = towerInterest[iEta][iPhi];
281  os << srpFlagMarker[srFlag];
282  }
283  os << "\n"; //one phi per line
284  }
285 }
static const size_t nEndcapTriggerTowersInEta
static const size_t nTriggerTowersInPhi
static const char srpFlagMarker[]
towerInterest_t towerInterest[nTriggerTowersInEta][nTriggerTowersInPhi]
static const size_t nBarrelTriggerTowersInEta

◆ printDccChMap()

void EcalSelectiveReadout::printDccChMap ( std::ostream &  os) const
private

Propagate TTF flag bit on towerInterest. TT interest forced bit is set if TTF forced bit is set, otherwise it is not touched.

Parameters
ttFlagsTT flags

Definition at line 311 of file EcalSelectiveReadout.cc.

References makeMuonMisalignmentScenario::endcap, EcalElectronicsMapping::getDCCandSC(), mps_fire::i, nSupercrystalXBins, nSupercrystalYBins, theElecMap, and EcalScDetId::validDetId().

311  {
312  for (int i = -1; i <= 68; ++i) {
313  if ((i + 1) % 10 == 0)
314  os << "//";
315  os << std::setw(2) << i << ": " << (char)('0' + i);
316  if (i % 10 == 9)
317  os << "\n";
318  else
319  os << " ";
320  }
321 
322  os << "\n";
323 
324  for (int endcap = 0; endcap < 2; ++endcap) {
325  os << "Sc2DCCch0: " << (endcap ? "EE+" : "EE-") << "\n";
326  for (size_t iY = 0; iY < nSupercrystalYBins; ++iY) {
327  os << "Sc2DCCch0: ";
328  for (size_t iX = 0; iX < nSupercrystalXBins; ++iX) {
329  //if(iX) os << ",";
330  if (!EcalScDetId::validDetId(iX + 1, iY + 1, endcap >= 1 ? 1 : -1)) {
331  //os << std::setw(2) << -1;
332  os << (char)('0' - 1);
333  } else {
334  //os << std::setw(2) << theElecMap->getDCCandSC(EcalScDetId(iX+1, iY+1, endcap>0?1:-1)).second-1;
335  os << (char)('0' + (theElecMap->getDCCandSC(EcalScDetId(iX + 1, iY + 1, endcap > 0 ? 1 : -1)).second - 1));
336  }
337  }
338  os << "\n";
339  }
340  os << "\n";
341  }
342  os << "\n";
343 }
static bool validDetId(int ix, int iy, int iz)
Definition: EcalScDetId.cc:59
std::pair< int, int > getDCCandSC(EcalScDetId id) const
static const size_t nSupercrystalXBins
static const size_t nSupercrystalYBins
const EcalElectronicsMapping * theElecMap

◆ printEndcap()

void EcalSelectiveReadout::printEndcap ( int  endcap,
std::ostream &  s 
) const

Definition at line 287 of file EcalSelectiveReadout.cc.

References HltBtagPostValidation_cff::c, makeMuonMisalignmentScenario::endcap, getSuperCrystalInterest(), nSupercrystalXBins, nSupercrystalYBins, srpFlagMarker, UNKNOWN, and EcalScDetId::validDetId().

Referenced by print().

287  {
288  for (size_t iX = 0; iX < nSupercrystalXBins; ++iX) {
289  for (size_t iY = 0; iY < nSupercrystalYBins; ++iY) {
290  towerInterest_t srFlag;
291  char c;
292  if (!EcalScDetId::validDetId(iX + 1, iY + 1, endcap >= 1 ? 1 : -1)) {
293  // srFlag = UNKNOWN;
294  c = ' ';
295  } else {
296  srFlag = getSuperCrystalInterest(
297  EcalScDetId(iX + 1, iY + 1, endcap >= 1 ? 1 : -1)); //supercrystalInterest[endcap][iX][iY];
298  c = srFlag == UNKNOWN ? '?' : srpFlagMarker[srFlag];
299  }
300  os << c;
301  }
302  os << "\n"; //one Y supercystal column per line
303  } //next supercrystal X-index
304 }
static bool validDetId(int ix, int iy, int iz)
Definition: EcalScDetId.cc:59
static const size_t nSupercrystalXBins
static const size_t nSupercrystalYBins
static const char srpFlagMarker[]
towerInterest_t getSuperCrystalInterest(const EcalScDetId &scDetId) const

◆ printHeader()

void EcalSelectiveReadout::printHeader ( std::ostream &  os) const

print out header for the map: see print(std::ostream&)

Definition at line 237 of file EcalSelectiveReadout.cc.

References srpFlagMarker.

Referenced by ntuplePrintersDiff.SeedPrinter::diff(), ntuplePrintersDiff.TrackPrinter::diff(), ntuplePrintersDiff.SeedPrinter::printSeed(), ntuplePrintersDiff.TrackPrinter::printTrack(), and EcalSelectiveReadoutProducer::produce().

237  {
238  os << "#SRP flag map\n#\n"
239  "# +-->Phi/Y "
240  << srpFlagMarker[0]
241  << ": low interest\n"
242  "# | "
243  << srpFlagMarker[1]
244  << ": single\n"
245  "# | "
246  << srpFlagMarker[2]
247  << ": neighbour\n"
248  "# V Eta/X "
249  << srpFlagMarker[3]
250  << ": center\n"
251  "# "
252  << srpFlagMarker[4]
253  << ": forced low interest\n"
254  "# "
255  << srpFlagMarker[5]
256  << ": forced single\n"
257  "# "
258  << srpFlagMarker[6]
259  << ": forced neighbout\n"
260  "# "
261  << srpFlagMarker[7]
262  << ": forced center\n"
263  "#\n";
264 }
static const char srpFlagMarker[]

◆ resetEeRuInterest()

void EcalSelectiveReadout::resetEeRuInterest ( )
private

Sets all endcap RU interest flags to 'unknown'

Definition at line 23 of file EcalSelectiveReadout.cc.

References eeRuInterest_, maxDccChs, nDccPerEe, nEndcaps, and UNKNOWN.

Referenced by runSelectiveReadout0().

23  {
24  //init superCrystalInterest (sets all elts to 'UNKNOWN'):
25  for (size_t iCap = 0; iCap < nEndcaps; ++iCap) {
26  for (int iDccPhi = 0; iDccPhi < nDccPerEe; ++iDccPhi) {
27  for (int iDccCh = 0; iDccCh < maxDccChs; ++iDccCh) {
28  eeRuInterest_[iCap][iDccPhi][iDccCh] = UNKNOWN;
29  }
30  }
31  }
32 }
static const size_t nEndcaps
static const int nDccPerEe
static const int maxDccChs
towerInterest_t eeRuInterest_[nEndcaps][nDccPerEe][maxDccChs]

◆ runSelectiveReadout0()

void EcalSelectiveReadout::runSelectiveReadout0 ( const ttFlag_t  towerFlags[nTriggerTowersInEta][nTriggerTowersInPhi])

Selective readout algorithm type 0. The algorithm is the following:

  1. A trigger tower (TT) with Et higher than the high threshold is classified as 'center'
  2. A trigger tower which is a neighbour of a 'center' TT and which is not itself a 'center' is classified as 'neighbour'
  3. A TT with Et between the two threshold and which is not a 'center' or a 'neighbour' is classified as 'single'
  4. Any other TT are classified as 'low interest'

For the barrel a crystal inherit the single/center/neighbour/low_interst classification of its TT. For the endcap,

  • if the supercrystal overlaps with a 'center' TT, it's flagged as 'center'
  • otherwise if it overlaps with a 'neighbour' TT, it's flagged as 'neighbour'
  • else if it overlaps with a 'single' TT, it's flagged as 'single'
  • the remaining SC are flagged as 'low interest'

An endcap crystal inherits the SRP flag of its SC.

Parameters
triggerTowerEtarray of the transverse enrgy deposited in the trigger tower. First index is for eta,2nd index for phi.

Definition at line 34 of file EcalSelectiveReadout.cc.

References cms::cuda::assert(), CENTER, classifyTriggerTowers(), combineFlags(), DetId::Ecal, EcalEndcap, eeRuInterest(), FORCED_MASK, getTowerInterest(), l1tPhase2CaloJetEmulator_cfi::iEta, LOWINTEREST, nBarrelTriggerTowersInEta, NEIGHBOUR, nEndcapTriggerTowersInEta, nEndcapXBins, nEndcapYBins, nTriggerTowersInEta, nTriggerTowersInPhi, DetId::rawId(), resetEeRuInterest(), SINGLE, theTriggerMap, towerInterest, EcalTrigTowerConstituentsMap::towerOf(), and EEDetId::validDetId().

34  {
35  //printDccChMap(std::cout);
36 
37  //classifies the trigger towers (single,center,neighbor,low interest)
38  classifyTriggerTowers(ttFlags);
39 
40  //count number of TT in each interest class for debugging display
41  int nTriggerTowerE[] = {0, 0, 0, 0, 0, 0, 0, 0};
42  int nTriggerTowerB[] = {0, 0, 0, 0, 0, 0, 0, 0};
43  static std::atomic<int> ncall{0};
44  if (ncall < 10) {
45  ++ncall;
46  for (size_t iPhi = 0; iPhi < nTriggerTowersInPhi; ++iPhi) {
47  for (size_t iEta = 0; iEta < nTriggerTowersInEta; ++iEta) {
48  if (iEta < nEndcapTriggerTowersInEta || iEta >= nBarrelTriggerTowersInEta + nEndcapTriggerTowersInEta) {
49  //in endcaps
50  ++nTriggerTowerE[towerInterest[iEta][iPhi]];
51  } else { //in barrel
52  ++nTriggerTowerB[towerInterest[iEta][iPhi]];
53  }
54 
55  assert(towerInterest[iEta][iPhi] >= 0 && towerInterest[iEta][iPhi] <= 0x7);
56  }
57  }
58  edm::LogInfo("EcalSelectiveReadout") << "without forced bit + with forced bit set:\n"
59  << nTriggerTowerB[LOWINTEREST] << " + "
60  << nTriggerTowerB[LOWINTEREST | FORCED_MASK]
61  << " low interest TT(s) in barrel\n"
62  << nTriggerTowerB[SINGLE] << " + " << nTriggerTowerB[SINGLE | FORCED_MASK]
63  << " single TT(s) in barrel\n"
64  << nTriggerTowerB[NEIGHBOUR] << " + "
65  << nTriggerTowerB[NEIGHBOUR | FORCED_MASK]
66  << " neighbor interest TT(s) in barrel\n"
67  << nTriggerTowerB[CENTER] << " + " << nTriggerTowerB[CENTER | FORCED_MASK]
68  << " centre interest TT(s) in barrel\n"
69  << nTriggerTowerE[LOWINTEREST] << " + "
70  << nTriggerTowerE[LOWINTEREST | FORCED_MASK]
71  << " low interest TT(s) in endcap\n"
72  << nTriggerTowerE[SINGLE] << " + " << nTriggerTowerE[SINGLE | FORCED_MASK]
73  << " single TT(s) in endcap\n"
74  << nTriggerTowerE[NEIGHBOUR] << " + "
75  << nTriggerTowerE[NEIGHBOUR | FORCED_MASK] << " neighbor TT(s) in endcap\n"
76  << nTriggerTowerE[CENTER] << " + " << nTriggerTowerE[CENTER | FORCED_MASK]
77  << " center TT(s) in endcap\n";
78  }
79  //end TT interest class composition debugging display
80 
81  //For the endcap the TT classification must be mapped to the SC:
83 
84 #ifndef ECALSELECTIVEREADOUT_NOGEOM
85  const std::vector<DetId>& endcapDetIds = theGeometry->getValidDetIds(DetId::Ecal, EcalEndcap);
86  for (std::vector<DetId>::const_iterator eeDetIdItr = endcapDetIds.begin(); eeDetIdItr != endcapDetIds.end();
87  ++eeDetIdItr) {
88  // for each superCrystal, the interest is the highest interest
89  // of any trigger tower associated with at least one crystal from this SC.
90  // The forced bit must be set if the flag of one of these trigger towers has
91  // the forced bit set.
92  EcalTrigTowerDetId trigTower = theTriggerMap->towerOf(*eeDetIdItr);
93  assert(trigTower.rawId() != 0);
94  EEDetId eeDetId(*eeDetIdItr);
95  int iz = (eeDetId.zside() > 0) ? 1 : 0;
96  //Following statement will set properly the actual 2-bit flag value
97  //and the forced bit: TTF forced bit is propagated to every RU that
98  //overlaps with the corresponding TT.
99  combineFlags(eeRuInterest(eeDetId), getTowerInterest(trigTower));
100  }
101 #else //ECALSELECTIVEREADOUT_NOGEOM defined
102  EEDetId xtal;
103  for (int iZ0 = 0; iZ0 < 2; ++iZ0) { //0->EE-, 1->EE+
104  for (unsigned iX0 = 0; iX0 < nEndcapXBins; ++iX0) {
105  for (unsigned iY0 = 0; iY0 < nEndcapYBins; ++iY0) {
106  if (!(xtal.validDetId(iX0 + 1, iY0 + 1, (iZ0 > 0 ? 1 : -1)))) {
107  continue;
108  }
109  xtal = EEDetId(iX0 + 1, iY0 + 1, (iZ0 > 0 ? 1 : -1));
110  //works around a EEDetId bug. To remove once the bug fixed.
111  if (39 <= iX0 && iX0 <= 60 && 45 <= iY0 && iY0 <= 54) {
112  continue;
113  }
114  // for each superCrystal, the interest is the highest interest
115  // of any trigger tower associated with any crystal in this SC
116  EcalTrigTowerDetId trigTower = theTriggerMap->towerOf(xtal);
117  assert(trigTower.rawId() != 0);
118  //Following statement will set properly the actual 2-bit flag value
119  //and the forced bit: TTF forced bit is propagated to every RU that
120  //overlaps with the corresponding TT.
121  combineFlags(eeRuInterest(xtal), getTowerInterest(trigTower));
122 
123  assert(0 <= eeRuInterest(xtal) && eeRuInterest(xtal) <= 0x7);
124 
125  } //next iY0
126  } //next iX0
127  } //next iZ0
128 #endif //ECALSELECTIVEREADOUT_NOGEOM not defined
129 }
static const int FORCED_MASK
static const size_t nEndcapXBins
assert(be >=bs)
void classifyTriggerTowers(const ttFlag_t ttFlags[nTriggerTowersInEta][nTriggerTowersInPhi])
EcalTrigTowerDetId towerOf(const DetId &id) const
Get the tower id for this det id (or null if not known)
towerInterest_t & eeRuInterest(const EEDetId &id)
static const size_t nEndcapYBins
static const size_t nEndcapTriggerTowersInEta
Log< level::Info, false > LogInfo
const EcalTrigTowerConstituentsMap * theTriggerMap
towerInterest_t getTowerInterest(const EcalTrigTowerDetId &towerId) const
constexpr uint32_t rawId() const
get the raw id
Definition: DetId.h:57
static bool validDetId(int crystal_ix, int crystal_iy, int iz)
Definition: EEDetId.h:248
void combineFlags(T &var, T val) const
static const size_t nTriggerTowersInEta
static const size_t nTriggerTowersInPhi
towerInterest_t towerInterest[nTriggerTowersInEta][nTriggerTowersInPhi]
static const size_t nBarrelTriggerTowersInEta

◆ setElecMap()

void EcalSelectiveReadout::setElecMap ( const EcalElectronicsMapping map)
inline

the electronics map, used to get information about the DCC and DCC channel used to read a crystal channel

Definition at line 173 of file EcalSelectiveReadout.h.

References genParticles_cff::map, and theElecMap.

173 { theElecMap = map; }
const EcalElectronicsMapping * theElecMap

◆ setHigher()

template<class T >
void EcalSelectiveReadout::setHigher ( T var,
T  val 
) const
inlineprivate

Changes the value of a variable iff that has the effect to increase the variable value var = max(var,val)

Parameters
varthe variable
valthe new candidate value

Definition at line 287 of file EcalSelectiveReadout.h.

References heppy_batch::val, and trigObjTnPSource_cfi::var.

287  {
288  if (val > var)
289  var = val;
290  }

◆ setLower()

void EcalSelectiveReadout::setLower ( int &  var,
int  val 
) const
inlineprivate

Changes the value of a variable iff that has the effect to decrease the variable value var = min(var,val)

Parameters
varthe variable
valthe new candidate value

Definition at line 275 of file EcalSelectiveReadout.h.

References heppy_batch::val, and trigObjTnPSource_cfi::var.

275  {
276  if (val < var)
277  var = val;
278  }

◆ setTriggerMap()

void EcalSelectiveReadout::setTriggerMap ( const EcalTrigTowerConstituentsMap map)
inline

the mapping of which cell goes with which trigger tower

Definition at line 169 of file EcalSelectiveReadout.h.

References genParticles_cff::map, and theTriggerMap.

169 { theTriggerMap = map; }
const EcalTrigTowerConstituentsMap * theTriggerMap

Member Data Documentation

◆ dEta

int EcalSelectiveReadout::dEta
private

Definition at line 337 of file EcalSelectiveReadout.h.

Referenced by classifyTriggerTowers().

◆ dPhi

int EcalSelectiveReadout::dPhi
private

Definition at line 338 of file EcalSelectiveReadout.h.

Referenced by classifyTriggerTowers().

◆ eeRuInterest_

towerInterest_t EcalSelectiveReadout::eeRuInterest_[nEndcaps][nDccPerEe][maxDccChs]
private

Definition at line 336 of file EcalSelectiveReadout.h.

Referenced by eeRuInterest(), and resetEeRuInterest().

◆ FORCED_MASK

const int EcalSelectiveReadout::FORCED_MASK = 0x4
static

◆ maxDccChs

const int EcalSelectiveReadout::maxDccChs = 68
static

Maximum number of DCC channels used from crystal channels (channel #69 and #70 used for MEM are not counted here)

Definition at line 148 of file EcalSelectiveReadout.h.

Referenced by eeRuInterest(), and resetEeRuInterest().

◆ nBarrelEtaBins

const size_t EcalSelectiveReadout::nBarrelEtaBins = 170
static

Number of crystals along eta in barrel

Definition at line 104 of file EcalSelectiveReadout.h.

◆ nBarrelPhiBins

const size_t EcalSelectiveReadout::nBarrelPhiBins = 360
static

Number of crystals in a eta ring of the barrel

Definition at line 107 of file EcalSelectiveReadout.h.

◆ nBarrelTowerEtaBins

const size_t EcalSelectiveReadout::nBarrelTowerEtaBins = nBarrelEtaBins / 5
static

Number of trigger tower along eta in the barrel

Definition at line 125 of file EcalSelectiveReadout.h.

◆ nBarrelTowerPhiBins

const size_t EcalSelectiveReadout::nBarrelTowerPhiBins = nBarrelPhiBins / 5
static

Number of trigger tower in a eta ring of the barrel

Definition at line 128 of file EcalSelectiveReadout.h.

◆ nBarrelTriggerTowersInEta

const size_t EcalSelectiveReadout::nBarrelTriggerTowersInEta = 34
static

Number of barrel trigger towers along eta

Definition at line 137 of file EcalSelectiveReadout.h.

Referenced by printBarrel(), and runSelectiveReadout0().

◆ nDccPerEe

const int EcalSelectiveReadout::nDccPerEe = 9
static

Number of DCC per endcap

Definition at line 152 of file EcalSelectiveReadout.h.

Referenced by eeRuInterest(), and resetEeRuInterest().

◆ nEndcaps

const size_t EcalSelectiveReadout::nEndcaps = 2
static

Number of endcap, obviously tow

Definition at line 131 of file EcalSelectiveReadout.h.

Referenced by resetEeRuInterest().

◆ nEndcapTriggerTowersInEta

const size_t EcalSelectiveReadout::nEndcapTriggerTowersInEta = 11
static

Number of trigger towers along eta in one endcap

Definition at line 134 of file EcalSelectiveReadout.h.

Referenced by printBarrel(), and runSelectiveReadout0().

◆ nEndcapXBins

const size_t EcalSelectiveReadout::nEndcapXBins = 100
static

Range of the x-index of endcap crystals (xman-xmin+1).

Definition at line 110 of file EcalSelectiveReadout.h.

Referenced by runSelectiveReadout0().

◆ nEndcapYBins

const size_t EcalSelectiveReadout::nEndcapYBins = 100
static

Range of the y-index of endcap crystals (yman-ymin+1).

Definition at line 113 of file EcalSelectiveReadout.h.

Referenced by runSelectiveReadout0().

◆ nSupercrystalXBins

const size_t EcalSelectiveReadout::nSupercrystalXBins = nEndcapXBins / supercrystalEdge
static

Range of endcap supercrystal x-index (xmax-xmin+1)

Definition at line 119 of file EcalSelectiveReadout.h.

Referenced by printDccChMap(), and printEndcap().

◆ nSupercrystalYBins

const size_t EcalSelectiveReadout::nSupercrystalYBins = nEndcapYBins / supercrystalEdge
static

Range of endcap supercrystal y-index (ymay-ymin+1)

Definition at line 122 of file EcalSelectiveReadout.h.

Referenced by printDccChMap(), and printEndcap().

◆ nTriggerTowersInEta

const size_t EcalSelectiveReadout::nTriggerTowersInEta = 2 * nEndcapTriggerTowersInEta + nBarrelTriggerTowersInEta
static

◆ nTriggerTowersInPhi

const size_t EcalSelectiveReadout::nTriggerTowersInPhi = 72
static

◆ srpFlagMarker

const char EcalSelectiveReadout::srpFlagMarker = {'.', 'S', 'N', 'C', '4', '5', '6', '7'}
staticprivate

Definition at line 341 of file EcalSelectiveReadout.h.

Referenced by printBarrel(), printEndcap(), and printHeader().

◆ supercrystalEdge

const size_t EcalSelectiveReadout::supercrystalEdge = 5
static

Edge size of a supercrystal. A supercrystal is a tower of 5x5 crystals.

Definition at line 116 of file EcalSelectiveReadout.h.

◆ theElecMap

const EcalElectronicsMapping* EcalSelectiveReadout::theElecMap
private

Definition at line 329 of file EcalSelectiveReadout.h.

Referenced by eeRuInterest(), printDccChMap(), and setElecMap().

◆ theTriggerMap

const EcalTrigTowerConstituentsMap* EcalSelectiveReadout::theTriggerMap
private

Definition at line 328 of file EcalSelectiveReadout.h.

Referenced by getCrystalInterest(), runSelectiveReadout0(), and setTriggerMap().

◆ towerInterest

towerInterest_t EcalSelectiveReadout::towerInterest[nTriggerTowersInEta][nTriggerTowersInPhi]
private

◆ TTF_FORCED_RO_MASK

const int EcalSelectiveReadout::TTF_FORCED_RO_MASK = FORCED_MASK
static

Definition at line 98 of file EcalSelectiveReadout.h.

Referenced by combineFlags().