#include <RecoJets/FFTJetProducers/plugins/FFTJetCorrectionProducer.cc>

Inheritance diagram for FFTJetCorrectionProducer:

Public Member Functions
	FFTJetCorrectionProducer (const edm::ParameterSet &)

	~FFTJetCorrectionProducer () override

Public Member Functions inherited from edm::EDProducer
	EDProducer ()

SerialTaskQueue *	globalLuminosityBlocksQueue ()

SerialTaskQueue *	globalRunsQueue ()

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< ConsumesInfo >	consumesInfo () 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

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

EDConsumerBase const &	operator= (EDConsumerBase const &)=delete

EDConsumerBase &	operator= (EDConsumerBase &&)=default

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
template<typename Jet >
void	applyCorrections (edm::Event &iEvent, const edm::EventSetup &iSetup)

void	beginJob () override

void	endJob () override

template<typename Jet >
void	makeProduces (const std::string &alias, const std::string &tag)

template<typename Jet >
void	performPileupSubtraction (Jet &)

void	produce (edm::Event &, const edm::EventSetup &) override

Private Attributes
unsigned long	eventCount

edm::EDGetTokenT< std::vector< reco::FFTAnyJet< reco::Jet > > >	input_jets_token_

const edm::InputTag	inputLabel

const JetType	jetType

const std::string	outputLabel

const std::vector< std::string >	records

std::vector< int >	sequenceMasks

const bool	subtractPileup

const bool	subtractPileupAs4Vec

const bool	verbose

const bool	writeUncertainties

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<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< B >	consumes (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 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<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

Description: producer for correcting jets created by FFTJetProducer

Implementation: [Notes on implementation]

Definition at line 87 of file FFTJetCorrectionProducer.cc.

Constructor & Destructor Documentation

◆ FFTJetCorrectionProducer()

FFTJetCorrectionProducer::FFTJetCorrectionProducer ( const edm::ParameterSet & ps )

explicit

Definition at line 321 of file FFTJetCorrectionProducer.cc.

References SiStripOfflineCRack_cfg::alias, edm::ParameterSet::getUntrackedParameter(), input_jets_token_, inputLabel, jet_type_switch, makeProduces(), outputLabel, AlCaHLTBitMon_QueryRunRegistry::string, and writeUncertainties.

     : inputLabel(ps.getParameter<edm::InputTag>("src")),
       outputLabel(ps.getParameter<std::string>("outputLabel")),
       jetType(parseJetType(ps.getParameter<std::string>("jetType"))),
       records(ps.getParameter<std::vector<std::string>>("records")),
       writeUncertainties(ps.getParameter<bool>("writeUncertainties")),
       subtractPileup(ps.getParameter<bool>("subtractPileup")),
       subtractPileupAs4Vec(ps.getParameter<bool>("subtractPileupAs4Vec")),
       verbose(ps.getUntrackedParameter<bool>("verbose", false)),
       eventCount(0UL) {
   const std::string alias(ps.getUntrackedParameter<std::string>("alias", outputLabel));
   jet_type_switch(makeProduces, alias, outputLabel);
 
   if (writeUncertainties)
     produces<std::vector<float>>(outputLabel).setBranchAlias(alias);
 
   input_jets_token_ = consumes<std::vector<reco::FFTAnyJet<reco::Jet>>>(inputLabel);
 }

◆ ~FFTJetCorrectionProducer()

FFTJetCorrectionProducer::~FFTJetCorrectionProducer ( )

override

Definition at line 340 of file FFTJetCorrectionProducer.cc.

340 {}

Member Function Documentation

◆ applyCorrections()

template<typename Jet >

void FFTJetCorrectionProducer::applyCorrections	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

private

Definition at line 160 of file FFTJetCorrectionProducer.cc.

References alignCSCRings::corr, gather_cfg::cout, TauDecayModes::dec, Exception, f, reco::FFTJet< Real >::f_recoScale(), reco::FFTJet< Real >::f_status(), reco::FFTJet< Real >::f_vec(), mps_fire::i, iEvent, instance, submitPVValidationJobs::isMC, dqmiolumiharvest::j, singleTopDQM_cfi::jets, personalPlayback::level, callgraph::Loader, eostools::move(), recoTrackAccumulator_cfi::outputLabel, PILEUP_CALCULATION_MASK, PILEUP_SUBTRACTION_MASK_ANY, DiDispStaMuonMonitor_cfi::pt, alignCSCRings::s, jetUpdater_cfi::sort, mathSSE::sqrt(), fftjetproducer_cfi::subtractPileup, and verbose.

Referenced by produce().

                                                                                              {
   using reco::FFTJet;
   typedef reco::FFTAnyJet<Jet> MyJet;
   typedef std::vector<MyJet> MyCollection;
   typedef typename FFTJetCorrectorSequenceTypemap<MyJet>::loader Loader;
   typedef typename Loader::data_type CorrectorSequence;
   typedef typename CorrectorSequence::result_type CorrectorResult;
 
   // Load the jet corrector sequences
   const unsigned nRecords = records.size();
   std::vector<edm::ESHandle<CorrectorSequence>> handles(nRecords);
   for (unsigned irec = 0; irec < nRecords; ++irec)
     Loader::instance().load(iSetup, records[irec], handles[irec]);
 
   // Figure out which correction levels we are applying
   // and create masks which will indicate this
   sequenceMasks.clear();
   sequenceMasks.reserve(nRecords);
 
   int totalMask = 0;
   for (unsigned irec = 0; irec < nRecords; ++irec) {
     int levelMask = 0;
     const unsigned nLevels = handles[irec]->nLevels();
     for (unsigned i = 0; i < nLevels; ++i) {
       const unsigned lev = (*handles[irec])[i].level();
 
       // Not tracking "level 0" corrections in the status word.
       // Level 0 is basically reserved for uncertainty calculations.
       if (lev) {
         const int mask = (1 << lev);
         if (totalMask & mask)
           throw cms::Exception("FFTJetBadConfig")
               << "Error in FFTJetCorrectionProducer::applyCorrections:"
               << " jet correction at level " << lev << " is applied more than once\n";
         totalMask |= mask;
         levelMask |= mask;
       }
     }
     sequenceMasks.push_back(levelMask << 12);
   }
   totalMask = (totalMask << 12);
 
   // Is this data or MC?
   const bool isMC = !iEvent.isRealData();
 
   // Load the jet collection
   edm::Handle<MyCollection> jets;
   iEvent.getByToken(input_jets_token_, jets);
 
   // Create the output collection
   const unsigned nJets = jets->size();
   auto coll = std::make_unique<MyCollection>();
   coll->reserve(nJets);
 
   // Cycle over jets and apply the corrector sequences
   bool sorted = true;
   double previousPt = DBL_MAX;
   for (unsigned ijet = 0; ijet < nJets; ++ijet) {
     const MyJet& j((*jets)[ijet]);
 
     // Check that this jet has not been corrected yet
     const int initialStatus = j.getFFTSpecific().f_status();
     if (initialStatus & totalMask)
       throw cms::Exception("FFTJetBadConfig") << "Error in FFTJetCorrectionProducer::applyCorrections: "
                                               << "this jet collection is already corrected for some or all "
                                               << "of the specified levels\n";
 
     MyJet corJ(j);
 
     if (verbose) {
       const reco::FFTJet<float>& fj = corJ.getFFTSpecific();
       std::cout << "++++ Evt " << eventCount << " jet " << ijet << ": pt = " << corJ.pt()
                 << ", eta = " << fj.f_vec().eta() << ", R = " << fj.f_recoScale() << ", s = 0x" << std::hex
                 << fj.f_status() << std::dec << std::endl;
     }
 
     // Check if we need to subtract pileup first.
     // Pileup subtraction is not part of the corrector sequence
     // itself because 4-vector subtraction does not map well
     // into multiplication of 4-vectors by a scale factor.
     if (subtractPileup) {
       if (initialStatus & PILEUP_SUBTRACTION_MASK_ANY)
         throw cms::Exception("FFTJetBadConfig") << "Error in FFTJetCorrectionProducer::applyCorrections: "
                                                 << "this jet collection is already pileup-subtracted\n";
       if (!(initialStatus & PILEUP_CALCULATION_MASK))
         throw cms::Exception("FFTJetBadConfig") << "Error in FFTJetCorrectionProducer::applyCorrections: "
                                                 << "pileup was not calculated for this jet collection\n";
       performPileupSubtraction(corJ);
 
       if (verbose) {
         const reco::FFTJet<float>& fj = corJ.getFFTSpecific();
         std::cout << "     Pileup subtract"
                   << ": pt = " << corJ.pt() << ", eta = " << fj.f_vec().eta() << ", R = " << fj.f_recoScale()
                   << ", s = 0x" << std::hex << fj.f_status() << std::dec << std::endl;
       }
     }
 
     // Apply all jet correction sequences
     double sigmaSquared = 0.0;
     for (unsigned irec = 0; irec < nRecords; ++irec) {
       const CorrectorResult& corr = handles[irec]->correct(corJ, isMC);
 
       // Update the 4-vector
       FFTJet<float>& fftJet(const_cast<FFTJet<float>&>(corJ.getFFTSpecific()));
       corJ.setP4(corr.vec());
       fftJet.setFourVec(corr.vec());
 
       // Update the jet correction status
       fftJet.setStatus(fftJet.f_status() | sequenceMasks[irec]);
 
       // Update the (systematic) uncertainty
       const double s = corr.sigma();
       sigmaSquared += s * s;
     }
 
     // There is no place for uncertainty in the jet structure.
     // However, there is the unused pileup field (FFTJet maintains
     // the pileup separately as a 4-vector). Use this unused field
     // to store the uncertainty. This hack is needed because
     // subsequent sequence sorting by Pt can change the jet ordering.
     if (writeUncertainties)
       corJ.setPileup(sqrt(sigmaSquared));
 
     coll->push_back(corJ);
 
     // Check whether the sequence remains sorted by pt
     const double pt = corJ.pt();
     if (pt > previousPt)
       sorted = false;
     previousPt = pt;
 
     if (verbose) {
       const reco::FFTJet<float>& fj = corJ.getFFTSpecific();
       std::cout << "     Fully corrected"
                 << ": pt = " << corJ.pt() << ", eta = " << fj.f_vec().eta() << ", R = " << fj.f_recoScale()
                 << ", s = 0x" << std::hex << fj.f_status() << std::dec << std::endl;
     }
   }
 
   if (!sorted)
     std::sort(coll->begin(), coll->end(), LocalSortByPt());
 
   // Create the uncertainty sequence
   if (writeUncertainties) {
     auto unc = std::make_unique<std::vector<float>>();
     unc->reserve(nJets);
     for (unsigned ijet = 0; ijet < nJets; ++ijet) {
       MyJet& j((*coll)[ijet]);
       unc->push_back(j.pileup());
       j.setPileup(0.f);
     }
     iEvent.put(std::move(unc), outputLabel);
   }
 
   iEvent.put(std::move(coll), outputLabel);
   ++eventCount;
 }

◆ beginJob()

void FFTJetCorrectionProducer::beginJob ( void )

overrideprivatevirtual

Reimplemented from edm::EDProducer.

Definition at line 348 of file FFTJetCorrectionProducer.cc.

348 {}

◆ endJob()

void FFTJetCorrectionProducer::endJob ( void )

overrideprivatevirtual

Reimplemented from edm::EDProducer.

Definition at line 351 of file FFTJetCorrectionProducer.cc.

351 {}

◆ makeProduces()

template<typename T >

void FFTJetCorrectionProducer::makeProduces	(	const std::string &	alias,
		const std::string &	tag
	)

private

Definition at line 139 of file FFTJetCorrectionProducer.cc.

References SiStripOfflineCRack_cfg::alias, and makeGlobalPositionRcd_cfg::tag.

Referenced by FFTJetCorrectionProducer().

                                                                                         {
   produces<std::vector<reco::FFTAnyJet<T>>>(tag).setBranchAlias(alias);
 }

◆ performPileupSubtraction()

template<typename Jet >

void FFTJetCorrectionProducer::performPileupSubtraction ( Jet & jet )

private

Definition at line 144 of file FFTJetCorrectionProducer.cc.

References fftjetcms::adjustForPileup(), metsig::jet, PILEUP_SUBTRACTION_MASK_4VEC, PILEUP_SUBTRACTION_MASK_PT, mps_update::status, and fftjetproducer_cfi::subtractPileupAs4Vec.

                                                                 {
   using reco::FFTJet;
 
   FFTJet<float>& fftJet(const_cast<FFTJet<float>&>(jet.getFFTSpecific()));
   const math::XYZTLorentzVector& new4vec = adjustForPileup(fftJet.f_vec(), fftJet.f_pileup(), subtractPileupAs4Vec);
   fftJet.setFourVec(new4vec);
   int status = fftJet.f_status();
   if (subtractPileupAs4Vec)
     status |= PILEUP_SUBTRACTION_MASK_4VEC;
   else
     status |= PILEUP_SUBTRACTION_MASK_PT;
   fftJet.setStatus(status);
   jet.setP4(new4vec);
 }

◆ produce()

void FFTJetCorrectionProducer::produce	(	edm::Event &	iEvent,
		const edm::EventSetup &	iSetup
	)

overrideprivatevirtual

Implements edm::EDProducer.

Definition at line 343 of file FFTJetCorrectionProducer.cc.

References applyCorrections(), iEvent, and jet_type_switch.

                                                                                     {
   jet_type_switch(applyCorrections, iEvent, iSetup);
 }

Member Data Documentation

◆ eventCount

unsigned long FFTJetCorrectionProducer::eventCount

private

Definition at line 132 of file FFTJetCorrectionProducer.cc.

◆ input_jets_token_

edm::EDGetTokenT<std::vector<reco::FFTAnyJet<reco::Jet> > > FFTJetCorrectionProducer::input_jets_token_

private

Definition at line 135 of file FFTJetCorrectionProducer.cc.

Referenced by FFTJetCorrectionProducer().

◆ inputLabel

const edm::InputTag FFTJetCorrectionProducer::inputLabel

private

Definition at line 107 of file FFTJetCorrectionProducer.cc.

Referenced by FFTJetCorrectionProducer().

◆ jetType

const JetType FFTJetCorrectionProducer::jetType

private

Definition at line 113 of file FFTJetCorrectionProducer.cc.

◆ outputLabel

const std::string FFTJetCorrectionProducer::outputLabel

private

Definition at line 110 of file FFTJetCorrectionProducer.cc.

Referenced by FFTJetCorrectionProducer().

◆ records

const std::vector<std::string> FFTJetCorrectionProducer::records

private

Definition at line 116 of file FFTJetCorrectionProducer.cc.

◆ sequenceMasks

std::vector<int> FFTJetCorrectionProducer::sequenceMasks

private

Definition at line 129 of file FFTJetCorrectionProducer.cc.

◆ subtractPileup

const bool FFTJetCorrectionProducer::subtractPileup

private

Definition at line 122 of file FFTJetCorrectionProducer.cc.

◆ subtractPileupAs4Vec

const bool FFTJetCorrectionProducer::subtractPileupAs4Vec

private

Definition at line 123 of file FFTJetCorrectionProducer.cc.

◆ verbose

const bool FFTJetCorrectionProducer::verbose

private

Definition at line 126 of file FFTJetCorrectionProducer.cc.

◆ writeUncertainties

const bool FFTJetCorrectionProducer::writeUncertainties

private

Definition at line 119 of file FFTJetCorrectionProducer.cc.

Referenced by FFTJetCorrectionProducer().

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FFTJetCorrectionProducer()

◆ ~FFTJetCorrectionProducer()

Member Function Documentation

◆ applyCorrections()

◆ beginJob()

◆ endJob()

◆ makeProduces()

◆ performPileupSubtraction()

◆ produce()

Member Data Documentation

◆ eventCount

◆ input_jets_token_

◆ inputLabel

◆ jetType

◆ outputLabel

◆ records

◆ sequenceMasks

◆ subtractPileup

◆ subtractPileupAs4Vec

◆ verbose

◆ writeUncertainties