TotemVFATRawToDigi Class Reference

Inheritance diagram for TotemVFATRawToDigi:

Public Member Functions
void	endStream () override
void	produce (edm::Event &, const edm::EventSetup &) override
	TotemVFATRawToDigi (const edm::ParameterSet &)
	~TotemVFATRawToDigi () override
Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
const EDProducer &	operator= (const EDProducer &)=delete

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &)

Private Types
enum	{   ssUndefined, ssTrackingStrip, ssTimingDiamond, ssTotemTiming,   ssTotemT2 }

Private Member Functions
template<typename DigiType >
void	run (edm::Event &, const edm::EventSetup &)

Private Attributes
edm::ESGetToken< TotemAnalysisMask, TotemAnalysisMaskRcd >	analysisMaskToken
CTPPSRawToDigiErrorSummary	errSummary
edm::EDGetTokenT< FEDRawDataCollection >	fedDataToken
std::vector< unsigned int >	fedIds
pps::RawDataUnpacker	rawDataUnpacker
RawToDigiConverter	rawToDigiConverter
enum TotemVFATRawToDigi:: { ... }	subSystem
std::string	subSystemName
edm::ESGetToken< TotemDAQMapping, TotemReadoutRcd >	totemMappingToken

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

Detailed Description

Definition at line 45 of file TotemVFATRawToDigi.cc.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
ssUndefined
ssTrackingStrip
ssTimingDiamond
ssTotemTiming
ssTotemT2

Definition at line 57 of file TotemVFATRawToDigi.cc.

{ ssUndefined, ssTrackingStrip, ssTimingDiamond, ssTotemTiming, ssTotemT2 } subSystem;

Constructor & Destructor Documentation

TotemVFATRawToDigi()

TotemVFATRawToDigi::TotemVFATRawToDigi ( const edm::ParameterSet &  conf )

explicit

Definition at line 76 of file TotemVFATRawToDigi.cc.

References analysisMaskToken, Exception, fedDataToken, l1tstage2_dqm_sourceclient-live_cfg::fedId, fedIds, edm::ParameterSet::getParameter(), l1ctLayer2EG_cff::id, dqm-mbProfile::log, LogDebug, FEDNumbering::MAXCTPPSDiamondFEDID, FEDNumbering::MAXTotemRPHorizontalFEDID, FEDNumbering::MAXTotemRPTimingVerticalFEDID, FEDNumbering::MAXTotemRPVerticalFEDID, FEDNumbering::MAXTotemT2FEDID, FEDNumbering::MINCTPPSDiamondFEDID, FEDNumbering::MINTotemRPHorizontalFEDID, FEDNumbering::MINTotemRPTimingVerticalFEDID, FEDNumbering::MINTotemRPVerticalFEDID, FEDNumbering::MINTotemT2FEDID, ssTimingDiamond, ssTotemT2, ssTotemTiming, ssTrackingStrip, ssUndefined, subSystem, subSystemName, and totemMappingToken.

    : subSystemName(conf.getParameter<string>("subSystem")),
      subSystem(ssUndefined),
      fedIds(conf.getParameter<vector<unsigned int>>("fedIds")),
      rawDataUnpacker(conf.getParameterSet("RawUnpacking")),
      rawToDigiConverter(conf.getParameterSet("RawToDigi")),
      errSummary("TotemVFATRawToDigi", "[TotemVFATRawToDigi]", false) {
  fedDataToken = consumes<FEDRawDataCollection>(conf.getParameter<edm::InputTag>("rawDataTag"));

  // validate chosen subSystem
  if (subSystemName == "TrackingStrip")
    subSystem = ssTrackingStrip;
  else if (subSystemName == "TimingDiamond")
    subSystem = ssTimingDiamond;
  else if (subSystemName == "TotemTiming")
    subSystem = ssTotemTiming;
  else if (subSystemName == "TotemT2")
    subSystem = ssTotemT2;

  if (subSystem == ssUndefined)
    throw cms::Exception("TotemVFATRawToDigi::TotemVFATRawToDigi")
        << "Unknown sub-system string " << subSystemName << "." << endl;

  // FED (OptoRx) headers and footers
  produces<vector<TotemFEDInfo>>(subSystemName);

  // declare products
  if (subSystem == ssTrackingStrip)
    produces<DetSetVector<TotemRPDigi>>(subSystemName);

  else if (subSystem == ssTimingDiamond)
    produces<DetSetVector<CTPPSDiamondDigi>>(subSystemName);

  else if (subSystem == ssTotemTiming)
    produces<DetSetVector<TotemTimingDigi>>(subSystemName);

  else if (subSystem == ssTotemT2)
    produces<edmNew::DetSetVector<TotemT2Digi>>(subSystemName);

  // set default IDs
  if (fedIds.empty()) {
    if (subSystem == ssTrackingStrip) {
      for (int id = FEDNumbering::MINTotemRPHorizontalFEDID; id <= FEDNumbering::MAXTotemRPHorizontalFEDID; ++id)
        fedIds.push_back(id);

      for (int id = FEDNumbering::MINTotemRPVerticalFEDID; id <= FEDNumbering::MAXTotemRPVerticalFEDID; ++id)
        fedIds.push_back(id);
    }

    else if (subSystem == ssTimingDiamond) {
      for (int id = FEDNumbering::MINCTPPSDiamondFEDID; id <= FEDNumbering::MAXCTPPSDiamondFEDID; ++id)
        fedIds.push_back(id);
    }

    else if (subSystem == ssTotemTiming) {
      for (int id = FEDNumbering::MINTotemRPTimingVerticalFEDID; id <= FEDNumbering::MAXTotemRPTimingVerticalFEDID;
           ++id)
        fedIds.push_back(id);
    }

    else if (subSystem == ssTotemT2) {
      for (int id = FEDNumbering::MINTotemT2FEDID; id <= FEDNumbering::MAXTotemT2FEDID; ++id)
        fedIds.push_back(id);
    }
  }
  LogDebug("TotemVFATRawToDigi").log([this](auto &log) {
    log << "List of FEDs handled by this instance: ";
    string sep;
    for (const auto &fedId : fedIds)
      log << sep << fedId, sep = ", ";
  });

  // conversion status
  produces<DetSetVector<TotemVFATStatus>>(subSystemName);

  totemMappingToken = esConsumes<TotemDAQMapping, TotemReadoutRcd>(ESInputTag("", subSystemName));
  analysisMaskToken = esConsumes<TotemAnalysisMask, TotemAnalysisMaskRcd>(ESInputTag("", subSystemName));
}

~TotemVFATRawToDigi()

TotemVFATRawToDigi::~TotemVFATRawToDigi ( )

override

Definition at line 155 of file TotemVFATRawToDigi.cc.

{}

Member Function Documentation

endStream()

void TotemVFATRawToDigi::endStream ( )

override

Definition at line 226 of file TotemVFATRawToDigi.cc.

References errSummary, RawToDigiConverter::printSummaries(), CTPPSRawToDigiErrorSummary::printSummary(), and rawToDigiConverter.

                                   {
  rawToDigiConverter.printSummaries();
  errSummary.printSummary();
}

fillDescriptions()

void TotemVFATRawToDigi::fillDescriptions ( edm::ConfigurationDescriptions &  descriptions )

static

Definition at line 231 of file TotemVFATRawToDigi.cc.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), edm::ParameterSetDescription::addUntracked(), submitPVResolutionJobs::desc, ProducerED_cfi::InputTag, edm::ParameterDescriptionNode::setComment(), and AlCaHLTBitMon_QueryRunRegistry::string.

                                                                                    {
  // totemVFATRawToDigi
  edm::ParameterSetDescription desc;
  desc.add<edm::InputTag>("rawDataTag", edm::InputTag(""));
  desc.add<std::string>("subSystem", "")->setComment("options: RP");
  desc.add<std::vector<unsigned int>>("fedIds", {})
      ->setComment(
          "IMPORTANT: leave empty to load the default configuration from "
          "DataFormats/FEDRawData/interface/FEDNumbering.h");
  {
    edm::ParameterSetDescription psd0;
    psd0.addUntracked<unsigned int>("verbosity", 0);
    desc.add<edm::ParameterSetDescription>("RawUnpacking", psd0);
  }
  {
    edm::ParameterSetDescription psd0;
    psd0.addUntracked<unsigned int>("verbosity", 0)
        ->setComment(
            "0-3: 1=one line/event with some corrupted VFAT frame, 2=list all corrupt VFAT frames/event, 3=all "
            "problems with every corrupt frame");
    psd0.add<unsigned int>("testFootprint", 2)->setComment("0=no test, 1=warn only, 2=warn and skip");
    psd0.add<unsigned int>("testCRC", 2);
    psd0.add<unsigned int>("testID", 2)->setComment("compare the ID from data and mapping");
    psd0.add<unsigned int>("testECMostFrequent", 2)
        ->setComment("compare frame EC with the most frequent value in the event");
    psd0.add<unsigned int>("testBCMostFrequent", 2);
    psd0.addUntracked<unsigned int>("EC_min", 10)
        ->setComment("minimal number of frames to search for the most frequent counter value");
    psd0.addUntracked<unsigned int>("BC_min", 10);
    psd0.addUntracked<double>("EC_fraction", 0.6)
        ->setComment(
            "the most frequent counter value is accepted provided its relative occupancy is higher than this fraction");
    psd0.addUntracked<double>("BC_fraction", 0.6);
    psd0.add<bool>("useOlderT2TestFile", false)
        ->setComment("treat hwID field as two separate 8-bit fields instead of one 16-bit");
    psd0.addUntracked<bool>("printErrorSummary", false)->setComment("per-VFAT error summary at the end of the job");
    psd0.addUntracked<bool>("printUnknownFrameSummary", false)
        ->setComment("summary of frames found in data, but not in the mapping");
    desc.add<edm::ParameterSetDescription>("RawToDigi", psd0);
  }
  descriptions.add("totemVFATRawToDigi", desc);
  // or use the following to generate the label from the module's C++ type
  //descriptions.addWithDefaultLabel(desc);
}

produce()

void TotemVFATRawToDigi::produce ( edm::Event &  event, const edm::EventSetup &  es  )

override

Definition at line 157 of file TotemVFATRawToDigi.cc.

References edmPickEvents::event, ssTimingDiamond, ssTotemT2, ssTotemTiming, ssTrackingStrip, and subSystem.

                                                                         {
  if (subSystem == ssTrackingStrip)
    run<DetSetVector<TotemRPDigi>>(event, es);

  else if (subSystem == ssTimingDiamond)
    run<DetSetVector<CTPPSDiamondDigi>>(event, es);

  else if (subSystem == ssTotemTiming)
    run<DetSetVector<TotemTimingDigi>>(event, es);

  else if (subSystem == ssTotemT2)
    run<edmNew::DetSetVector<TotemT2Digi>>(event, es);
}

run()

template<typename DigiType >

void TotemVFATRawToDigi::run ( edm::Event &  event, const edm::EventSetup &  es  )

private

Definition at line 172 of file TotemVFATRawToDigi.cc.

References CTPPSRawToDigiErrorSummary::add(), analysisMaskToken, data, ALCARECOTkAlDQM_cff::DigiType, errSummary, Exception, edm::ESHandleBase::failedToGet(), fedDataToken, l1tstage2_dqm_sourceclient-live_cfg::fedId, fedIds, dqm-mbProfile::format, edm::EventSetup::getHandle(), edm::ESHandleBase::isValid(), taus_updatedMVAIds_cff::mapping, l1tstage2_dqm_sourceclient-live_cfg::rawData, rawDataUnpacker, rawToDigiConverter, RawToDigiConverter::run(), pps::RawDataUnpacker::run(), subSystemName, and totemMappingToken.

Referenced by Types.EventID::cppID(), and Types.LuminosityBlockID::cppID().

                                                                     {
  // mapping and analysis mask
  ESHandle<TotemDAQMapping> mapping;
  ESHandle<TotemAnalysisMask> analysisMaskHandle;
  TotemAnalysisMask analysisMask;

  // raw data handle
  edm::Handle<FEDRawDataCollection> rawData;
  event.getByToken(fedDataToken, rawData);

  // book output products
  vector<TotemFEDInfo> fedInfo;
  DigiType digi;
  DetSetVector<TotemVFATStatus> conversionStatus;

  // raw-data unpacking
  bool data_exist = false;
  SimpleVFATFrameCollection vfatCollection;
  for (const auto &fedId : fedIds) {
    const FEDRawData &data = rawData->FEDData(fedId);
    if (data.size() > 0) {
      rawDataUnpacker.run(fedId, data, fedInfo, vfatCollection);
      data_exist = true;
    }
  }

  // get mapping records and do raw-to-digi conversion only if some data exists
  if (data_exist) {
    // get DAQ mapping
    mapping = es.getHandle(totemMappingToken);
    if (!mapping.isValid() || mapping.failedToGet()) {
      throw cms::Exception("TotemVFATRawToDigi::TotemVFATRawToDigi")
          << "No DAQMapping found for " << subSystemName << "." << endl;
    }

    // get analysis mask to mask channels
    analysisMaskHandle = es.getHandle(analysisMaskToken);
    if (analysisMaskHandle.isValid() && !analysisMaskHandle.failedToGet()) {
      analysisMask = *analysisMaskHandle;
    } else {
      errSummary.add(fmt::format("No AnalysisMask found for {0}", subSystemName), "");
      analysisMask = TotemAnalysisMask();
    }

    // raw-to-digi conversion
    rawToDigiConverter.run(vfatCollection, *mapping, analysisMask, digi, conversionStatus);
  }

  // commit products to event
  event.put(make_unique<vector<TotemFEDInfo>>(fedInfo), subSystemName);
  event.put(make_unique<DigiType>(digi), subSystemName);
  event.put(make_unique<DetSetVector<TotemVFATStatus>>(conversionStatus), subSystemName);
}

Member Data Documentation

analysisMaskToken

edm::ESGetToken<TotemAnalysisMask, TotemAnalysisMaskRcd> TotemVFATRawToDigi::analysisMaskToken

private

Definition at line 63 of file TotemVFATRawToDigi.cc.

Referenced by run(), and TotemVFATRawToDigi().

errSummary

CTPPSRawToDigiErrorSummary TotemVFATRawToDigi::errSummary

private

Definition at line 67 of file TotemVFATRawToDigi.cc.

Referenced by endStream(), and run().

fedDataToken

edm::EDGetTokenT<FEDRawDataCollection> TotemVFATRawToDigi::fedDataToken

private

Definition at line 61 of file TotemVFATRawToDigi.cc.

Referenced by run(), and TotemVFATRawToDigi().

fedIds

std::vector<unsigned int> TotemVFATRawToDigi::fedIds

private

Definition at line 59 of file TotemVFATRawToDigi.cc.

Referenced by run(), and TotemVFATRawToDigi().

rawDataUnpacker

pps::RawDataUnpacker TotemVFATRawToDigi::rawDataUnpacker

private

Definition at line 65 of file TotemVFATRawToDigi.cc.

Referenced by run().

rawToDigiConverter

RawToDigiConverter TotemVFATRawToDigi::rawToDigiConverter

private

Definition at line 66 of file TotemVFATRawToDigi.cc.

Referenced by endStream(), and run().

subSystem

enum { ... } TotemVFATRawToDigi::subSystem

Referenced by produce(), and TotemVFATRawToDigi().

subSystemName

std::string TotemVFATRawToDigi::subSystemName

private

Definition at line 55 of file TotemVFATRawToDigi.cc.

Referenced by run(), and TotemVFATRawToDigi().

totemMappingToken

edm::ESGetToken<TotemDAQMapping, TotemReadoutRcd> TotemVFATRawToDigi::totemMappingToken

private

Definition at line 62 of file TotemVFATRawToDigi.cc.

Referenced by run(), and TotemVFATRawToDigi().