L1UpgradeTfMuonTreeProducer.cc

Go to the documentation of this file.

// -*- C++ -*-
//
// Package:    L1Trigger/L1Ntuples
// Class:      L1UpgradeTfMuonTreeProducer
//
//
// Original Author:
//         Created:
// $Id: L1UpgradeTfMuonTreeProducer.cc,v 1.8 2012/08/29 12:44:03 jbrooke Exp $
//
//

// system include files
#include <memory>

// framework
#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/MessageLogger/interface/MessageLogger.h"

// data formats
#include "DataFormats/FEDRawData/interface/FEDHeader.h"
#include "DataFormats/L1TMuon/interface/RegionalMuonCand.h"

// Needed to get BMTF firmware version
#include "DataFormats/FEDRawData/interface/FEDRawDataCollection.h"
#include "EventFilter/L1TRawToDigi/interface/AMC13Spec.h"
#include "EventFilter/L1TRawToDigi/interface/Block.h"

// ROOT output stuff
#include "FWCore/ServiceRegistry/interface/Service.h"
#include "CommonTools/UtilAlgos/interface/TFileService.h"
#include "TTree.h"

#include "L1Trigger/L1TNtuples/interface/L1AnalysisL1UpgradeTfMuon.h"
#include "L1Trigger/L1TNtuples/interface/L1AnalysisBMTFInputs.h"

//
// class declaration
//

class L1UpgradeTfMuonTreeProducer : public edm::one::EDAnalyzer<edm::one::SharedResources> {
public:
  explicit L1UpgradeTfMuonTreeProducer(const edm::ParameterSet&);
  ~L1UpgradeTfMuonTreeProducer() override = default;

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

public:
  L1Analysis::L1AnalysisL1UpgradeTfMuon l1UpgradeKBmtf;
  L1Analysis::L1AnalysisL1UpgradeTfMuon l1UpgradeBmtf;
  L1Analysis::L1AnalysisL1UpgradeTfMuon l1UpgradeOmtf;
  L1Analysis::L1AnalysisL1UpgradeTfMuon l1UpgradeEmtf;
  L1Analysis::L1AnalysisBMTFInputs l1UpgradeBmtfInputs;
  L1Analysis::L1AnalysisL1UpgradeTfMuonDataFormat* l1UpgradeBmtfData;
  L1Analysis::L1AnalysisL1UpgradeTfMuonDataFormat* l1UpgradeKBmtfData;
  L1Analysis::L1AnalysisL1UpgradeTfMuonDataFormat* l1UpgradeOmtfData;
  L1Analysis::L1AnalysisL1UpgradeTfMuonDataFormat* l1UpgradeEmtfData;
  L1Analysis::L1AnalysisBMTFInputsDataFormat* l1UpgradeBmtfInputsData;

private:
  unsigned maxL1UpgradeTfMuon_;
  bool isEMU_;

  // output file
  edm::Service<TFileService> fs_;

  // tree
  TTree* tree_;

  // EDM input tags
  const edm::EDGetTokenT<FEDRawDataCollection> fedToken_;
  const edm::EDGetTokenT<l1t::RegionalMuonCandBxCollection> bmtfMuonToken_;
  const edm::EDGetTokenT<l1t::RegionalMuonCandBxCollection> bmtf2MuonToken_;
  const edm::EDGetTokenT<l1t::RegionalMuonCandBxCollection> omtfMuonToken_;
  const edm::EDGetTokenT<l1t::RegionalMuonCandBxCollection> emtfMuonToken_;

  const edm::EDGetTokenT<L1MuDTChambPhContainer> bmtfPhInputToken_;
  const edm::EDGetTokenT<L1MuDTChambThContainer> bmtfThInputToken_;

  // EDM handles
  edm::Handle<FEDRawDataCollection> feds_;

  unsigned getAlgoFwVersion();
};

L1UpgradeTfMuonTreeProducer::L1UpgradeTfMuonTreeProducer(const edm::ParameterSet& iConfig)
    : fedToken_(consumes<FEDRawDataCollection>(iConfig.getParameter<edm::InputTag>("feds"))),
      bmtfMuonToken_(
          consumes<l1t::RegionalMuonCandBxCollection>(iConfig.getUntrackedParameter<edm::InputTag>("bmtfMuonToken"))),
      bmtf2MuonToken_(
          consumes<l1t::RegionalMuonCandBxCollection>(iConfig.getUntrackedParameter<edm::InputTag>("bmtf2MuonToken"))),
      omtfMuonToken_(
          consumes<l1t::RegionalMuonCandBxCollection>(iConfig.getUntrackedParameter<edm::InputTag>("omtfMuonToken"))),
      emtfMuonToken_(
          consumes<l1t::RegionalMuonCandBxCollection>(iConfig.getUntrackedParameter<edm::InputTag>("emtfMuonToken"))),
      bmtfPhInputToken_(
          consumes<L1MuDTChambPhContainer>(iConfig.getUntrackedParameter<edm::InputTag>("bmtfInputPhMuonToken"))),
      bmtfThInputToken_(
          consumes<L1MuDTChambThContainer>(iConfig.getUntrackedParameter<edm::InputTag>("bmtfInputThMuonToken"))) {
  isEMU_ = iConfig.getParameter<bool>("isEMU");
  maxL1UpgradeTfMuon_ = iConfig.getParameter<unsigned int>("maxL1UpgradeTfMuon");

  l1UpgradeBmtfData = l1UpgradeBmtf.getData();
  l1UpgradeKBmtfData = l1UpgradeKBmtf.getData();
  l1UpgradeOmtfData = l1UpgradeOmtf.getData();
  l1UpgradeEmtfData = l1UpgradeEmtf.getData();
  l1UpgradeBmtfInputsData = l1UpgradeBmtfInputs.getData();

  usesResource(TFileService::kSharedResource);

  // set up output
  tree_ = fs_->make<TTree>("L1UpgradeTfMuonTree", "L1UpgradeTfMuonTree");
  tree_->Branch("L1UpgradeBmtfMuon", "L1Analysis::L1AnalysisL1UpgradeTfMuonDataFormat", &l1UpgradeBmtfData, 32000, 3);
  tree_->Branch("L1UpgradeKBmtfMuon", "L1Analysis::L1AnalysisL1UpgradeTfMuonDataFormat", &l1UpgradeKBmtfData, 32000, 3);
  tree_->Branch("L1UpgradeOmtfMuon", "L1Analysis::L1AnalysisL1UpgradeTfMuonDataFormat", &l1UpgradeOmtfData, 32000, 3);
  tree_->Branch("L1UpgradeEmtfMuon", "L1Analysis::L1AnalysisL1UpgradeTfMuonDataFormat", &l1UpgradeEmtfData, 32000, 3);

  tree_->Branch(
      "L1UpgradeBmtfInputs", "L1Analysis::L1AnalysisBMTFInputsDataFormat", &l1UpgradeBmtfInputsData, 32000, 3);
}

//
// member functions
//

// ------------ method called to for each event  ------------
void L1UpgradeTfMuonTreeProducer::analyze(const edm::Event& iEvent, const edm::EventSetup& iSetup) {
  edm::EDGetTokenT<l1t::RegionalMuonCandBxCollection> legacybmtfMuonToken;
  edm::EDGetTokenT<l1t::RegionalMuonCandBxCollection> kbmtfMuonToken;
  if (isEMU_) {
    legacybmtfMuonToken = bmtfMuonToken_;
    kbmtfMuonToken = bmtf2MuonToken_;
  } else {
    iEvent.getByToken(fedToken_, feds_);
    // Get fw version
    unsigned algoFwVersion{getAlgoFwVersion()};
    if (algoFwVersion < 2499805536) {  //95000160(hex)
      // Legacy was triggering (and therefore in the main collection)
      legacybmtfMuonToken = bmtfMuonToken_;
      kbmtfMuonToken = bmtf2MuonToken_;
    } else {
      // kBMTF was triggering
      legacybmtfMuonToken = bmtf2MuonToken_;
      kbmtfMuonToken = bmtfMuonToken_;
    }
  }

  l1UpgradeBmtf.Reset();
  l1UpgradeKBmtf.Reset();
  l1UpgradeKBmtf.SetRun3Muons();
  l1UpgradeOmtf.Reset();
  l1UpgradeEmtf.Reset();
  l1UpgradeEmtf.SetRun3Muons();
  l1UpgradeBmtfInputs.Reset();

  edm::Handle<l1t::RegionalMuonCandBxCollection> bmtfMuon;
  edm::Handle<l1t::RegionalMuonCandBxCollection> kbmtfMuon;
  edm::Handle<l1t::RegionalMuonCandBxCollection> omtfMuon;
  edm::Handle<l1t::RegionalMuonCandBxCollection> emtfMuon;
  edm::Handle<L1MuDTChambPhContainer> bmtfPhInputs;
  edm::Handle<L1MuDTChambThContainer> bmtfThInputs;

  iEvent.getByToken(legacybmtfMuonToken, bmtfMuon);
  iEvent.getByToken(kbmtfMuonToken, kbmtfMuon);
  iEvent.getByToken(omtfMuonToken_, omtfMuon);
  iEvent.getByToken(emtfMuonToken_, emtfMuon);
  iEvent.getByToken(bmtfPhInputToken_, bmtfPhInputs);
  iEvent.getByToken(bmtfThInputToken_, bmtfThInputs);

  if (bmtfMuon.isValid()) {
    l1UpgradeBmtf.SetTfMuon(*bmtfMuon, maxL1UpgradeTfMuon_);
  } else {
    edm::LogWarning("MissingProduct") << "L1Upgrade BMTF muons not found. Branch will not be filled" << std::endl;
  }

  if (kbmtfMuon.isValid()) {
    l1UpgradeKBmtf.SetTfMuon(*kbmtfMuon, maxL1UpgradeTfMuon_);
  } else {
    edm::LogWarning("MissingProduct") << "L1Upgrade kBMTF muons not found. Branch will not be filled" << std::endl;
  }

  if (omtfMuon.isValid()) {
    l1UpgradeOmtf.SetTfMuon(*omtfMuon, maxL1UpgradeTfMuon_);
  } else {
    edm::LogWarning("MissingProduct") << "L1Upgrade OMTF muons not found. Branch will not be filled" << std::endl;
  }

  if (emtfMuon.isValid()) {
    l1UpgradeEmtf.SetTfMuon(*emtfMuon, maxL1UpgradeTfMuon_);
  } else {
    edm::LogWarning("MissingProduct") << "L1Upgrade EMTF muons not found. Branch will not be filled" << std::endl;
  }

  int max_inputs = maxL1UpgradeTfMuon_ * 4;

  if (!bmtfPhInputs.isValid()) {
    edm::LogWarning("MissingProduct") << "L1Upgrade BMTF Ph Inputs not found. Branch will not be filled" << std::endl;
  } else
    l1UpgradeBmtfInputs.SetBMPH(bmtfPhInputs, max_inputs);

  if (!bmtfThInputs.isValid()) {
    edm::LogWarning("MissingProduct") << "L1Upgrade BMTF Th Inputs not found. Branch will not be filled" << std::endl;
  } else
    l1UpgradeBmtfInputs.SetBMTH(bmtfThInputs, max_inputs);

  tree_->Fill();
}

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

// ------------ method called once each job just after ending the event loop  ------------
void L1UpgradeTfMuonTreeProducer::endJob() {}

unsigned L1UpgradeTfMuonTreeProducer::getAlgoFwVersion() {
  int nonEmptyFed = 0;
  if (feds_->FEDData(1376).size() > 0)
    nonEmptyFed = 1376;
  else if (feds_->FEDData(1377).size() > 0)
    nonEmptyFed = 1377;
  else {
    edm::LogError("L1UpgradeTfMuonTreeProducer")
        << "Both BMTF feds (1376, 1377) seem empty, will lead to unexpected results in tree from data.";
    return 0;
  }

  const FEDRawData& l1tRcd = feds_->FEDData(nonEmptyFed);
  edm::LogInfo("L1UpgradeTfMuonTreeProducer") << "L1T Rcd taken from the FEDData.";
  edm::LogInfo("L1UpgradeTfMuonTreeProducer") << "l1tRcd.size=" << l1tRcd.size() << "   for fed:" << nonEmptyFed;

  const unsigned char* data = l1tRcd.data();
  FEDHeader header(data);

  amc13::Packet packet;
  if (!packet.parse((const uint64_t*)data,
                    (const uint64_t*)(data + 8),
                    (l1tRcd.size()) / 8,
                    header.lvl1ID(),
                    header.bxID(),
                    false,
                    false)) {
    edm::LogError("L1UpgradeTfMuonTreeProducer") << "Could not extract AMC13 Packet.";
    return 0;
  }

  if (!packet.payload().empty()) {
    auto payload64 = (packet.payload().at(0)).data();
    const uint32_t* start = (const uint32_t*)payload64.get();
    const uint32_t* end = start + (packet.payload().at(0).size() * 2);

    l1t::MP7Payload payload(start, end, false);
    return payload.getAlgorithmFWVersion();

  } else {
    edm::LogError("L1UpgradeTfMuonTreeProducer") << "AMC13 payload is empty, cannot extract AMC13 Packet.";
    return 0;
  }
}

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