SmearedJetProducerT.h

Go to the documentation of this file.

#ifndef PAT_SMEAREDJETPRODUCERT_H
#define PAT_SMEAREDJETPRODUCERT_H

#include "CommonTools/Utils/interface/PtComparator.h"

#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/stream/EDProducer.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/ConsumesCollector.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/Utilities/interface/InputTag.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"

#include "DataFormats/JetReco/interface/GenJet.h"
#include "DataFormats/JetReco/interface/GenJetCollection.h"
#include "DataFormats/Math/interface/deltaR.h"

#include "JetMETCorrections/Modules/interface/JetResolution.h"

#include <TFile.h>
#include <TH1.h>
#include <TH1F.h>

#include <memory>
#include <random>

namespace pat {
    class GenJetMatcher {
        public:
            GenJetMatcher(const edm::ParameterSet& cfg, edm::ConsumesCollector&& collector):
                m_genJetsToken(collector.consumes<reco::GenJetCollection>(cfg.getParameter<edm::InputTag>("genJets"))),
                m_dR_max(cfg.getParameter<double>("dRMax")),
                m_dPt_max_factor(cfg.getParameter<double>("dPtMaxFactor")) {
                // Empty
            }

            static void fillDescriptions(edm::ParameterSetDescription& desc) {
                desc.add<edm::InputTag>("genJets");
                desc.add<double>("dRMax");
                desc.add<double>("dPtMaxFactor");
            }

            void getTokens(const edm::Event& event) {
               event.getByToken(m_genJetsToken, m_genJets);
            }

            template<class T>
            const reco::GenJet* match(const T& jet, double resolution) {
                const reco::GenJetCollection& genJets = *m_genJets;

                // Try to find a gen jet matching
                // dR < m_dR_max
                // dPt < m_dPt_max_factor * resolution

                double min_dR = std::numeric_limits<double>::infinity();
                const reco::GenJet* matched_genJet = nullptr;

                for (const auto& genJet: genJets) {
                    double dR = deltaR(genJet, jet);

                    if (dR > min_dR)
                        continue;

                    if (dR < m_dR_max) {
                        double dPt = std::abs(genJet.pt() - jet.pt());
                        if (dPt > m_dPt_max_factor * resolution)
                            continue;

                        min_dR = dR;
                        matched_genJet = &genJet;
                    }
                }

                return matched_genJet;
            }

        private:
            edm::EDGetTokenT<reco::GenJetCollection> m_genJetsToken;
            edm::Handle<reco::GenJetCollection> m_genJets;

            double m_dR_max;
            double m_dPt_max_factor;
    };
};

template <typename T>
class SmearedJetProducerT : public edm::stream::EDProducer<> {

    using JetCollection = std::vector<T>;

    public:
        explicit SmearedJetProducerT(const edm::ParameterSet& cfg):
            m_enabled(cfg.getParameter<bool>("enabled")),
            m_useDeterministicSeed(cfg.getParameter<bool>("useDeterministicSeed")),
            m_debug(cfg.getUntrackedParameter<bool>("debug", false)) {

            m_jets_token = consumes<JetCollection>(cfg.getParameter<edm::InputTag>("src"));

            if (m_enabled) {
                m_rho_token = consumes<double>(cfg.getParameter<edm::InputTag>("rho"));

                m_use_txt_files = cfg.exists("resolutionFile") && cfg.exists("scaleFactorFile");

                if (m_use_txt_files) {
                    std::string resolutionFile = cfg.getParameter<edm::FileInPath>("resolutionFile").fullPath();
                    std::string scaleFactorFile = cfg.getParameter<edm::FileInPath>("scaleFactorFile").fullPath();

                    m_resolution_from_file.reset(new JME::JetResolution(resolutionFile));
                    m_scale_factor_from_file.reset(new JME::JetResolutionScaleFactor(scaleFactorFile));
                } else {
                    m_jets_algo = cfg.getParameter<std::string>("algo");
                    m_jets_algo_pt = cfg.getParameter<std::string>("algopt");
                }

                std::uint32_t seed = cfg.getParameter<std::uint32_t>("seed");
                m_random_generator = std::mt19937(seed);

                bool skipGenMatching = cfg.getParameter<bool>("skipGenMatching");
                if (! skipGenMatching)
                    m_genJetMatcher = std::make_shared<pat::GenJetMatcher>(cfg, consumesCollector());

                std::int32_t variation = cfg.getParameter<std::int32_t>("variation");
                if (variation == 0)
                    m_systematic_variation = Variation::NOMINAL;
                else if (variation == 1)
                    m_systematic_variation = Variation::UP;
                else if (variation == -1)
                    m_systematic_variation = Variation::DOWN;
                else
                    throw edm::Exception(edm::errors::ConfigFileReadError, "Invalid value for 'variation' parameter. Only -1, 0 or 1 are supported.");
            }

            produces<JetCollection>();
        }

        static void fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
            edm::ParameterSetDescription desc;

            desc.add<edm::InputTag>("src");
            desc.add<bool>("enabled");
            desc.add<edm::InputTag>("rho");
            desc.add<std::int32_t>("variation", 0);
            desc.add<std::uint32_t>("seed", 37428479);
            desc.add<bool>("skipGenMatching", false);
            desc.add<bool>("useDeterministicSeed", true);
            desc.addUntracked<bool>("debug", false);

            auto source =
          (edm::ParameterDescription<std::string>("algo", true) and edm::ParameterDescription<std::string>("algopt", true)) xor
          (edm::ParameterDescription<edm::FileInPath>("resolutionFile", true) and edm::ParameterDescription<edm::FileInPath>("scaleFactorFile", true));
            desc.addNode(source);

            pat::GenJetMatcher::fillDescriptions(desc);

            descriptions.addDefault(desc);
        }

        virtual void produce(edm::Event& event, const edm::EventSetup& setup) override {

            edm::Handle<JetCollection> jets_collection;
            event.getByToken(m_jets_token, jets_collection);

            // Disable the module when running on real data
            if (m_enabled && event.isRealData()) {
                m_enabled = false;
                m_genJetMatcher.reset();
            }

            edm::Handle<double> rho;
            if (m_enabled)
                event.getByToken(m_rho_token, rho);

            JME::JetResolution resolution;
            JME::JetResolutionScaleFactor resolution_sf;

            const JetCollection& jets = *jets_collection;

            if (m_enabled) {
                if (m_use_txt_files) {
                    resolution = *m_resolution_from_file;
                    resolution_sf = *m_scale_factor_from_file;
                } else {
                    resolution = JME::JetResolution::get(setup, m_jets_algo_pt);
                    resolution_sf = JME::JetResolutionScaleFactor::get(setup, m_jets_algo);
                }

                if(m_useDeterministicSeed) {
                    unsigned int runNum_uint = static_cast <unsigned int> (event.id().run());
                    unsigned int lumiNum_uint = static_cast <unsigned int> (event.id().luminosityBlock());
                    unsigned int evNum_uint = static_cast <unsigned int> (event.id().event());
                    unsigned int jet0eta = uint32_t(jets.empty() ? 0 : jets[0].eta()/0.01);
                    std::uint32_t seed = jet0eta + (lumiNum_uint<<10) + (runNum_uint<<20) + evNum_uint;
                    m_random_generator.seed(seed);
                }
            }

            if (m_genJetMatcher)
                m_genJetMatcher->getTokens(event);

            std::unique_ptr<JetCollection> smearedJets(new JetCollection());

            for (const auto& jet: jets) {

                if ((! m_enabled) || (jet.pt() == 0)) {
                    // Module disabled or invalid p4. Simply copy the input jet.
                    smearedJets->push_back(jet);

                    continue;
                }

                double jet_resolution = resolution.getResolution({{JME::Binning::JetPt, jet.pt()}, {JME::Binning::JetEta, jet.eta()}, {JME::Binning::Rho, *rho}});
                double jer_sf = resolution_sf.getScaleFactor({{JME::Binning::JetEta, jet.eta()}}, m_systematic_variation);

                if (m_debug) {
                    std::cout << "jet:  pt: " << jet.pt() << "  eta: " << jet.eta() << "  phi: " << jet.phi() << "  e: " << jet.energy() << std::endl;
                    std::cout << "resolution: " << jet_resolution << std::endl;
                    std::cout << "resolution scale factor: " << jer_sf << std::endl;
                }

                const reco::GenJet* genJet = nullptr;
                if (m_genJetMatcher)
                    genJet = m_genJetMatcher->match(jet, jet.pt() * jet_resolution);

                double smearFactor = 1.;

                if (genJet) {
                    /*
                     * Case 1: we have a "good" gen jet matched to the reco jet
                     */

                    if (m_debug) {
                        std::cout << "gen jet:  pt: " << genJet->pt() << "  eta: " << genJet->eta() << "  phi: " << genJet->phi() << "  e: " << genJet->energy() << std::endl;
                    }

                    double dPt = jet.pt() - genJet->pt();
                    smearFactor = 1 + (jer_sf - 1.) * dPt / jet.pt();

                } else if (jer_sf > 1) {
                    /*
                     * Case 2: we don't have a gen jet. Smear jet pt using a random gaussian variation
                     */

                    double sigma = jet_resolution * std::sqrt(jer_sf * jer_sf - 1);
                    if (m_debug) {
                        std::cout << "gaussian width: " << sigma << std::endl;
                    }

                    std::normal_distribution<> d(0, sigma);
                    smearFactor = 1. + d(m_random_generator);
                } else if (m_debug) {
                    std::cout << "Impossible to smear this jet" << std::endl;
                }

                if (jet.energy() * smearFactor < MIN_JET_ENERGY) {
                    // Negative or too small smearFactor. We would change direction of the jet
                    // and this is not what we want.
                    // Recompute the smearing factor in order to have jet.energy() == MIN_JET_ENERGY
                    double newSmearFactor = MIN_JET_ENERGY / jet.energy();
                    if (m_debug) {
                        std::cout << "The smearing factor (" << smearFactor << ") is either negative or too small. Fixing it to " << newSmearFactor << " to avoid change of direction." << std::endl;
                    }
                    smearFactor = newSmearFactor;
                }

                T smearedJet = jet;
                smearedJet.scaleEnergy(smearFactor);

                if (m_debug) {
                    std::cout << "smeared jet (" << smearFactor << "):  pt: " << smearedJet.pt() << "  eta: " << smearedJet.eta() << "  phi: " << smearedJet.phi() << "  e: " << smearedJet.energy() << std::endl;
                }

                smearedJets->push_back(smearedJet);
            }

            // Sort jets by pt
            std::sort(smearedJets->begin(), smearedJets->end(), jetPtComparator);

            event.put(std::move(smearedJets));
        }

    private:
        static constexpr const double MIN_JET_ENERGY = 1e-2;

        edm::EDGetTokenT<JetCollection> m_jets_token;
        edm::EDGetTokenT<double> m_rho_token;
        bool m_enabled;
        std::string m_jets_algo_pt;
        std::string m_jets_algo;
        Variation m_systematic_variation;
        bool m_useDeterministicSeed;
        bool m_debug;
        std::shared_ptr<pat::GenJetMatcher> m_genJetMatcher;

        bool m_use_txt_files;
        std::unique_ptr<JME::JetResolution> m_resolution_from_file;
        std::unique_ptr<JME::JetResolutionScaleFactor> m_scale_factor_from_file;

        std::mt19937 m_random_generator;

        GreaterByPt<T> jetPtComparator;
};
#endif