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::EDProducer edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

Public Member Functions

 JetEnergyShift (const edm::ParameterSet &)
 default constructor More...
 
 ~JetEnergyShift () override
 default destructor More...
 
- Public Member Functions inherited from edm::EDProducer
 EDProducer ()
 
SerialTaskQueueglobalLuminosityBlocksQueue ()
 
SerialTaskQueueglobalRunsQueue ()
 
ModuleDescription const & moduleDescription () const
 
 ~EDProducer () 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 &&)=default
 
 EDConsumerBase (EDConsumerBase const &)=delete
 
ESProxyIndex const * esGetTokenIndices (edm::Transition iTrans) const
 
std::vector< ESProxyIndex > 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
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
EDConsumerBase const & operator= (EDConsumerBase const &)=delete
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, 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::ESRecordsToProxyIndices const &)
 
virtual ~EDConsumerBase () noexcept(false)
 

Private Member Functions

void produce (edm::Event &, const edm::EventSetup &) 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::EDProducer
typedef EDProducer ModuleType
 
- Public Types inherited from edm::ProducerBase
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::EDProducer
static const std::string & baseType ()
 
static void fillDescriptions (ConfigurationDescriptions &descriptions)
 
static void prevalidate (ConfigurationDescriptions &descriptions)
 
static bool wantsGlobalLuminosityBlocks ()
 
static bool wantsGlobalRuns ()
 
static bool wantsInputProcessBlocks ()
 
static bool wantsProcessBlocks ()
 
static bool wantsStreamLuminosityBlocks ()
 
static bool wantsStreamRuns ()
 
- Protected Member Functions inherited from edm::ProducerBase
template<class ProductType >
BranchAliasSetterT< ProductType > produces ()
 declare what type of product will make and with which optional label More...
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces ()
 
template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType > produces ()
 
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)
 
template<Transition B>
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 (std::string instanceName)
 
template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType > produces (std::string instanceName)
 
ProducesCollector producesCollector ()
 
- Protected Member Functions inherited from edm::EDConsumerBase
EDGetToken consumes (const TypeToGet &id, edm::InputTag const &tag)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > consumes (edm::InputTag const &tag)
 
template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B > consumes (edm::InputTag tag) noexcept
 
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 ProductType , BranchType B = InEvent>
void consumesMany ()
 
void consumesMany (const TypeToGet &id)
 
template<BranchType B>
void consumesMany (const TypeToGet &id)
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes ()
 
template<Transition Tr = Transition::Event>
constexpr auto esConsumes () noexcept
 
template<typename ESProduct , typename ESRecord , Transition Tr = Transition::Event>
auto esConsumes (ESInputTag const &tag)
 
template<Transition Tr = Transition::Event>
auto esConsumes (ESInputTag tag) noexcept
 
template<Transition Tr = Transition::Event>
ESGetTokenGeneric esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
 Used with EventSetupRecord::doGet. More...
 
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<BranchType B>
EDGetToken mayConsume (const TypeToGet &id, edm::InputTag const &tag)
 
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType > mayConsume (edm::InputTag const &tag)
 

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 62 of file JetEnergyShift.cc.

63  : inputJetsToken_(consumes<std::vector<pat::Jet>>(cfg.getParameter<edm::InputTag>("inputJets"))),
64  inputMETsToken_(consumes<std::vector<pat::MET>>(cfg.getParameter<edm::InputTag>("inputMETs"))),
65  scaleFactor_(cfg.getParameter<double>("scaleFactor")),
66  jetPTThresholdForMET_(cfg.getParameter<double>("jetPTThresholdForMET")),
67  jetEMLimitForMET_(cfg.getParameter<double>("jetEMLimitForMET")) {
68  // use label of input to create label for output
69  outputJets_ = cfg.getParameter<edm::InputTag>("inputJets").label();
70  outputMETs_ = cfg.getParameter<edm::InputTag>("inputMETs").label();
71  // register products
72  produces<std::vector<pat::Jet>>(outputJets_);
73  produces<std::vector<pat::MET>>(outputMETs_);
74 }

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

◆ ~JetEnergyShift()

JetEnergyShift::~JetEnergyShift ( )
inlineoverride

default destructor

Definition at line 39 of file JetEnergyShift.cc.

39 {};

Member Function Documentation

◆ produce()

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

rescale jet energy and recalculated MET

Implements edm::EDProducer.

Definition at line 76 of file JetEnergyShift.cc.

76  {
78  event.getByToken(inputJetsToken_, jets);
79 
81  event.getByToken(inputMETsToken_, mets);
82 
83  auto pJets = std::make_unique<std::vector<pat::Jet>>();
84  auto pMETs = std::make_unique<std::vector<pat::MET>>();
85 
86  double dPx = 0.;
87  double dPy = 0.;
88  double dSumEt = 0.;
89 
90  for (std::vector<pat::Jet>::const_iterator jet = jets->begin(); jet != jets->end(); ++jet) {
91  pat::Jet scaledJet = *jet;
92  scaledJet.scaleEnergy(scaleFactor_);
93  pJets->push_back(scaledJet);
94  // consider jet scale shift only if the raw jet pt and emf
95  // is above the thresholds given in the module definition
96  if (jet->correctedJet("raw").pt() > jetPTThresholdForMET_ && jet->emEnergyFraction() < jetEMLimitForMET_) {
97  dPx += scaledJet.px() - jet->px();
98  dPy += scaledJet.py() - jet->py();
99  dSumEt += scaledJet.et() - jet->et();
100  }
101  }
102 
103  // scale MET accordingly
104  pat::MET met = *(mets->begin());
105  double scaledMETPx = met.px() - dPx;
106  double scaledMETPy = met.py() - dPy;
107  pat::MET scaledMET(
108  reco::MET(met.sumEt() + dSumEt,
110  scaledMETPx, scaledMETPy, 0, sqrt(scaledMETPx * scaledMETPx + scaledMETPy * scaledMETPy)),
111  reco::MET::Point(0, 0, 0)));
112  pMETs->push_back(scaledMET);
113  event.put(std::move(pJets), outputJets_);
114  event.put(std::move(pMETs), outputMETs_);
115 }

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

Member Data Documentation

◆ inputJetsToken_

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

jet input collection

Definition at line 47 of file JetEnergyShift.cc.

Referenced by produce().

◆ inputMETsToken_

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

met input collection

Definition at line 49 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 59 of file JetEnergyShift.cc.

Referenced by produce().

◆ jetPTThresholdForMET_

double JetEnergyShift::jetPTThresholdForMET_
private

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

Definition at line 57 of file JetEnergyShift.cc.

Referenced by produce().

◆ outputJets_

std::string JetEnergyShift::outputJets_
private

jet output collection

Definition at line 51 of file JetEnergyShift.cc.

Referenced by JetEnergyShift(), and produce().

◆ outputMETs_

std::string JetEnergyShift::outputMETs_
private

MET output collection.

Definition at line 53 of file JetEnergyShift.cc.

Referenced by JetEnergyShift(), and produce().

◆ scaleFactor_

double JetEnergyShift::scaleFactor_
private

scale factor for the rescaling

Definition at line 55 of file JetEnergyShift.cc.

Referenced by produce().

reco::LeafCandidate::Point
math::XYZPoint Point
point in the space
Definition: LeafCandidate.h:27
JetEnergyShift::jetEMLimitForMET_
double jetEMLimitForMET_
limit on the emf of the jet for Type1 MET corrections
Definition: JetEnergyShift.cc:59
singleTopDQM_cfi.jets
jets
Definition: singleTopDQM_cfi.py:42
singleTopDQM_cfi.mets
mets
Definition: singleTopDQM_cfi.py:43
edm::Handle
Definition: AssociativeIterator.h:50
BTaggingMonitor_cfi.met
met
Definition: BTaggingMonitor_cfi.py:84
reco::MET
Definition: MET.h:41
pat::Jet
Analysis-level calorimeter jet class.
Definition: Jet.h:77
JetEnergyShift::outputMETs_
std::string outputMETs_
MET output collection.
Definition: JetEnergyShift.cc:53
pat::Jet::scaleEnergy
void scaleEnergy(double fScale) override
Scale energy and correspondingly adjust raw jec factors.
Definition: Jet.h:177
reco::LeafCandidate::py
double py() const final
y coordinate of momentum vector
Definition: LeafCandidate.h:142
JetEnergyShift::inputJetsToken_
edm::EDGetTokenT< std::vector< pat::Jet > > inputJetsToken_
jet input collection
Definition: JetEnergyShift.cc:47
mathSSE::sqrt
T sqrt(T t)
Definition: SSEVec.h:19
pat::MET
Analysis-level MET class.
Definition: MET.h:40
looper.cfg
cfg
Definition: looper.py:296
JetEnergyShift::jetPTThresholdForMET_
double jetPTThresholdForMET_
threshold on (raw!) jet pt for Type1 MET corrections
Definition: JetEnergyShift.cc:57
reco::LeafCandidate::et
double et() const final
transverse energy
Definition: LeafCandidate.h:127
JetEnergyShift::outputJets_
std::string outputJets_
jet output collection
Definition: JetEnergyShift.cc:51
eostools.move
def move(src, dest)
Definition: eostools.py:511
metsig::jet
Definition: SignAlgoResolutions.h:47
JetEnergyShift::scaleFactor_
double scaleFactor_
scale factor for the rescaling
Definition: JetEnergyShift.cc:55
JetEnergyShift::inputMETsToken_
edm::EDGetTokenT< std::vector< pat::MET > > inputMETsToken_
met input collection
Definition: JetEnergyShift.cc:49
edm::EDConsumerBase::consumes
EDGetTokenT< ProductType > consumes(edm::InputTag const &tag)
Definition: EDConsumerBase.h:159
reco::LeafCandidate::px
double px() const final
x coordinate of momentum vector
Definition: LeafCandidate.h:140
edm::InputTag
Definition: InputTag.h:15
label
const char * label
Definition: PFTauDecayModeTools.cc:11
reco::LeafCandidate::LorentzVector
math::XYZTLorentzVector LorentzVector
Lorentz vector.
Definition: LeafCandidate.h:23