L1TS2PFJetInputPatternWriter.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    L1Trigger/L1CaloTrigger
// Class:      L1TS2PFJetInputPatternWriter
//
//
// Original Author:  Aaron Bundock
//         Created:  Fri, 26 Jul 2018 14:20:25 GMT
//
//

// system include files
#include <memory>

// user include files
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/one/EDAnalyzer.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ServiceRegistry/interface/Service.h"
#include "CommonTools/UtilAlgos/interface/TFileService.h"
#include "L1Trigger/L1TCalorimeter/interface/CaloTools.h"
#include "DataFormats/L1TParticleFlow/interface/PFCandidate.h"

#include <fstream>
#include <iostream>
#include <iomanip>
#include <cmath>

//
// class declaration
//

constexpr unsigned int bit_shift_phi = 16;
constexpr unsigned int bit_shift_eta = 26;
constexpr unsigned int mod_13_1 = 1;
constexpr unsigned int mod_13_2 = 2;
constexpr unsigned int n_latency_clocks = 13;
constexpr unsigned int n_first_empty_frames = 14;
constexpr unsigned int framesPerFile = 1015;
constexpr float eta_first_region_boundary = 0.75;
constexpr float eta_second_region_boundary = 1.5;
constexpr float phi_region_boundary = 0.7;
constexpr unsigned int hash_bitmask_16 = 0xffff;  // (2^16)-1
constexpr unsigned int hash_bitmask_10 = 0x3ff;   // (2^10)-1
constexpr float ptLSB = 0.25;
constexpr float etaLSB = 0.0043633231;
constexpr float phiLSB = 0.0043633231;

class L1TS2PFJetInputPatternWriter : public edm::one::EDAnalyzer<> {
public:
  explicit L1TS2PFJetInputPatternWriter(const edm::ParameterSet&);
  ~L1TS2PFJetInputPatternWriter() override;

  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);

private:
  void beginJob() override;
  void analyze(const edm::Event&, const edm::EventSetup&) override;
  void endJob() override;

  // ----------member data ---------------------------
  edm::EDGetTokenT<std::vector<l1t::PFCandidate>> pfToken_;
  std::string filename_;
  std::string outDir_;

  // constants
  unsigned nChan_;  // number of channels per quad
  unsigned nQuad_;
  unsigned nLink_;
  unsigned nHeaderFrames_;
  unsigned nPayloadFrames_;
  unsigned nClearFrames_;
  unsigned nFrame_;
  unsigned nFrameFile_;
  unsigned nEvents_;

  // data arranged by link and frame
  std::vector<std::vector<uint64_t>> data_;

  // data valid flags (just one per frame for now)
  std::vector<int> dataValid_;

  // map of towers onto links/frames
  std::map<int, int> map_;
};

//
// constants, enums and typedefs
//

//
// static data member definitions
//

//
// constructors and destructor
//
L1TS2PFJetInputPatternWriter::L1TS2PFJetInputPatternWriter(const edm::ParameterSet& iConfig)
    : pfToken_(consumes<std::vector<l1t::PFCandidate>>(iConfig.getParameter<edm::InputTag>("pfTag"))),
      filename_(iConfig.getUntrackedParameter<std::string>("filename")),
      outDir_(iConfig.getUntrackedParameter<std::string>("outDir")),
      nChan_(iConfig.getUntrackedParameter<unsigned>("nChanPerQuad")),
      nQuad_(iConfig.getUntrackedParameter<unsigned>("nQuads")),
      nHeaderFrames_(iConfig.getUntrackedParameter<unsigned>("nHeaderFrames")),
      nPayloadFrames_(iConfig.getUntrackedParameter<unsigned>("nPayloadFrames")),
      nClearFrames_(iConfig.getUntrackedParameter<unsigned>("nClearFrames")) {
  //now do what ever initialization is needed

  // register what you consume and keep token for later access:

  nFrame_ = 0;
  nFrameFile_ = 0;
  nEvents_ = 0;

  nLink_ = nChan_ * nQuad_;
  data_.resize(nLink_);
  LogDebug("L1TDebug") << "Preparing for " << nLink_ << " links" << std::endl;
}

L1TS2PFJetInputPatternWriter::~L1TS2PFJetInputPatternWriter() {
  // do anything here that needs to be done at desctruction time
  // (e.g. close files, deallocate resources etc.)
}

//
// member functions
//

// ------------ method called for each event  ------------
void L1TS2PFJetInputPatternWriter::analyze(const edm::Event& iEvent, const edm::EventSetup& iSetup) {
  using namespace edm;

  //count events
  nEvents_++;

  edm::Handle<std::vector<l1t::PFCandidate>> pfHandle;
  iEvent.getByToken(pfToken_, pfHandle);
  std::vector<l1t::PFCandidate> const& pfCands = *pfHandle;

  std::vector<l1t::PFCandidate> pfPartsA;
  std::vector<l1t::PFCandidate> pfPartsB;

  for (auto const& pfc : pfCands) {
    // select first two "small" regions for current fw
    if (pfc.eta() >= 0 && pfc.eta() < eta_first_region_boundary && pfc.phi() >= 0 && pfc.phi() < phi_region_boundary)
      pfPartsA.push_back(pfc);
    if (pfc.eta() >= eta_first_region_boundary && pfc.eta() < eta_second_region_boundary && pfc.phi() >= 0 &&
        pfc.phi() < phi_region_boundary)
      pfPartsB.push_back(pfc);
  }

  if (pfPartsA.empty() && pfPartsB.empty())
    return;

  if (nFrame_ == 0 || nFrameFile_ == 0) {
    //first empty frames
    while (nFrameFile_ < n_first_empty_frames) {
      dataValid_.push_back(1);
      for (unsigned iQuad = 0; iQuad < nQuad_; ++iQuad) {
        for (unsigned iChan = 0; iChan < nChan_; ++iChan) {
          uint iLink = (iQuad * nChan_) + iChan;
          data_.at(iLink).push_back(0);
        }
      }
      nFrame_++;
      nFrameFile_++;
    }
  }

  // loop over frames
  for (unsigned iFrame = 0; iFrame < nPayloadFrames_; ++iFrame) {
    dataValid_.push_back(1);
    // loop over links
    for (unsigned iQuad = 0; iQuad < nQuad_; ++iQuad) {
      for (unsigned iChan = 0; iChan < nChan_; ++iChan) {
        // get tower ieta, iphi for link
        uint iLink = (iQuad * nChan_) + iChan;

        uint64_t data = 0;

        if ((nFrameFile_ % n_latency_clocks) == mod_13_1) {
          if (iLink < 24 && pfPartsA.size() > iLink) {
            data |= ((uint64_t)floor(pfPartsA.at(iLink).pt() / ptLSB) & hash_bitmask_16);
            data |= ((uint64_t)floor(pfPartsA.at(iLink).phi() / phiLSB) & hash_bitmask_10) << bit_shift_phi;
            data |= ((uint64_t)floor(pfPartsA.at(iLink).eta() / etaLSB) & hash_bitmask_10) << bit_shift_eta;
          }
        }
        if ((nFrameFile_ % n_latency_clocks) == mod_13_2) {
          if (iLink < 24 && pfPartsB.size() > iLink) {
            data |= ((uint64_t)floor(pfPartsB.at(iLink).pt() / ptLSB) & hash_bitmask_16);
            data |= ((uint64_t)floor(pfPartsB.at(iLink).phi() / phiLSB) & hash_bitmask_10) << bit_shift_phi;
            data |= ((uint64_t)floor((pfPartsB.at(iLink).eta() - eta_first_region_boundary) / etaLSB) & hash_bitmask_10)
                    << bit_shift_eta;
          }
        }
        // add data to output
        data_.at(iLink).push_back(data);
      }
    }
    nFrame_++;
    nFrameFile_++;
    if (nFrame_ % framesPerFile == 0)
      nFrameFile_ = 0;
  }
}

// ------------ method called once each job just before starting event loop  ------------
void L1TS2PFJetInputPatternWriter::beginJob() {}

// ------------ method called once each job just after ending the event loop  ------------
void L1TS2PFJetInputPatternWriter::endJob() {
  //frames per event
  unsigned int framesPerEv = nHeaderFrames_ + nPayloadFrames_ + nClearFrames_;

  //events per file
  unsigned int evPerFile = floor(framesPerFile / framesPerEv);

  //number of output files
  unsigned int nOutFiles = ceil((float)nEvents_ / (float)evPerFile);

  LogDebug("L1TDebug") << "Read " << nFrame_ << " frames" << std::endl;
  LogDebug("L1TDebug") << "Read " << nEvents_ << " events" << std::endl;
  LogDebug("L1TDebug") << "Writing " << nOutFiles << " files" << std::endl;
  LogDebug("L1TDebug") << "Output directory: ./" << outDir_ << "/" << std::endl;

  //files
  std::vector<std::ofstream> outFiles(nOutFiles);

  //make output files and write to them
  for (uint itFile = 0; itFile < nOutFiles; ++itFile) {
    std::stringstream outFilename;
    outFilename << outDir_ << "/" << filename_ << "_" << itFile << ".txt";
    outFiles[itFile] = std::ofstream(outFilename.str());
    LogDebug("L1TDebug") << "Writing to file: ./" << outFilename.str() << std::endl;

    outFiles[itFile] << "Board SRNTY_TEST" << std::endl;

    // quad/chan numbers
    outFiles[itFile] << " Quad/Chan :      ";
    for (unsigned i = 0; i < nQuad_; ++i) {
      for (unsigned j = 0; j < nChan_; ++j) {
        outFiles[itFile] << "  q" << setfill('0') << setw(2) << i << "c" << j << "            ";
      }
    }
    outFiles[itFile] << std::endl;

    // link numbers
    outFiles[itFile] << "      Link :     ";
    for (unsigned i = 0; i < nQuad_; ++i) {
      for (unsigned j = 0; j < nChan_; ++j) {
        outFiles[itFile] << "    " << setfill('0') << setw(2) << (i * nChan_) + j << "             ";
      }
    }

    outFiles[itFile] << std::endl;

    // then the data
    unsigned iFileFrame = 0;
    for (unsigned iFrame = itFile * framesPerFile; iFrame < (itFile * framesPerFile + framesPerFile); ++iFrame) {
      if (iFrame <= nFrame_ && iFrame < (framesPerEv * nEvents_)) {
        outFiles[itFile] << "Frame " << std::dec << std::setw(4) << std::setfill('0') << iFileFrame << " : ";
        for (unsigned iQuad = 0; iQuad < nQuad_; ++iQuad) {
          for (unsigned iChan = 0; iChan < nChan_; ++iChan) {
            unsigned iLink = (iQuad * nChan_) + iChan;
            if (iLink < data_.size() && iFrame < data_.at(iLink).size()) {
              outFiles[itFile] << std::hex << ::std::setw(1) << dataValid_.at(iFrame) << "v" << std::hex
                               << std::setw(16) << std::setfill('0') << data_.at(iLink).at(iFrame) << " ";
            } else {
              outFiles[itFile] << std::hex << ::std::setw(1) << 0 << "v" << std::hex << std::setw(16)
                               << std::setfill('0') << 0 << " ";
            }
          }
        }
      }
      outFiles[itFile] << std::endl;
      iFileFrame++;
    }
    outFiles[itFile].close();
  }
}

// ------------ method fills 'descriptions' with the allowed parameters for the module  ------------
void L1TS2PFJetInputPatternWriter::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  edm::ParameterSetDescription desc;
  desc.addUntracked<unsigned int>("nPayloadFrames", 40);
  desc.addUntracked<unsigned int>("nHeaderFrames", 1);
  desc.add<edm::InputTag>("inputCollectionTag", edm::InputTag("l1pfCandidates", "Puppi", "IN"));
  desc.addUntracked<std::string>("filename", "pattern.txt");
  desc.addUntracked<unsigned int>("nChanPerQuad", 4);
  desc.addUntracked<unsigned int>("nClearFrames", 13);
  desc.addUntracked<unsigned int>("nQuads", 18);
  descriptions.add("l1tS2PFJetInputPatternWriter", desc);
}

//define this as a plug-in
DEFINE_FWK_MODULE(L1TS2PFJetInputPatternWriter);