L1TCaloLayer1RawToDigi Class Reference

#include <EventFilter/L1TCaloLayer1RawToDigi/plugins/L1TCaloLayer1RawToDigi.cc>

Inheritance diagram for L1TCaloLayer1RawToDigi:

Public Member Functions
	L1TCaloLayer1RawToDigi (const ParameterSet &)
	~L1TCaloLayer1RawToDigi () override
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndRuns () const final

Static Public Member Functions
static void	fillDescriptions (ConfigurationDescriptions &descriptions)

Private Member Functions
void	beginStream (StreamID) override
void	endStream () override
void	makeECalTPGs (uint32_t lPhi, UCTCTP7RawData &ctp7Data, std::unique_ptr< EcalTrigPrimDigiCollection > &ecalTPGs)
void	makeHCalTPGs (uint32_t lPhi, UCTCTP7RawData &ctp7Data, std::unique_ptr< HcalTrigPrimDigiCollection > &hcalTPGs)
void	makeHFTPGs (uint32_t lPhi, UCTCTP7RawData &ctp7Data, std::unique_ptr< HcalTrigPrimDigiCollection > &hcalTPGs)
void	makeRegions (uint32_t lPhi, UCTCTP7RawData &ctp7Data, std::unique_ptr< L1CaloRegionCollection > &regions)
void	produce (Event &, const EventSetup &) override

Private Attributes
uint32_t	event
std::vector< int >	fedIDs
InputTag	fedRawDataLabel
bool	verbose

Additional Inherited Members
Public Types inherited from edm::stream::EDProducer<>
typedef CacheContexts< T... >	CacheTypes
typedef CacheTypes::GlobalCache	GlobalCache
typedef AbilityChecker< T... >	HasAbility
typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache
typedef LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext
typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache
typedef CacheTypes::RunCache	RunCache
typedef RunContextT< RunCache, GlobalCache >	RunContext
typedef CacheTypes::RunSummaryCache	RunSummaryCache

Detailed Description

Description: Raw data unpacker for Layer-1 of Level-1 Calorimeter Trigger

Implementation: This is meant to be simple and straight-forward.
Potential complications due to any changes in firmware are not foreseen. It is assumed that if there are major changes, which is unlikely, there will be a new unpacker written to deal with that.

Definition at line 67 of file L1TCaloLayer1RawToDigi.cc.

Constructor & Destructor Documentation

L1TCaloLayer1RawToDigi()

L1TCaloLayer1RawToDigi::L1TCaloLayer1RawToDigi ( const ParameterSet &  iConfig )

explicit

Definition at line 113 of file L1TCaloLayer1RawToDigi.cc.

    : fedRawDataLabel(iConfig.getParameter<InputTag>("fedRawDataLabel")),
      fedIDs(iConfig.getParameter<std::vector<int> >("FEDIDs")),
      event(0),
      verbose(iConfig.getParameter<bool>("verbose")) {
  produces<EcalTrigPrimDigiCollection>();
  produces<HcalTrigPrimDigiCollection>();
  produces<L1CaloRegionCollection>();
 
  consumes<FEDRawDataCollection>(fedRawDataLabel);
}

References fedRawDataLabel.

~L1TCaloLayer1RawToDigi()

L1TCaloLayer1RawToDigi::~L1TCaloLayer1RawToDigi ( )

override

Definition at line 125 of file L1TCaloLayer1RawToDigi.cc.

{}

Member Function Documentation

beginStream()

void L1TCaloLayer1RawToDigi::beginStream ( StreamID  )

overrideprivate

Definition at line 382 of file L1TCaloLayer1RawToDigi.cc.

{}

endStream()

void L1TCaloLayer1RawToDigi::endStream ( )

overrideprivate

Definition at line 385 of file L1TCaloLayer1RawToDigi.cc.

{}

fillDescriptions()

void L1TCaloLayer1RawToDigi::fillDescriptions ( ConfigurationDescriptions &  descriptions )

static

Definition at line 420 of file L1TCaloLayer1RawToDigi.cc.

                                                                                     {
  //The following says we do not know what parameters are allowed so do no validation
  // Please change this to state exactly what you do use, even if it is no parameters
  ParameterSetDescription desc;
  desc.setUnknown();
  descriptions.addDefault(desc);
}

References edm::ConfigurationDescriptions::addDefault(), and edm::ParameterSetDescription::setUnknown().

makeECalTPGs()

void L1TCaloLayer1RawToDigi::makeECalTPGs ( uint32_t  lPhi, UCTCTP7RawData &  ctp7Data, std::unique_ptr< EcalTrigPrimDigiCollection > &  ecalTPGs  )

private

Definition at line 201 of file L1TCaloLayer1RawToDigi.cc.

                                                                                               {
  UCTCTP7RawData::CaloType cType = UCTCTP7RawData::EBEE;
  for (uint32_t iPhi = 0; iPhi < 4; iPhi++) {  // Loop over all four phi divisions on card
    int cPhi = -1 + lPhi * 4 + iPhi;           // Calorimeter phi index
    if (cPhi == 0)
      cPhi = 72;
    else if (cPhi == -1)
      cPhi = 71;
    else if (cPhi < -1) {
      LogError("L1TCaloLayer1RawToDigi") << "L1TCaloLayer1RawToDigi: Major error in makeECalTPGs" << std::endl;
      return;
    }
    for (int cEta = -28; cEta <= 28; cEta++) {  // Calorimeter Eta indices (HB/HE for now)
      if (cEta != 0) {                          // Calorimeter eta = 0 is invalid
        bool negativeEta = false;
        if (cEta < 0)
          negativeEta = true;
        uint32_t iEta = abs(cEta);
        // This code is fragile! Note that towerDatum is packed as is done in EcalTriggerPrimitiveSample
        // Bottom 8-bits are ET
        // Then finegrain feature bit
        // Then three bits have ttBits, which I have no clue about (not available on ECAL links so not set)
        // Then there is a spare FG Veto bit, which is used for L1 spike detection (not available on ECAL links so not set)
        // Top three bits seem to be unused. So, we steal those to set the tower masking, link masking and link status information
        // To decode these custom three bits use ((EcalTriggerPrimitiveSample::raw() >> 13) & 0x7)
        uint32_t towerDatum = ctp7Data.getET(cType, negativeEta, iEta, iPhi);
        if (ctp7Data.getFB(cType, negativeEta, iEta, iPhi) != 0)
          towerDatum |= 0x0100;
        if (ctp7Data.isTowerMasked(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x2000;
        if (ctp7Data.isLinkMasked(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x4000;
        if (ctp7Data.isLinkMisaligned(cType, negativeEta, iEta, iPhi) ||
            ctp7Data.isLinkInError(cType, negativeEta, iEta, iPhi) ||
            ctp7Data.isLinkDown(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x8000;
        EcalTriggerPrimitiveSample sample(towerDatum);
        int zSide = cEta / ((int)iEta);
        // As far as I can tell, the ECal unpacker only uses barrel and endcap IDs, never EcalTriggerTower
        const EcalSubdetector ecalTriggerTower =
            (iEta > 17) ? EcalSubdetector::EcalEndcap : EcalSubdetector::EcalBarrel;
        EcalTrigTowerDetId id(zSide, ecalTriggerTower, iEta, cPhi);
        EcalTriggerPrimitiveDigi tpg(id);
        tpg.setSize(1);
        tpg.setSample(0, sample);
        ecalTPGs->push_back(tpg);
      }
    }
  }
}

References funct::abs(), UCTCTP7RawData::EBEE, EcalBarrel, EcalEndcap, UCTCTP7RawData::getET(), UCTCTP7RawData::getFB(), triggerObjects_cff::id, L1TowerCalibrationProducer_cfi::iEta, createfilelist::int, UCTCTP7RawData::isLinkDown(), UCTCTP7RawData::isLinkInError(), UCTCTP7RawData::isLinkMasked(), UCTCTP7RawData::isLinkMisaligned(), UCTCTP7RawData::isTowerMasked(), simplePhotonAnalyzer_cfi::sample, EcalTriggerPrimitiveDigi::setSample(), and EcalTriggerPrimitiveDigi::setSize().

Referenced by produce().

makeHCalTPGs()

void L1TCaloLayer1RawToDigi::makeHCalTPGs ( uint32_t  lPhi, UCTCTP7RawData &  ctp7Data, std::unique_ptr< HcalTrigPrimDigiCollection > &  hcalTPGs  )

private

Definition at line 254 of file L1TCaloLayer1RawToDigi.cc.

                                                                                               {
  UCTCTP7RawData::CaloType cType = UCTCTP7RawData::HBHE;
  for (uint32_t iPhi = 0; iPhi < 4; iPhi++) {  // Loop over all four phi divisions on card
    int cPhi = -1 + lPhi * 4 + iPhi;           // Calorimeter phi index
    if (cPhi == 0)
      cPhi = 72;
    else if (cPhi == -1)
      cPhi = 71;
    else if (cPhi < -1) {
      LogError("L1TCaloLayer1RawToDigi") << "L1TCaloLayer1RawToDigi: Major error in makeHCalTPGs" << std::endl;
      return;
    }
    for (int cEta = -28; cEta <= 28; cEta++) {  // Calorimeter Eta indices (HB/HE for now)
      if (cEta != 0) {                          // Calorimeter eta = 0 is invalid
        bool negativeEta = false;
        if (cEta < 0)
          negativeEta = true;
        uint32_t iEta = abs(cEta);
        // This code is fragile! Note that towerDatum is packed as is done in HcalTriggerPrimitiveSample
        // Bottom 8-bits are ET
        // Then feature bit
        // The remaining bits are undefined presently
        // We use next three bits for link details, which we did not have room in EcalTriggerPrimitiveSample case
        // We use next three bits to set the tower masking, link masking and link status information as done for Ecal
        // To decode these custom six bits use ((EcalTriggerPrimitiveSample::raw() >> 9) & 0x77)
        uint32_t towerDatum = ctp7Data.getET(cType, negativeEta, iEta, iPhi);
        if (ctp7Data.getFB(cType, negativeEta, iEta, iPhi) != 0)
          towerDatum |= 0x0100;
        if (ctp7Data.isLinkMisaligned(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x0200;
        if (ctp7Data.isLinkInError(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x0400;
        if (ctp7Data.isLinkDown(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x0800;
        if (ctp7Data.isTowerMasked(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x2000;
        if (ctp7Data.isLinkMasked(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x4000;
        if (ctp7Data.isLinkMisaligned(cType, negativeEta, iEta, iPhi) ||
            ctp7Data.isLinkInError(cType, negativeEta, iEta, iPhi) ||
            ctp7Data.isLinkDown(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x8000;
        HcalTriggerPrimitiveSample sample(towerDatum);
        HcalTrigTowerDetId id(cEta, cPhi);
        HcalTriggerPrimitiveDigi tpg(id);
        tpg.setSize(1);
        tpg.setSample(0, sample);
        hcalTPGs->push_back(tpg);
      }
    }
  }
}

References funct::abs(), UCTCTP7RawData::getET(), UCTCTP7RawData::getFB(), UCTCTP7RawData::HBHE, triggerObjects_cff::id, L1TowerCalibrationProducer_cfi::iEta, UCTCTP7RawData::isLinkDown(), UCTCTP7RawData::isLinkInError(), UCTCTP7RawData::isLinkMasked(), UCTCTP7RawData::isLinkMisaligned(), UCTCTP7RawData::isTowerMasked(), simplePhotonAnalyzer_cfi::sample, HcalTriggerPrimitiveDigi::setSample(), and HcalTriggerPrimitiveDigi::setSize().

Referenced by produce().

makeHFTPGs()

void L1TCaloLayer1RawToDigi::makeHFTPGs ( uint32_t  lPhi, UCTCTP7RawData &  ctp7Data, std::unique_ptr< HcalTrigPrimDigiCollection > &  hcalTPGs  )

private

Definition at line 309 of file L1TCaloLayer1RawToDigi.cc.

                                                                                             {
  UCTCTP7RawData::CaloType cType = UCTCTP7RawData::HF;
  for (uint32_t side = 0; side <= 1; side++) {
    bool negativeEta = false;
    if (side == 0)
      negativeEta = true;
    for (uint32_t iEta = 30; iEta <= 40; iEta++) {
      for (uint32_t iPhi = 0; iPhi < 2; iPhi++) {
        if (iPhi == 1 && iEta == 40)
          iEta = 41;
        int cPhi = 1 + lPhi * 4 + iPhi * 2;  // Calorimeter phi index: 1, 3, 5, ... 71
        if (iEta == 41)
          cPhi -= 2;                  // Last two HF are 3, 7, 11, ...
        cPhi = (cPhi + 69) % 72 + 1;  // cPhi -= 2 mod 72
        int cEta = iEta;
        if (negativeEta)
          cEta = -iEta;
        // This code is fragile! Note that towerDatum is packed as is done in HcalTriggerPrimitiveSample
        // Bottom 8-bits are ET
        // Then feature bit
        // Then minBias ADC count bit
        // The remaining bits are undefined presently
        // We use next three bits for link details, which we did not have room in EcalTriggerPrimitiveSample case
        // We use next three bits to set the tower masking, link masking and link status information as done for Ecal
        // To decode these custom six bits use ((EcalTriggerPrimitiveSample::raw() >> 9) & 0x77)
        uint32_t towerDatum = ctp7Data.getET(cType, negativeEta, iEta, iPhi);
        towerDatum |= ctp7Data.getFB(cType, negativeEta, iEta, iPhi) << 8;
        if (ctp7Data.isLinkMisaligned(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x0400;
        if (ctp7Data.isLinkInError(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x0800;
        if (ctp7Data.isLinkDown(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x1000;
        if (ctp7Data.isTowerMasked(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x2000;
        if (ctp7Data.isLinkMasked(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x4000;
        if (ctp7Data.isLinkMisaligned(cType, negativeEta, iEta, iPhi) ||
            ctp7Data.isLinkInError(cType, negativeEta, iEta, iPhi) ||
            ctp7Data.isLinkDown(cType, negativeEta, iEta, iPhi))
          towerDatum |= 0x8000;
        HcalTriggerPrimitiveSample sample(towerDatum);
        HcalTrigTowerDetId id(cEta, cPhi);
        id.setVersion(1);  // To not process these 1x1 HF TPGs with RCT
        HcalTriggerPrimitiveDigi tpg(id);
        tpg.setSize(1);
        tpg.setSample(0, sample);
        hcalTPGs->push_back(tpg);
      }
    }
  }
}

References UCTCTP7RawData::getET(), UCTCTP7RawData::getFB(), UCTCTP7RawData::HF, triggerObjects_cff::id, L1TowerCalibrationProducer_cfi::iEta, UCTCTP7RawData::isLinkDown(), UCTCTP7RawData::isLinkInError(), UCTCTP7RawData::isLinkMasked(), UCTCTP7RawData::isLinkMisaligned(), UCTCTP7RawData::isTowerMasked(), simplePhotonAnalyzer_cfi::sample, HcalTriggerPrimitiveDigi::setSample(), and HcalTriggerPrimitiveDigi::setSize().

Referenced by produce().

makeRegions()

void L1TCaloLayer1RawToDigi::makeRegions ( uint32_t  lPhi, UCTCTP7RawData &  ctp7Data, std::unique_ptr< L1CaloRegionCollection > &  regions  )

private

Definition at line 364 of file L1TCaloLayer1RawToDigi.cc.

                                                                                         {
  for (uint32_t side = 0; side <= 1; side++) {
    bool negativeEta = false;
    if (side == 0)
      negativeEta = true;
    for (uint32_t region = 0; region <= 6; region++) {
      uint32_t regionData = ctp7Data.getRegionSummary(negativeEta, region);
      uint32_t lEta = 10 - region;  // GCT eta goes 0-21, 0-3 -HF, 4-10 -B/E, 11-17 +B/E, 18-21 +HF
      if (!negativeEta)
        lEta = region + 11;
      regions->push_back(L1CaloRegion((uint16_t)regionData, (unsigned)lEta, (unsigned)lPhi, (int16_t)0));
    }
  }
}

References UCTCTP7RawData::getRegionSummary(), and HLT_2018_cff::region.

Referenced by produce().

produce()

void L1TCaloLayer1RawToDigi::produce ( Event &  iEvent, const EventSetup &  iSetup  )

overrideprivate

Definition at line 132 of file L1TCaloLayer1RawToDigi.cc.

                                                                            {
  using namespace edm;
  using namespace std;
 
  Handle<FEDRawDataCollection> fedRawDataCollection;
  iEvent.getByLabel(fedRawDataLabel, fedRawDataCollection);
 
  std::unique_ptr<EcalTrigPrimDigiCollection> ecalTPGs(new EcalTrigPrimDigiCollection);
  std::unique_ptr<HcalTrigPrimDigiCollection> hcalTPGs(new HcalTrigPrimDigiCollection);
  std::unique_ptr<L1CaloRegionCollection> regions(new L1CaloRegionCollection);
 
  // if raw data collection is present, check the headers and do the unpacking
  if (fedRawDataCollection.isValid()) {
    for (uint32_t i = 0; i < fedIDs.size(); i++) {
      uint32_t fed = fedIDs[i];
 
      const FEDRawData& fedRawData = fedRawDataCollection->FEDData(fed);
 
      //Check FED size
      if (verbose)
        LogDebug("L1TCaloLayer1RawToDigi")
            << "Upacking FEDRawData for fed " << std::dec << fed << " of size " << fedRawData.size();
 
      const uint64_t* fedRawDataArray = (const uint64_t*)fedRawData.data();
 
      if (fedRawData.size() == 0 || fedRawDataArray == nullptr) {
        LogDebug("L1TCaloLayer1RawToDigi") << "Could not load FED data for " << fed << ", putting empty collections!";
        continue;
      }
 
      UCTDAQRawData daqData(fedRawDataArray);
      if (verbose && event < 5)
        daqData.print();
      for (uint32_t i = 0; i < daqData.nAMCs(); i++) {
        UCTAMCRawData amcData(daqData.amcPayload(i));
        if (verbose && event < 5) {
          LogDebug("L1TCaloLayer1") << endl;
          amcData.print();
          LogDebug("L1TCaloLayer1") << endl;
        }
        uint32_t lPhi = amcData.layer1Phi();
        UCTCTP7RawData ctp7Data(amcData.payload());
        if (verbose && event < 5)
          ctp7Data.print();
        if (verbose && event < 5)
          LogDebug("L1TCaloLayer1") << endl;
        makeECalTPGs(lPhi, ctp7Data, ecalTPGs);
        makeHCalTPGs(lPhi, ctp7Data, hcalTPGs);
        // Note: HF TPGs are added at the tail of other TPGs
        makeHFTPGs(lPhi, ctp7Data, hcalTPGs);
        makeRegions(lPhi, ctp7Data, regions);
      }
    }
 
  } else {
    LogError("L1T") << "Cannot unpack: no collection found";
 
    return;
  }
 
  iEvent.put(std::move(ecalTPGs));
  iEvent.put(std::move(hcalTPGs));
  iEvent.put(std::move(regions));
 
  event++;
  if (verbose && event == 5)
    LogDebug("L1TCaloLayer1") << "L1TCaloLayer1RawToDigi: Goodbye! Tired of printing junk" << endl;
}

References UCTDAQRawData::amcPayload(), TauDecayModes::dec, FEDRawDataCollection::FEDData(), fedIDs, l1t_dqm_sourceclient-live_cfg::fedRawData, fedRawDataLabel, mps_fire::i, iEvent, edm::HandleBase::isValid(), LogDebug, makeECalTPGs(), makeHCalTPGs(), makeHFTPGs(), makeRegions(), eostools::move(), UCTDAQRawData::nAMCs(), UCTDAQRawData::print(), UCTCTP7RawData::print(), and verbose.

Member Data Documentation

event

uint32_t L1TCaloLayer1RawToDigi::event

private

Definition at line 97 of file L1TCaloLayer1RawToDigi.cc.

Referenced by Types.EventID::cppID(), looper.Looper::process(), and core.AutoHandle.AutoHandle::product().

fedIDs

std::vector<int> L1TCaloLayer1RawToDigi::fedIDs

private

Definition at line 95 of file L1TCaloLayer1RawToDigi.cc.

Referenced by produce().

fedRawDataLabel

InputTag L1TCaloLayer1RawToDigi::fedRawDataLabel

private

Definition at line 94 of file L1TCaloLayer1RawToDigi.cc.

Referenced by L1TCaloLayer1RawToDigi(), and produce().

verbose

bool L1TCaloLayer1RawToDigi::verbose

private

Definition at line 99 of file L1TCaloLayer1RawToDigi.cc.

Referenced by python.diff_provenance.difference::list_diff(), python.diffProv.difference::list_diff(), python.diff_provenance.difference::module_diff(), python.diffProv.difference::module_diff(), python.diff_provenance.difference::onefilemodules(), python.diffProv.difference::onefilemodules(), core.TriggerMatchAnalyzer.TriggerMatchAnalyzer::process(), core.SkimAnalyzerCount.SkimAnalyzerCount::process(), objects.VertexAnalyzer.VertexAnalyzer::process(), produce(), and confdbOfflineConverter.OfflineConverter::query().