CMS 3D CMS Logo

List of all members | Public Member Functions | Private Member Functions | Private Attributes
JetEnergyShift Class Reference

Plugin to shift the jet energy scale and recalculate the MET accordingly. More...

Inheritance diagram for JetEnergyShift:
edm::global::EDProducer<> edm::global::EDProducerBase edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

Public Member Functions

 JetEnergyShift (const edm::ParameterSet &)
 default constructor More...
 
- Public Member Functions inherited from edm::global::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
 
EDProduceroperator= (const EDProducer &)=delete
 
bool wantsGlobalLuminosityBlocks () const final
 
bool wantsGlobalRuns () const final
 
bool wantsInputProcessBlocks () const final
 
bool wantsProcessBlocks () const final
 
bool wantsStreamLuminosityBlocks () const final
 
bool wantsStreamRuns () const final
 
- Public Member Functions inherited from edm::global::EDProducerBase
 EDProducerBase ()
 
ModuleDescription const & moduleDescription () const
 
 ~EDProducerBase () override
 
- Public Member Functions inherited from edm::ProducerBase
void callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)
 
std::vector< edm::ProductResolverIndex > const & indiciesForPutProducts (BranchType iBranchType) const
 
 ProducerBase ()
 
std::vector< edm::ProductResolverIndex > const & putTokenIndexToProductResolverIndex () const
 
std::vector< bool > const & recordProvenanceList () const
 
void registerProducts (ProducerBase *, ProductRegistry *, ModuleDescription const &)
 
std::function< void(BranchDescription const &)> registrationCallback () const
 used by the fwk to register list of products More...
 
void resolvePutIndicies (BranchType iBranchType, ModuleToResolverIndicies const &iIndicies, std::string const &moduleLabel)
 
TypeLabelList const & typeLabelList () const
 used by the fwk to register the list of products of this module More...
 
 ~ProducerBase () noexcept(false) override
 
- Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfoconsumesInfo () const
 
void convertCurrentProcessAlias (std::string const &processName)
 Convert "@currentProcess" in InputTag process names to the actual current process name. More...
 
 EDConsumerBase ()
 
 EDConsumerBase (EDConsumerBase const &)=delete
 
 EDConsumerBase (EDConsumerBase &&)=default
 
ESResolverIndex const * esGetTokenIndices (edm::Transition iTrans) const
 
std::vector< ESResolverIndex > const & esGetTokenIndicesVector (edm::Transition iTrans) const
 
std::vector< ESRecordIndex > const & esGetTokenRecordIndicesVector (edm::Transition iTrans) const
 
ProductResolverIndexAndSkipBit indexFrom (EDGetToken, BranchType, TypeID const &) const
 
void itemsMayGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
 
void itemsToGet (BranchType, std::vector< ProductResolverIndexAndSkipBit > &) const
 
std::vector< ProductResolverIndexAndSkipBit > const & itemsToGetFrom (BranchType iType) const
 
void labelsForToken (EDGetToken iToken, Labels &oLabels) const
 
void modulesWhoseProductsAreConsumed (std::array< std::vector< ModuleDescription const *> *, NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, ProductRegistry const &preg, std::map< std::string, ModuleDescription const *> const &labelsToDesc, std::string const &processName) const
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
void selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)
 
ProductResolverIndexAndSkipBit uncheckedIndexFrom (EDGetToken) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
void updateLookup (eventsetup::ESRecordsToProductResolverIndices const &)
 
virtual ~EDConsumerBase () noexcept(false)
 

Private Member Functions

void produce (edm::StreamID, edm::Event &, const edm::EventSetup &) const override
 rescale jet energy and recalculated MET More...
 

Private Attributes

edm::EDGetTokenT< std::vector< pat::Jet > > inputJetsToken_
 jet input collection More...
 
edm::EDGetTokenT< std::vector< pat::MET > > inputMETsToken_
 met input collection More...
 
double jetEMLimitForMET_
 limit on the emf of the jet for Type1 MET corrections More...
 
double jetPTThresholdForMET_
 threshold on (raw!) jet pt for Type1 MET corrections More...
 
std::string outputJets_
 jet output collection More...
 
std::string outputMETs_
 MET output collection. More...
 
double scaleFactor_
 scale factor for the rescaling More...
 

Additional Inherited Members

- Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase ModuleType
 
- Public Types inherited from edm::ProducerBase
template<typename T >
using BranchAliasSetterT = ProductRegistryHelper::BranchAliasSetterT< T >
 
using ModuleToResolverIndicies = std::unordered_multimap< std::string, std::tuple< edm::TypeID const *, const char *, edm::ProductResolverIndex > >
 
typedef ProductRegistryHelper::TypeLabelList TypeLabelList
 
- Public Types inherited from edm::EDConsumerBase
typedef ProductLabels Labels
 
- Static Public Member Functions inherited from edm::global::EDProducerBase
static const std::string & baseType ()
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &descriptions)
 
- Protected Member Functions inherited from edm::ProducerBase
template<Transition Tr = Transition::Event>
auto produces (std::string instanceName) noexcept
 declare what type of product will make and with which optional label More...
 
template<Transition B>
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
template<BranchType B>
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
BranchAliasSetter produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<class ProductType >
BranchAliasSetterT< ProductType > produces ()
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces ()
 
template<class ProductType >
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces ()
 
template<Transition Tr = Transition::Event>
auto produces () noexcept
 
ProducesCollector producesCollector ()
 
- Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< Bconsumes (edm::InputTag tag) noexcept
 
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken consumes (TypeToGet const &id, edm::InputTag const &tag)
 
ConsumesCollector consumesCollector ()
 Use a ConsumesCollector to gather consumes information from helper functions. More...
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes ()
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes (ESInputTag const &tag)
 
template<Transition Tr = Transition::Event>
constexpr auto esConsumes ()
 
template<Transition Tr = Transition::Event>
auto esConsumes (ESInputTag tag)
 
template<Transition Tr = Transition::Event>
ESGetTokenGeneric esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
 Used with EventSetupRecord::doGet. More...
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
void resetItemsToGetFrom (BranchType iType)
 

Detailed Description

Plugin to shift the jet energy scale and recalculate the MET accordingly.

Plugin to shift the jet energy scale and recalculate the MET accordingly. The module mimics the assumption that the jet energy scale (JES) has been estimated wrong by a factor of scaleFactor, corresponding to a L2L3 corrected jet. The p4 of the patJet is beeing rescaled. All other patJet properties stay the same. The MET is recalculated taking the shifted JES into account for the Type1 MET correction. For the patMET the rescaled sumET and the p4 are stored. The different correction levels are lost for the new collection. The module has the following parameters:

inputJets : input collection for MET (expecting patMET). inputMETs : input collection for jets (expecting patJets). scaleFactor : scale factor to which to shift the JES. jetPTThresholdForMET : pt threshold for (uncorrected!) jets considered for Type1 MET corrections. jetEMLimitForMET : limit in em fraction for Type1 MET correction.

For expected parameters for jetPTThresholdForMET and jetEMLimitForMET have a look at: JetMETCorrections/Type1MET/python/MetType1Corrections_cff.py. Two output collections are written to file with instance label corresponding to the input label of the jet and met input collections.

Definition at line 34 of file JetEnergyShift.cc.

Constructor & Destructor Documentation

◆ JetEnergyShift()

JetEnergyShift::JetEnergyShift ( const edm::ParameterSet cfg)
explicit

default constructor

Definition at line 60 of file JetEnergyShift.cc.

References looper::cfg, label, outputJets_, and outputMETs_.

61  : inputJetsToken_(consumes<std::vector<pat::Jet>>(cfg.getParameter<edm::InputTag>("inputJets"))),
62  inputMETsToken_(consumes<std::vector<pat::MET>>(cfg.getParameter<edm::InputTag>("inputMETs"))),
63  scaleFactor_(cfg.getParameter<double>("scaleFactor")),
64  jetPTThresholdForMET_(cfg.getParameter<double>("jetPTThresholdForMET")),
65  jetEMLimitForMET_(cfg.getParameter<double>("jetEMLimitForMET")) {
66  // use label of input to create label for output
67  outputJets_ = cfg.getParameter<edm::InputTag>("inputJets").label();
68  outputMETs_ = cfg.getParameter<edm::InputTag>("inputMETs").label();
69  // register products
70  produces<std::vector<pat::Jet>>(outputJets_);
71  produces<std::vector<pat::MET>>(outputMETs_);
72 }
double jetEMLimitForMET_
limit on the emf of the jet for Type1 MET corrections
std::string outputJets_
jet output collection
EDGetTokenT< ProductType > consumes(edm::InputTag const &tag)
char const * label
edm::EDGetTokenT< std::vector< pat::MET > > inputMETsToken_
met input collection
double scaleFactor_
scale factor for the rescaling
double jetPTThresholdForMET_
threshold on (raw!) jet pt for Type1 MET corrections
edm::EDGetTokenT< std::vector< pat::Jet > > inputJetsToken_
jet input collection
std::string outputMETs_
MET output collection.

Member Function Documentation

◆ produce()

void JetEnergyShift::produce ( edm::StreamID  ,
edm::Event event,
const edm::EventSetup setup 
) const
overrideprivatevirtual

rescale jet energy and recalculated MET

Implements edm::global::EDProducerBase.

Definition at line 74 of file JetEnergyShift.cc.

References reco::LeafCandidate::et(), inputJetsToken_, inputMETsToken_, metsig::jet, jetEMLimitForMET_, jetPTThresholdForMET_, PDWG_EXODelayedJetMET_cff::jets, BTaggingMonitor_cfi::met, singleTopDQM_cfi::mets, eostools::move(), outputJets_, outputMETs_, reco::LeafCandidate::px(), reco::LeafCandidate::py(), pat::Jet::scaleEnergy(), scaleFactor_, and mathSSE::sqrt().

74  {
76  event.getByToken(inputJetsToken_, jets);
77 
79  event.getByToken(inputMETsToken_, mets);
80 
81  auto pJets = std::make_unique<std::vector<pat::Jet>>();
82  auto pMETs = std::make_unique<std::vector<pat::MET>>();
83 
84  double dPx = 0.;
85  double dPy = 0.;
86  double dSumEt = 0.;
87 
88  for (std::vector<pat::Jet>::const_iterator jet = jets->begin(); jet != jets->end(); ++jet) {
89  pat::Jet scaledJet = *jet;
90  scaledJet.scaleEnergy(scaleFactor_);
91  pJets->push_back(scaledJet);
92  // consider jet scale shift only if the raw jet pt and emf
93  // is above the thresholds given in the module definition
94  if (jet->correctedJet("raw").pt() > jetPTThresholdForMET_ && jet->emEnergyFraction() < jetEMLimitForMET_) {
95  dPx += scaledJet.px() - jet->px();
96  dPy += scaledJet.py() - jet->py();
97  dSumEt += scaledJet.et() - jet->et();
98  }
99  }
100 
101  // scale MET accordingly
102  pat::MET met = *(mets->begin());
103  double scaledMETPx = met.px() - dPx;
104  double scaledMETPy = met.py() - dPy;
105  pat::MET scaledMET(
106  reco::MET(met.sumEt() + dSumEt,
108  scaledMETPx, scaledMETPy, 0, sqrt(scaledMETPx * scaledMETPx + scaledMETPy * scaledMETPy)),
109  reco::MET::Point(0, 0, 0)));
110  pMETs->push_back(scaledMET);
111  event.put(std::move(pJets), outputJets_);
112  event.put(std::move(pMETs), outputMETs_);
113 }
Analysis-level MET class.
Definition: MET.h:40
void scaleEnergy(double fScale) override
Scale energy and correspondingly adjust raw jec factors.
Definition: Jet.h:177
double jetEMLimitForMET_
limit on the emf of the jet for Type1 MET corrections
std::string outputJets_
jet output collection
double px() const final
x coordinate of momentum vector
Definition: MET.h:41
T sqrt(T t)
Definition: SSEVec.h:19
double py() const final
y coordinate of momentum vector
edm::EDGetTokenT< std::vector< pat::MET > > inputMETsToken_
met input collection
Analysis-level calorimeter jet class.
Definition: Jet.h:77
double et() const final
transverse energy
double scaleFactor_
scale factor for the rescaling
double jetPTThresholdForMET_
threshold on (raw!) jet pt for Type1 MET corrections
edm::EDGetTokenT< std::vector< pat::Jet > > inputJetsToken_
jet input collection
std::string outputMETs_
MET output collection.
math::XYZTLorentzVector LorentzVector
Lorentz vector.
Definition: LeafCandidate.h:23
def move(src, dest)
Definition: eostools.py:511
math::XYZPoint Point
point in the space
Definition: LeafCandidate.h:27

Member Data Documentation

◆ inputJetsToken_

edm::EDGetTokenT<std::vector<pat::Jet> > JetEnergyShift::inputJetsToken_
private

jet input collection

Definition at line 45 of file JetEnergyShift.cc.

Referenced by produce().

◆ inputMETsToken_

edm::EDGetTokenT<std::vector<pat::MET> > JetEnergyShift::inputMETsToken_
private

met input collection

Definition at line 47 of file JetEnergyShift.cc.

Referenced by produce().

◆ jetEMLimitForMET_

double JetEnergyShift::jetEMLimitForMET_
private

limit on the emf of the jet for Type1 MET corrections

Definition at line 57 of file JetEnergyShift.cc.

Referenced by produce().

◆ jetPTThresholdForMET_

double JetEnergyShift::jetPTThresholdForMET_
private

threshold on (raw!) jet pt for Type1 MET corrections

Definition at line 55 of file JetEnergyShift.cc.

Referenced by produce().

◆ outputJets_

std::string JetEnergyShift::outputJets_
private

jet output collection

Definition at line 49 of file JetEnergyShift.cc.

Referenced by JetEnergyShift(), and produce().

◆ outputMETs_

std::string JetEnergyShift::outputMETs_
private

MET output collection.

Definition at line 51 of file JetEnergyShift.cc.

Referenced by JetEnergyShift(), and produce().

◆ scaleFactor_

double JetEnergyShift::scaleFactor_
private

scale factor for the rescaling

Definition at line 53 of file JetEnergyShift.cc.

Referenced by produce().