SiStripSpyEventSummaryProducer.cc

Go to the documentation of this file.

//Class to produce a dummy SiStripEventSummary object so that spy channel data can be used with commissioning software.
//Run types which need additional parameters from the trigger FED buffer or DAQ registers are not supported.
//If an unsupported run type is used, an error message will be printed and parameters will be set to zero.
//Author: Nick Cripps
//Date: 10/05/2010

#include "FWCore/Utilities/interface/EDGetToken.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/global/EDProducer.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/EventSetup.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/Utilities/interface/InputTag.h"
#include "DataFormats/Common/interface/Handle.h"
#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "DataFormats/SiStripCommon/interface/SiStripEventSummary.h"
#include "DataFormats/SiStripCommon/interface/ConstantsForRunType.h"
#include "DataFormats/FEDRawData/interface/FEDRawDataCollection.h"
#include "DataFormats/FEDRawData/interface/FEDRawData.h"
#include "EventFilter/SiStripRawToDigi/interface/SiStripFEDBufferComponents.h"
#include <cstdint>
#include <memory>
#include <string>
#include <vector>

using edm::LogError;
using edm::LogInfo;
using edm::LogWarning;

namespace sistrip {

  class SpyEventSummaryProducer : public edm::global::EDProducer<> {
  public:
    SpyEventSummaryProducer(const edm::ParameterSet& config);
    void produce(edm::StreamID, edm::Event& event, const edm::EventSetup&) const override;

  private:
    void warnAboutUnsupportedRunType() const;
    static const char* const messageLabel_;
    const edm::InputTag rawDataTag_;
    edm::EDGetTokenT<FEDRawDataCollection> rawDataToken_;
    const sistrip::RunType runType_;
  };

}  // namespace sistrip

namespace sistrip {

  const char* const SpyEventSummaryProducer::messageLabel_ = "SiStripSpyEventSummaryProducer";

  SpyEventSummaryProducer::SpyEventSummaryProducer(const edm::ParameterSet& config)
      : rawDataTag_(config.getParameter<edm::InputTag>("RawDataTag")),
        runType_(sistrip::RunType(config.getParameter<uint32_t>("RunType"))) {
    rawDataToken_ = consumes<FEDRawDataCollection>(rawDataTag_);
    produces<SiStripEventSummary>();
    warnAboutUnsupportedRunType();
  }

  void SpyEventSummaryProducer::produce(edm::StreamID, edm::Event& event, const edm::EventSetup&) const {
    warnAboutUnsupportedRunType();

    //get the event number and Bx counter from the first valud FED buffer
    edm::Handle<FEDRawDataCollection> rawDataHandle;
    event.getByToken(rawDataToken_, rawDataHandle);
    const FEDRawDataCollection& rawData = *rawDataHandle;
    bool fedFound = false;
    uint32_t fedEventNumber = 0;
    uint32_t fedBxNumber = 0;
    for (uint16_t fedId = sistrip::FED_ID_MIN; fedId <= sistrip::FED_ID_MAX; ++fedId) {
      const FEDRawData& fedData = rawData.FEDData(fedId);
      if (fedData.size() && fedData.data()) {
        const auto st_buffer = preconstructCheckFEDBufferBase(fedData);
        if (sistrip::FEDBufferStatusCode::SUCCESS != st_buffer) {
          LogInfo(messageLabel_) << "Skipping FED " << fedId << " because of exception: "
                                 << "An exception of category 'FEDBuffer' occurred.\n"
                                 << st_buffer;
          continue;
        }
        const sistrip::FEDBufferBase buffer{fedData};
        fedEventNumber = buffer.daqLvl1ID();
        fedBxNumber = buffer.daqBXID();
        fedFound = true;
        break;
      }
    }
    if (!fedFound) {
      LogError(messageLabel_) << "No SiStrip FED data found in raw data.";
      return;
    }

    //create summary object
    std::unique_ptr<SiStripEventSummary> pSummary(new SiStripEventSummary);
    //set the trigger FED number to zero to indicate that it doesn't exist
    pSummary->triggerFed(0);
    //set the event number and Bx from the FED packets
    pSummary->event(fedEventNumber);
    pSummary->bx(fedBxNumber);
    //create a fake trigger FED buffer to take comissioning parameters from
    const int maxTriggerFedBufferSize = 84;
    std::vector<uint32_t> fakeTriggerFedData(maxTriggerFedBufferSize);
    for (uint8_t i = 0; i < maxTriggerFedBufferSize; ++i) {
      fakeTriggerFedData[i] = 0;
    }
    //set the FED readout mode to virgin raw
    fakeTriggerFedData[15] = 1;
    //set the spill number
    fakeTriggerFedData[0] = 0;
    //set the number of data senders
    fakeTriggerFedData[20] = 1;
    //set the run type
    fakeTriggerFedData[10] = runType_;
    //fill the summarry using trigger FED buffer  with no data
    pSummary->commissioningInfo(fakeTriggerFedData.data(), fedEventNumber);

    //store in event
    event.put(std::move(pSummary));
  }

  void SpyEventSummaryProducer::warnAboutUnsupportedRunType() const {
    switch (runType_) {
      case sistrip::DAQ_SCOPE_MODE:
      case sistrip::PHYSICS:
      case sistrip::PHYSICS_ZS:
      case sistrip::PEDESTALS:
      case sistrip::MULTI_MODE:
      case sistrip::PEDS_ONLY:
      case sistrip::NOISE:
      case sistrip::PEDS_FULL_NOISE:
      case sistrip::UNKNOWN_RUN_TYPE:
      case sistrip::UNDEFINED_RUN_TYPE:
        break;
      case sistrip::CALIBRATION:
      case sistrip::CALIBRATION_DECO:
      case sistrip::CALIBRATION_SCAN:
      case sistrip::CALIBRATION_SCAN_DECO:
      case sistrip::APV_LATENCY:
      case sistrip::OPTO_SCAN:
      case sistrip::APV_TIMING:
      case sistrip::FED_TIMING:
      case sistrip::FINE_DELAY:
      case sistrip::FINE_DELAY_PLL:
      case sistrip::FINE_DELAY_TTC:
      case sistrip::FAST_CABLING:
      case sistrip::FED_CABLING:
      case sistrip::QUITE_FAST_CABLING:
      case sistrip::VPSP_SCAN:
        LogWarning(messageLabel_) << "Unsupported run type: " << runType_
                                  << ". Parameters need to be set from real trigger FED. Parameters will be set to 0.";
        break;
    }
  }

}  // namespace sistrip

typedef sistrip::SpyEventSummaryProducer SiStripSpyEventSummaryProducer;
DEFINE_FWK_MODULE(SiStripSpyEventSummaryProducer);