CMS 3D CMS Logo
List of all members | Public Member Functions | Private Attributes
ZdcUnpacker Class Reference

#include <ZdcUnpacker.h>

Public Member Functions

void setExpectedOrbitMessageTime (int time)
 
void unpack (const FEDRawData &raw, const CastorElectronicsMap &emap, CastorRawCollections &conts, HcalUnpackerReport &report, bool silent=false)
 For histograms, no begin and end. More...
 
void unpackOld (const FEDRawData &raw, const HcalElectronicsMap &emap, CastorRawCollections &conts, HcalUnpackerReport &report, bool silent=false)
 
 ZdcUnpacker (int sourceIdOffset, int beg, int end)
 for normal data More...
 

Private Attributes

int endSample_
 last sample from fed raw data to copy (if present) More...
 
int expectedOrbitMessageTime_
 Expected orbit bunch time (needed to evaluate time differences) More...
 
int mode_
 
int sourceIdOffset_
 number to subtract from the source id to get the dcc id More...
 
int startSample_
 first sample from fed raw data to copy More...
 
std::set< HcalElectronicsId > unknownIds_
 
std::set< HcalElectronicsId > unknownIdsTrig_
 Recorded to limit number of times a log message is generated. More...
 

Detailed Description

Definition at line 16 of file ZdcUnpacker.h.

Constructor & Destructor Documentation

◆ ZdcUnpacker()

ZdcUnpacker::ZdcUnpacker ( int  sourceIdOffset,
int  beg,
int  end 
)

for normal data

Definition at line 94 of file ZdcUnpacker.cc.

References mps_fire::end, endSample_, ZDCDataFrame::MAXSAMPLES, and startSample_.

95  : sourceIdOffset_(sourceIdOffset), expectedOrbitMessageTime_(-1) {
96  if (beg >= 0 && beg <= ZDCDataFrame::MAXSAMPLES - 1) {
97  startSample_ = beg;
98  } else {
99  startSample_ = 0;
100  }
101  if (end >= 0 && end <= ZDCDataFrame::MAXSAMPLES - 1 && end >= beg) {
102  endSample_ = end;
103  } else {
104  endSample_ = ZDCDataFrame::MAXSAMPLES - 1;
105  }
106 }
ZdcUnpacker::startSample_
int startSample_
first sample from fed raw data to copy
Definition: ZdcUnpacker.h:36
ZDCDataFrame::MAXSAMPLES
static const int MAXSAMPLES
Definition: ZDCDataFrame.h:54
ZdcUnpacker::expectedOrbitMessageTime_
int expectedOrbitMessageTime_
Expected orbit bunch time (needed to evaluate time differences)
Definition: ZdcUnpacker.h:38
ZdcUnpacker::sourceIdOffset_
int sourceIdOffset_
number to subtract from the source id to get the dcc id
Definition: ZdcUnpacker.h:35
mps_fire.end
end
Definition: mps_fire.py:242
ZdcUnpacker::endSample_
int endSample_
last sample from fed raw data to copy (if present)
Definition: ZdcUnpacker.h:37

Member Function Documentation

◆ setExpectedOrbitMessageTime()

void ZdcUnpacker::setExpectedOrbitMessageTime ( int  time)
inline

Definition at line 20 of file ZdcUnpacker.h.

References expectedOrbitMessageTime_, and hcalRecHitTable_cff::time.

20 { expectedOrbitMessageTime_ = time; }
hcalRecHitTable_cff.time
time
Definition: hcalRecHitTable_cff.py:14
ZdcUnpacker::expectedOrbitMessageTime_
int expectedOrbitMessageTime_
Expected orbit bunch time (needed to evaluate time differences)
Definition: ZdcUnpacker.h:38

◆ unpack()

void ZdcUnpacker::unpack ( const FEDRawData &  raw,
const CastorElectronicsMap &  emap,
CastorRawCollections &  conts,
HcalUnpackerReport &  report,
bool  silent = false 
)

For histograms, no begin and end.

Definition at line 108 of file ZdcUnpacker.cc.

References DetId::Calo, HcalHTRData::check(), FEDRawData::data(), HcalHTRData::dataPointers(), DetId::det(), runTauDisplay::eid, endSample_, expectedOrbitMessageTime_, HcalHTRData::getFirmwareFlavor(), HcalHTRData::getNPS(), HcalDCCHeader::getSourceId(), HcalDCCHeader::getSpigotCRCError(), HcalDCCHeader::getSpigotData(), HcalDCCHeader::getSpigotPresent(), HcalHTRData::getSubmodule(), HcalHTRData::is_channel_header(), HcalHTRData::isHistogramEvent(), LogDebug, DetId::null(), edmIntegrityCheck::report, CastorRawToDigi_cfi::silent, FEDRawData::size(), sourceIdOffset_, HcalDCCHeader::SPIGOT_COUNT, startSample_, HcalZDCDetId::SubdetectorId, DetId::subdetId(), CastorRawCollections::ttp, HcalTTPUnpacker::unpack(), HcalHTRData::unpack_per_channel_header(), and CastorRawCollections::zdcCont.

Referenced by CastorRawToDigi::produce().

112  {
113  if (raw.size() < 16) {
114  if (!silent)
115  edm::LogWarning("Invalid Data") << "Empty/invalid DCC data, size = " << raw.size();
116  return;
117  }
118 
119  // get the DCC header
120  const HcalDCCHeader* dccHeader = (const HcalDCCHeader*)(raw.data());
121  int dccid = dccHeader->getSourceId() - sourceIdOffset_;
122 
123  // walk through the HTR data...
124  HcalHTRData htr;
125  const unsigned short *daq_first, *daq_last, *tp_first, *tp_last;
126  std::map<HcalElectronicsId, DetId> myEMap;
127 
129  //PZDC
130  HcalElectronicsId eid = HcalElectronicsId(0, 1, 0, 3);
131  eid.setHTR(18, 8, 1);
132  myEMap[eid] = DetId(0x54000051); //PZDC EM1
133 
134  eid = HcalElectronicsId(1, 1, 0, 3);
135  eid.setHTR(18, 8, 1);
136  myEMap[eid] = DetId(0x54000052); //PZDC EM2
137 
138  eid = HcalElectronicsId(2, 1, 0, 3);
139  eid.setHTR(18, 8, 1);
140  myEMap[eid] = DetId(0x54000053); //PZDC EM3
141 
142  eid = HcalElectronicsId(0, 2, 0, 3);
143  eid.setHTR(18, 8, 1);
144  myEMap[eid] = DetId(0x54000061); //PZDC HAD1
145 
146  eid = HcalElectronicsId(1, 2, 0, 3);
147  eid.setHTR(18, 8, 1);
148  myEMap[eid] = DetId(0x54000054); //PZDC EM4
149 
150  eid = HcalElectronicsId(2, 2, 0, 3);
151  eid.setHTR(18, 8, 1);
152  myEMap[eid] = DetId(0x54000055); //PZDC EM5
153 
154  eid = HcalElectronicsId(0, 3, 0, 3);
155  eid.setHTR(18, 8, 1);
156  myEMap[eid] = DetId(0x54000062); //PZDC HAD2
157 
158  eid = HcalElectronicsId(1, 3, 0, 3);
159  eid.setHTR(18, 8, 1);
160  myEMap[eid] = DetId(0x54000063); //PZDC HAD3
161 
162  eid = HcalElectronicsId(2, 3, 0, 3);
163  eid.setHTR(18, 8, 1);
164  myEMap[eid] = DetId(0x54000064); //PZDC HAD4
165 
166  //NZDC
167  eid = HcalElectronicsId(0, 1, 1, 3);
168  eid.setHTR(18, 8, 0);
169  myEMap[eid] = DetId(0x54000011); //NZDC EM1
170 
171  eid = HcalElectronicsId(1, 1, 1, 3);
172  eid.setHTR(18, 8, 0);
173  myEMap[eid] = DetId(0x54000012); //NZDC EM2
174 
175  eid = HcalElectronicsId(2, 1, 1, 3);
176  eid.setHTR(18, 8, 0);
177  myEMap[eid] = DetId(0x54000013); //NZDC EM3
178 
179  eid = HcalElectronicsId(0, 2, 1, 3);
180  eid.setHTR(18, 8, 0);
181  myEMap[eid] = DetId(0x54000015); //NZDC EM5
182 
183  eid = HcalElectronicsId(1, 2, 1, 3);
184  eid.setHTR(18, 8, 0);
185  myEMap[eid] = DetId(0x54000021); //NZDC HAD1
186 
187  eid = HcalElectronicsId(2, 2, 1, 3);
188  eid.setHTR(18, 8, 0);
189  myEMap[eid] = DetId(0x54000014); //NZDC EM4
190 
191  eid = HcalElectronicsId(0, 3, 1, 3);
192  eid.setHTR(18, 8, 0);
193  myEMap[eid] = DetId(0x54000022); //NZDC HAD2
194 
195  eid = HcalElectronicsId(1, 3, 1, 3);
196  eid.setHTR(18, 8, 0);
197  myEMap[eid] = DetId(0x54000023); //NZDC HAD3
198 
199  eid = HcalElectronicsId(2, 3, 1, 3);
200  eid.setHTR(18, 8, 0);
201  myEMap[eid] = DetId(0x54000024); //NZDC HAD4
202 
203  for (int spigot = 0; spigot < HcalDCCHeader::SPIGOT_COUNT; spigot++) {
204  if (!dccHeader->getSpigotPresent(spigot))
205  continue;
206  int retval = dccHeader->getSpigotData(spigot, htr, raw.size());
207  if (retval != 0) {
208  if (retval == -1) {
209  if (!silent)
210  edm::LogWarning("Invalid Data") << "Invalid HTR data (data beyond payload size) observed on spigot " << spigot
211  << " of DCC with source id " << dccHeader->getSourceId();
212  report.countSpigotFormatError();
213  }
214  continue;
215  }
216  // check
217  if (dccHeader->getSpigotCRCError(spigot)) {
218  if (!silent)
219  edm::LogWarning("Invalid Data") << "CRC Error on HTR data observed on spigot " << spigot
220  << " of DCC with source id " << dccHeader->getSourceId();
221  report.countSpigotFormatError();
222  continue;
223  }
224  if (!htr.check()) {
225  if (!silent)
226  edm::LogWarning("Invalid Data") << "Invalid HTR data observed on spigot " << spigot << " of DCC with source id "
227  << dccHeader->getSourceId();
228  report.countSpigotFormatError();
229  continue;
230  }
231  if (htr.isHistogramEvent()) {
232  if (!silent)
233  edm::LogWarning("Invalid Data") << "Histogram data passed to non-histogram unpacker on spigot " << spigot
234  << " of DCC with source id " << dccHeader->getSourceId();
235  continue;
236  }
237  if ((htr.getFirmwareFlavor() & 0xE0) == 0x80) { // some kind of TTP data
238  if (colls.ttp != nullptr) {
239  HcalTTPUnpacker ttpUnpack;
240  colls.ttp->push_back(HcalTTPDigi());
241  ttpUnpack.unpack(htr, colls.ttp->back());
242  } else {
243  LogDebug("ZdcUnpackerHcalTechTrigProcessor")
244  << "Skipping data on spigot " << spigot << " of DCC with source id " << dccHeader->getSourceId()
245  << " which is from the TechTrigProcessor (use separate unpacker!)";
246  }
247  continue;
248  }
249  if (htr.getFirmwareFlavor() >= 0x80) {
250  if (!silent)
251  edm::LogWarning("ZdcUnpacker") << "Skipping data on spigot " << spigot << " of DCC with source id "
252  << dccHeader->getSourceId() << " which is of unknown flavor "
253  << htr.getFirmwareFlavor();
254  continue;
255  }
256  // calculate "real" number of presamples
257  int nps = htr.getNPS() - startSample_;
258 
259  // get pointers
260  htr.dataPointers(&daq_first, &daq_last, &tp_first, &tp_last);
261  unsigned int smid = htr.getSubmodule();
262  int htr_tb = smid & 0x1;
263  int htr_slot = (smid >> 1) & 0x1F;
264  int htr_cr = (smid >> 6) & 0x1F;
265 
266  const unsigned short* ptr_header = daq_first;
267  const unsigned short* ptr_end = daq_last + 1;
268  int flavor, error_flags, capid0, channelid;
269 
270  while (ptr_header != ptr_end) {
271  if (*ptr_header == 0xFFFF) { // impossible filler word
272  ptr_header++;
273  continue;
274  }
275  // unpack the header word
276  bool isheader = HcalHTRData::unpack_per_channel_header(*ptr_header, flavor, error_flags, capid0, channelid);
277  if (!isheader) {
278  ptr_header++;
279  continue;
280  }
281  int fiberchan = channelid & 0x3;
282  int fiber = ((channelid >> 2) & 0x7) + 1;
283 
284  // lookup the right channel
285  HcalElectronicsId eid(fiberchan, fiber, spigot, dccid);
286  eid.setHTR(htr_cr, htr_slot, htr_tb);
287  auto it = myEMap.find(eid);
288  DetId did;
289  if (it != myEMap.end()) {
290  did = it->second;
291  }
292 
293  if (!did.null()) {
294  if (did.det() == DetId::Calo && did.subdetId() == HcalZDCDetId::SubdetectorId) {
295  colls.zdcCont->push_back(ZDCDataFrame(HcalZDCDetId(did)));
296  ptr_header = ZdcUnpacker_impl::unpack_compact<ZDCDataFrame>(ptr_header,
297  ptr_end,
298  colls.zdcCont->back(),
299  nps,
300  eid,
301  startSample_,
302  endSample_,
303  expectedOrbitMessageTime_,
304  htr);
305  }
306  } else {
307  report.countUnmappedDigi(eid);
308  for (ptr_header++; ptr_header != ptr_end && !HcalHTRData::is_channel_header(*ptr_header); ptr_header++)
309  ;
310  }
311  }
312  } //end of loop over spigots
313 }
HcalHTRData::isHistogramEvent
bool isHistogramEvent() const
Is this event a histogram event? (do not call standard unpack in this case!!!!!)
Definition: HcalHTRData.cc:409
HcalDCCHeader::getSpigotData
int getSpigotData(int nspigot, HcalHTRData &decodeTool, int validSize) const
Definition: HcalDCCHeader.cc:27
HcalHTRData::getNPS
int getNPS() const
Get the number of presamples in daq data.
Definition: HcalHTRData.cc:426
FEDRawData::size
size_t size() const
Lenght of the data buffer in bytes.
Definition: FEDRawData.h:45
ZdcUnpacker::startSample_
int startSample_
first sample from fed raw data to copy
Definition: ZdcUnpacker.h:36
HcalHTRData::unpack_per_channel_header
static bool unpack_per_channel_header(unsigned short, int &flav, int &error_flags, int &capid0, int &channelid)
Unpack a per-channel header word (compact format)
Definition: HcalHTRData.cc:455
DetId::det
constexpr Detector det() const
get the detector field from this detid
Definition: DetId.h:46
HcalHTRData::getFirmwareFlavor
int getFirmwareFlavor() const
Get the HTR firmware flavor.
Definition: HcalHTRData.cc:433
HcalHTRData::dataPointers
void dataPointers(const unsigned short **daq_first, const unsigned short **daq_last, const unsigned short **tp_first, const unsigned short **tp_last) const
Obtain the starting and ending pointers for external unpacking of the data.
Definition: HcalHTRData.cc:161
DetId::null
constexpr bool null() const
is this a null id ?
Definition: DetId.h:59
HcalHTRData::is_channel_header
static bool is_channel_header(unsigned short value)
check top bit to see if this is a compact format channel header word
Definition: HcalHTRData.h:92
ZdcUnpacker::expectedOrbitMessageTime_
int expectedOrbitMessageTime_
Expected orbit bunch time (needed to evaluate time differences)
Definition: ZdcUnpacker.h:38
HcalDCCHeader::getSourceId
int getSourceId() const
Definition: HcalDCCHeader.h:33
DetId::subdetId
constexpr int subdetId() const
get the contents of the subdetector field (not cast into any detector&#39;s numbering enum) ...
Definition: DetId.h:48
ZdcUnpacker::sourceIdOffset_
int sourceIdOffset_
number to subtract from the source id to get the dcc id
Definition: ZdcUnpacker.h:35
DetId
Definition: DetId.h:17
HcalZDCDetId::SubdetectorId
static const int SubdetectorId
Definition: HcalZDCDetId.h:25
HcalDCCHeader::getSpigotCRCError
bool getSpigotCRCError(unsigned int nspigot) const
Read the "CRC-Mismatch" bit for this spigot.
Definition: HcalDCCHeader.h:123
HcalTTPUnpacker::unpack
bool unpack(const HcalHTRData &data, HcalTTPDigi &digi)
Definition: HcalTTPUnpacker.cc:3
ZdcUnpacker::endSample_
int endSample_
last sample from fed raw data to copy (if present)
Definition: ZdcUnpacker.h:37
HcalDCCHeader::SPIGOT_COUNT
static const int SPIGOT_COUNT
Definition: HcalDCCHeader.h:20
HcalDCCHeader::getSpigotPresent
bool getSpigotPresent(unsigned int nspigot) const
Read the "PRESENT" bit for this spigot.
Definition: HcalDCCHeader.h:107
FEDRawData::data
const unsigned char * data() const
Return a const pointer to the beginning of the data buffer.
Definition: FEDRawData.cc:24
HcalHTRData::getSubmodule
unsigned int getSubmodule() const
Get the HTR submodule number.
Definition: HcalHTRData.cc:355
edm::LogWarning
Log< level::Warning, false > LogWarning
Definition: MessageLogger.h:128
HcalElectronicsId
Readout chain identification for Hcal.
Definition: HcalElectronicsId.h:32
HcalHTRData::check
bool check() const
Check for a good event Requires a minimum length, matching wordcount and length, not an empty event...
Definition: HcalHTRData.cc:63
LogDebug
#define LogDebug(id)
Definition: MessageLogger.h:241
CastorRawToDigi_cfi.silent
silent
Definition: CastorRawToDigi_cfi.py:27

◆ unpackOld()

void ZdcUnpacker::unpackOld ( const FEDRawData &  raw,
const HcalElectronicsMap &  emap,
CastorRawCollections &  conts,
HcalUnpackerReport &  report,
bool  silent = false 
)

Member Data Documentation

◆ endSample_

int ZdcUnpacker::endSample_
private

last sample from fed raw data to copy (if present)

Definition at line 37 of file ZdcUnpacker.h.

Referenced by unpack(), and ZdcUnpacker().

◆ expectedOrbitMessageTime_

int ZdcUnpacker::expectedOrbitMessageTime_
private

Expected orbit bunch time (needed to evaluate time differences)

Definition at line 38 of file ZdcUnpacker.h.

Referenced by setExpectedOrbitMessageTime(), and unpack().

◆ mode_

int ZdcUnpacker::mode_
private

Definition at line 41 of file ZdcUnpacker.h.

◆ sourceIdOffset_

int ZdcUnpacker::sourceIdOffset_
private

number to subtract from the source id to get the dcc id

Definition at line 35 of file ZdcUnpacker.h.

Referenced by unpack().

◆ startSample_

int ZdcUnpacker::startSample_
private

first sample from fed raw data to copy

Definition at line 36 of file ZdcUnpacker.h.

Referenced by unpack(), and ZdcUnpacker().

◆ unknownIds_

std::set<HcalElectronicsId> ZdcUnpacker::unknownIds_
private

Definition at line 39 of file ZdcUnpacker.h.

◆ unknownIdsTrig_

std::set<HcalElectronicsId> ZdcUnpacker::unknownIdsTrig_
private

Recorded to limit number of times a log message is generated.

Definition at line 39 of file ZdcUnpacker.h.

Generated for CMSSW Reference Manual by doxygen 1.8.14