HGCalSlinkEmulator Class Reference

Inheritance diagram for HGCalSlinkEmulator:

Public Member Functions
	HGCalSlinkEmulator (const edm::ParameterSet &)
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 Member Functions
void	produce (edm::Event &, const edm::EventSetup &) override

Private Attributes
std::unique_ptr< hgcal::econd::Emulator >	emulator_
const unsigned int	fed_id_
edm::EDPutTokenT< HGCalSlinkEmulatorInfo >	fedEmulInfoToken_
const edm::EDPutTokenT< FEDRawDataCollection >	fedRawToken_
hgcal::HGCalFrameGenerator	frame_gen_
edm::Service< edm::RandomNumberGenerator >	rng_
const bool	store_emul_info_
const bool	store_fed_header_trailer_

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 31 of file HGCalSlinkEmulator.cc.

Constructor & Destructor Documentation

HGCalSlinkEmulator()

HGCalSlinkEmulator::HGCalSlinkEmulator ( const edm::ParameterSet &  iConfig )

explicit

Definition at line 53 of file HGCalSlinkEmulator.cc.

References hgcal::HGCalFrameGenerator::econdParams(), emulator_, Exception, fedEmulInfoToken_, frame_gen_, edm::ParameterSet::getParameter(), edm::ParameterSet::getUntrackedParameter(), edm::Service< T >::isAvailable(), rng_, hgcal::HGCalFrameGenerator::setEmulator(), store_emul_info_, and AlCaHLTBitMon_QueryRunRegistry::string.

    : fed_id_(iConfig.getParameter<unsigned int>("fedId")),
      store_emul_info_(iConfig.getParameter<bool>("storeEmulatorInfo")),
      store_fed_header_trailer_(iConfig.getParameter<bool>("fedHeaderTrailer")),
      fedRawToken_(produces<FEDRawDataCollection>()),
      frame_gen_(iConfig) {
  // figure out which emulator is to be used
  const auto& emul_type = iConfig.getParameter<std::string>("emulatorType");
  if (frame_gen_.econdParams().empty())
    throw cms::Exception("HGCalSlinkEmulator")
        << "No ECON-D parameters were retrieved from the configuration. Please add at least one.";
  const auto& econd_params = frame_gen_.econdParams().begin()->second;
  if (emul_type == "trivial")
    emulator_ = std::make_unique<hgcal::econd::TrivialEmulator>(econd_params);
  else if (emul_type == "hgcmodule")
    emulator_ = std::make_unique<hgcal::econd::HGCalModuleTreeReader>(
        econd_params,
        iConfig.getUntrackedParameter<std::string>("treeName"),
        iConfig.getUntrackedParameter<std::vector<std::string>>("inputs"));
  else
    throw cms::Exception("HGCalSlinkEmulator") << "Invalid emulator type chosen: '" << emul_type << "'.";

  frame_gen_.setEmulator(*emulator_);

  // ensure the random number generator service is present in configuration
  if (!rng_.isAvailable())
    throw cms::Exception("HGCalSlinkEmulator") << "The HGCalSlinkEmulator module requires the "
                                                  "RandomNumberGeneratorService,\n"
                                                  "which appears to be absent. Please add that service to your "
                                                  "configuration\n"
                                                  "or remove the modules that require it.";

  if (store_emul_info_)
    fedEmulInfoToken_ = produces<HGCalSlinkEmulatorInfo>();
}

Member Function Documentation

fillDescriptions()

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

static

Definition at line 150 of file HGCalSlinkEmulator.cc.

References edm::ConfigurationDescriptions::add(), submitPVResolutionJobs::desc, hgcal::HGCalFrameGenerator::description(), and or.

                                                                                    {
  auto desc = hgcal::HGCalFrameGenerator::description();
  desc.ifValue(
          edm::ParameterDescription<std::string>("emulatorType", "trivial", true),
          // trivial emulator
          "trivial" >> edm::EmptyGroupDescription() or
              // test beam tree content
              "hgcmodule" >> (edm::ParameterDescription<std::string>("treeName", "hgcroc_rawdata/eventdata", false) and
                              edm::ParameterDescription<std::vector<std::string>>("inputs", {}, false)))
      ->setComment("emulator mode (trivial, or hgcmodule)");
  desc.add<unsigned int>("fedId", 0)->setComment("FED number delivering the emulated frames");
  desc.add<bool>("fedHeaderTrailer", false)->setComment("also add FED header/trailer info");
  desc.add<bool>("storeEmulatorInfo", false)
      ->setComment("also append a 'truth' auxiliary info to the output event content");
  descriptions.add("hgcalEmulatedSlinkRawData", desc);
}

produce()

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

overrideprivate

Definition at line 89 of file HGCalSlinkEmulator.cc.

References FEDHeader::bxID(), evf::compute_crc(), FEDTrailer::crc(), TauDecayModes::dec, FEDTrailer::evtStatus(), fed_id_, FEDRawDataCollection::FEDData(), fedEmulInfoToken_, fedRawToken_, FEDTrailer::fragmentLength(), frame_gen_, edm::RandomNumberGenerator::getEngine(), iEvent, hgcal::HGCalFrameGenerator::lastECONDEmulatedInput(), hgcal::HGCalFrameGenerator::lastSlinkEmulatedInfo(), FEDHeader::length, FEDTrailer::length, dqm-mbProfile::log, LogDebug, FEDHeader::lvl1ID(), eostools::move(), hgcal::HGCalFrameGenerator::produceSlinkEvent(), FEDRawData::resize(), rng_, FEDHeader::set(), FEDTrailer::set(), hgcal::HGCalFrameGenerator::setRandomEngine(), FEDHeader::sourceID(), store_emul_info_, and store_fed_header_trailer_.

                                                                              {
  frame_gen_.setRandomEngine(rng_->getEngine(iEvent.streamID()));

  // build the S-link payload
  auto slink_event = frame_gen_.produceSlinkEvent(fed_id_);
  const auto slink_event_size = slink_event.size() * sizeof(slink_event.at(0));

  // compute the total S-link payload size
  size_t total_event_size = slink_event_size;
  if (store_fed_header_trailer_)
    total_event_size += FEDHeader::length + FEDTrailer::length;

  // fill the output FED raw data collection
  FEDRawDataCollection raw_data;
  auto& fed_data = raw_data.FEDData(fed_id_);
  fed_data.resize(total_event_size);
  auto* ptr = fed_data.data();

  if (store_fed_header_trailer_) {
    const auto& last_event = frame_gen_.lastECONDEmulatedInput();
    const auto event_id = std::get<0>(last_event.first), bx_id = std::get<1>(last_event.first);
    int trg_type = 0;
    // compose 2*32-bit FED header word
    FEDHeader::set(ptr, trg_type, event_id, bx_id, fed_id_);
    LogDebug("HGCalSlinkEmulator").log([&](auto& log) {
      const FEDHeader hdr(ptr);
      log << "FED header: lvl1ID=" << hdr.lvl1ID() << ", bxID=" << hdr.bxID() << ", source ID=" << hdr.sourceID()
          << ".";
    });
    ptr += FEDHeader::length;
  }

  // insert ECON-D payload
  std::memcpy(ptr, slink_event.data(), slink_event_size);
  ptr += slink_event_size;
  LogDebug("HGCalSlinkEmulator") << "Wrote " << slink_event.size() << " 64-bit words = " << slink_event_size
                                 << " 8-bit words.";

  if (store_fed_header_trailer_) {
    // compose 2*32-bit FED trailer word
    FEDTrailer::set(ptr,
                    slink_event.size() + 2,
                    evf::compute_crc(reinterpret_cast<uint8_t*>(slink_event.data()), slink_event_size),
                    0,
                    0);
    LogDebug("HGCalSlinkEmulator").log([&](auto& log) {
      const FEDTrailer trl(ptr);
      log << "FED trailer: fragment length: " << trl.fragmentLength() << ", CRC=0x" << std::hex << trl.crc() << std::dec
          << ", status: " << trl.evtStatus() << ".";
    });
    ptr += FEDTrailer::length;
  }

  iEvent.emplace(fedRawToken_, std::move(raw_data));

  // store the emulation information if requested
  if (store_emul_info_)
    iEvent.emplace(fedEmulInfoToken_, frame_gen_.lastSlinkEmulatedInfo());
}

Member Data Documentation

emulator_

std::unique_ptr<hgcal::econd::Emulator> HGCalSlinkEmulator::emulator_

private

Definition at line 46 of file HGCalSlinkEmulator.cc.

Referenced by HGCalSlinkEmulator().

fed_id_

const unsigned int HGCalSlinkEmulator::fed_id_

private

Definition at line 40 of file HGCalSlinkEmulator.cc.

Referenced by produce().

fedEmulInfoToken_

edm::EDPutTokenT<HGCalSlinkEmulatorInfo> HGCalSlinkEmulator::fedEmulInfoToken_

private

Definition at line 49 of file HGCalSlinkEmulator.cc.

Referenced by HGCalSlinkEmulator(), and produce().

fedRawToken_

const edm::EDPutTokenT<FEDRawDataCollection> HGCalSlinkEmulator::fedRawToken_

private

Definition at line 45 of file HGCalSlinkEmulator.cc.

Referenced by produce().

frame_gen_

hgcal::HGCalFrameGenerator HGCalSlinkEmulator::frame_gen_

private

Definition at line 50 of file HGCalSlinkEmulator.cc.

Referenced by HGCalSlinkEmulator(), and produce().

rng_

edm::Service<edm::RandomNumberGenerator> HGCalSlinkEmulator::rng_

private

Definition at line 48 of file HGCalSlinkEmulator.cc.

Referenced by HGCalSlinkEmulator(), and produce().

store_emul_info_

const bool HGCalSlinkEmulator::store_emul_info_

private

Definition at line 42 of file HGCalSlinkEmulator.cc.

Referenced by HGCalSlinkEmulator(), and produce().

store_fed_header_trailer_

const bool HGCalSlinkEmulator::store_fed_header_trailer_

private

Definition at line 43 of file HGCalSlinkEmulator.cc.

Referenced by produce().