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

Inheritance diagram for FFTJetPileupEstimator:

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

	FFTJetPileupEstimator ()=delete

	FFTJetPileupEstimator (const FFTJetPileupEstimator &)=delete

FFTJetPileupEstimator &	operator= (const FFTJetPileupEstimator &)=delete

	~FFTJetPileupEstimator () 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)

Protected Member Functions
void	beginJob () override

void	endJob () override

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

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)

Private Member Functions
std::unique_ptr< reco::FFTJetPileupSummary >	calibrateFromConfig (double uncalibrated) const

std::unique_ptr< reco::FFTJetPileupSummary >	calibrateFromDB (double uncalibrated, const edm::EventSetup &iSetup) const

template<class Ptr >
void	checkConfig (const Ptr &ptr, const char *message)

Private Attributes
std::unique_ptr< fftjet::Functor1< double, double > >	calibrationCurve

std::string	calibrationCurveName

std::string	calibTableCategory

std::string	calibTableRecord

double	cdfvalue

unsigned	filterNumber

edm::InputTag	inputLabel

edm::EDGetTokenT< reco::DiscretizedEnergyFlow >	inputToken

bool	loadCalibFromDB

std::string	outputLabel

double	ptToDensityFactor

std::unique_ptr< fftjet::Functor1< double, double > >	uncertaintyCurve

std::string	uncertaintyCurveName

std::vector< double >	uncertaintyZones

std::string	uncertaintyZonesName

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

Detailed Description

Description: applies calibration curve and estimates the actual pileup

Implementation: [Notes on implementation]

Definition at line 46 of file FFTJetPileupEstimator.cc.

Constructor & Destructor Documentation

◆ FFTJetPileupEstimator() [1/3]

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

explicit

Definition at line 106 of file FFTJetPileupEstimator.cc.

References calibrationCurve, checkConfig(), fftjetcms::fftjet_Function_parser(), edm::ParameterSet::getParameter(), inputLabel, inputToken, outputLabel, and uncertaintyCurve.

     : init_param(edm::InputTag, inputLabel),
       init_param(std::string, outputLabel),
       init_param(double, cdfvalue),
       init_param(double, ptToDensityFactor),
       init_param(unsigned, filterNumber),
       init_param(std::vector<double>, uncertaintyZones),
       init_param(std::string, calibTableRecord),
       init_param(std::string, calibTableCategory),
       init_param(std::string, uncertaintyZonesName),
       init_param(std::string, calibrationCurveName),
       init_param(std::string, uncertaintyCurveName),
       init_param(bool, loadCalibFromDB) {
   calibrationCurve = fftjet_Function_parser(ps.getParameter<edm::ParameterSet>("calibrationCurve"));
   checkConfig(calibrationCurve, "bad calibration curve definition");
 
   uncertaintyCurve = fftjet_Function_parser(ps.getParameter<edm::ParameterSet>("uncertaintyCurve"));
   checkConfig(uncertaintyCurve, "bad uncertainty curve definition");
 
   inputToken = consumes<reco::DiscretizedEnergyFlow>(inputLabel);
 
   produces<reco::FFTJetPileupSummary>(outputLabel);
 }

◆ FFTJetPileupEstimator() [2/3]

FFTJetPileupEstimator::FFTJetPileupEstimator ( )

delete

◆ FFTJetPileupEstimator() [3/3]

FFTJetPileupEstimator::FFTJetPileupEstimator ( const FFTJetPileupEstimator & )

delete

◆ ~FFTJetPileupEstimator()

FFTJetPileupEstimator::~FFTJetPileupEstimator ( )

override

Definition at line 130 of file FFTJetPileupEstimator.cc.

130 {}

Member Function Documentation

◆ beginJob()

void FFTJetPileupEstimator::beginJob ( void )

overrideprotectedvirtual

Reimplemented from edm::EDProducer.

Definition at line 164 of file FFTJetPileupEstimator.cc.

164 {}

◆ calibrateFromConfig()

std::unique_ptr< reco::FFTJetPileupSummary > FFTJetPileupEstimator::calibrateFromConfig ( double uncalibrated ) const

private

Definition at line 168 of file FFTJetPileupEstimator.cc.

References mps_fire::i, ptToDensityFactor, mitigatedMETSequence_cff::U, and uncertaintyZones.

Referenced by produce().

                                                                                                           {
   const double pileupRho = ptToDensityFactor * (*calibrationCurve)(curve);
   const double rhoUncert = ptToDensityFactor * (*uncertaintyCurve)(curve);
 
   // Determine the uncertainty zone of the estimate. The "curve"
   // has to be above or equal to uncertaintyZones[i]  but below
   // uncertaintyZones[i + 1] (the second condition is also satisfied
   // by i == uncertaintyZones.size() - 1). Of course, it is assumed
   // that the vector of zones is configured appropriately -- the zone
   // boundaries must be presented in the increasing order.
   int uncertaintyCode = -1;
   if (!uncertaintyZones.empty()) {
     const unsigned nZones = uncertaintyZones.size();
     for (unsigned i = 0; i < nZones; ++i)
       if (curve >= uncertaintyZones[i]) {
         if (i == nZones - 1U) {
           uncertaintyCode = i;
           break;
         } else if (curve < uncertaintyZones[i + 1]) {
           uncertaintyCode = i;
           break;
         }
       }
   }
 
   return std::make_unique<reco::FFTJetPileupSummary>(curve, pileupRho, rhoUncert, uncertaintyCode);
 }

◆ calibrateFromDB()

std::unique_ptr< reco::FFTJetPileupSummary > FFTJetPileupEstimator::calibrateFromDB	(	double	uncalibrated,
		const edm::EventSetup &	iSetup
	)		const

private

Definition at line 196 of file FFTJetPileupEstimator.cc.

References calibrationCurveName, calibTableCategory, calibTableRecord, h, StaticFFTJetRcdMapper< Mapper >::instance(), ptToDensityFactor, mitigatedMETSequence_cff::U, uncertaintyCurveName, and uncertaintyZonesName.

Referenced by produce().

                                                                                                                      {
   edm::ESHandle<FFTJetLookupTableSequence> h;
   StaticFFTJetLookupTableSequenceLoader::instance().load(iSetup, calibTableRecord, h);
   std::shared_ptr<npstat::StorableMultivariateFunctor> uz = (*h)[calibTableCategory][uncertaintyZonesName];
   std::shared_ptr<npstat::StorableMultivariateFunctor> cc = (*h)[calibTableCategory][calibrationCurveName];
   std::shared_ptr<npstat::StorableMultivariateFunctor> uc = (*h)[calibTableCategory][uncertaintyCurveName];
 
   const double pileupRho = ptToDensityFactor * (*cc)(&curve, 1U);
   const double rhoUncert = ptToDensityFactor * (*uc)(&curve, 1U);
   const int uncertaintyCode = round((*uz)(&curve, 1U));
 
   return std::make_unique<reco::FFTJetPileupSummary>(curve, pileupRho, rhoUncert, uncertaintyCode);
 }

◆ checkConfig()

template<class Ptr >

void FFTJetPileupEstimator::checkConfig	(	const Ptr &	ptr,
		const char *	message
	)

inlineprivate

Definition at line 66 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

                                                                {
     if (ptr.get() == nullptr)
       throw cms::Exception("FFTJetBadConfig") << message << std::endl;
   }

◆ endJob()

void FFTJetPileupEstimator::endJob ( void )

overrideprotectedvirtual

Reimplemented from edm::EDProducer.

Definition at line 166 of file FFTJetPileupEstimator.cc.

166 {}

◆ operator=()

FFTJetPileupEstimator& FFTJetPileupEstimator::operator= ( const FFTJetPileupEstimator & )

delete

◆ produce()

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

overrideprotectedvirtual

Implements edm::EDProducer.

Definition at line 137 of file FFTJetPileupEstimator.cc.

References calibrateFromConfig(), calibrateFromDB(), cdfvalue, Exception, filterNumber, h, iEvent, input, inputToken, loadCalibFromDB, eostools::move(), fftjetcommon_cfi::nScales, outputLabel, and edmLumisInFiles::summary.

                                                                                  {
   edm::Handle<reco::DiscretizedEnergyFlow> input;
   iEvent.getByToken(inputToken, input);
 
   const reco::DiscretizedEnergyFlow& h(*input);
   const unsigned nScales = h.nEtaBins();
   const unsigned nCdfvalues = h.nPhiBins();
 
   const unsigned fixedCdfvalueBin = static_cast<unsigned>(std::floor(cdfvalue * nCdfvalues));
   if (fixedCdfvalueBin >= nCdfvalues) {
     throw cms::Exception("FFTJetBadConfig") << "Bad cdf value" << std::endl;
   }
   if (filterNumber >= nScales) {
     throw cms::Exception("FFTJetBadConfig") << "Bad filter number" << std::endl;
   }
 
   // Simple fixed-point pile-up estimate
   const double curve = h.data()[filterNumber * nCdfvalues + fixedCdfvalueBin];
 
   std::unique_ptr<reco::FFTJetPileupSummary> summary;
   if (loadCalibFromDB)
     summary = calibrateFromDB(curve, iSetup);
   else
     summary = calibrateFromConfig(curve);
   iEvent.put(std::move(summary), outputLabel);
 }

Member Data Documentation

◆ calibrationCurve

std::unique_ptr<fftjet::Functor1<double, double> > FFTJetPileupEstimator::calibrationCurve

private

Definition at line 79 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

◆ calibrationCurveName

std::string FFTJetPileupEstimator::calibrationCurveName

private

Definition at line 98 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

◆ calibTableCategory

std::string FFTJetPileupEstimator::calibTableCategory

private

Definition at line 96 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

◆ calibTableRecord

std::string FFTJetPileupEstimator::calibTableRecord

private

Definition at line 95 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

◆ cdfvalue

double FFTJetPileupEstimator::cdfvalue

private

Definition at line 75 of file FFTJetPileupEstimator.cc.

Referenced by produce().

◆ filterNumber

unsigned FFTJetPileupEstimator::filterNumber

private

Definition at line 77 of file FFTJetPileupEstimator.cc.

Referenced by produce().

◆ inputLabel

edm::InputTag FFTJetPileupEstimator::inputLabel

private

Definition at line 71 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

◆ inputToken

edm::EDGetTokenT<reco::DiscretizedEnergyFlow> FFTJetPileupEstimator::inputToken

private

Definition at line 72 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator(), and produce().

◆ loadCalibFromDB

bool FFTJetPileupEstimator::loadCalibFromDB

private

Definition at line 100 of file FFTJetPileupEstimator.cc.

Referenced by produce().

◆ outputLabel

std::string FFTJetPileupEstimator::outputLabel

private

Definition at line 74 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator(), and produce().

◆ ptToDensityFactor

double FFTJetPileupEstimator::ptToDensityFactor

private

Definition at line 76 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromConfig(), and calibrateFromDB().

◆ uncertaintyCurve

std::unique_ptr<fftjet::Functor1<double, double> > FFTJetPileupEstimator::uncertaintyCurve

private

Definition at line 80 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

◆ uncertaintyCurveName

std::string FFTJetPileupEstimator::uncertaintyCurveName

private

Definition at line 99 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

◆ uncertaintyZones

std::vector<double> FFTJetPileupEstimator::uncertaintyZones

private

Definition at line 78 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromConfig().

◆ uncertaintyZonesName

std::string FFTJetPileupEstimator::uncertaintyZonesName

private

Definition at line 97 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FFTJetPileupEstimator() [1/3]

◆ FFTJetPileupEstimator() [2/3]

◆ FFTJetPileupEstimator() [3/3]

◆ ~FFTJetPileupEstimator()

Member Function Documentation

◆ beginJob()

◆ calibrateFromConfig()

◆ calibrateFromDB()

◆ checkConfig()

◆ endJob()

◆ operator=()

◆ produce()

Member Data Documentation

◆ calibrationCurve

◆ calibrationCurveName

◆ calibTableCategory

◆ calibTableRecord

◆ cdfvalue

◆ filterNumber

◆ inputLabel

◆ inputToken

◆ loadCalibFromDB

◆ outputLabel

◆ ptToDensityFactor

◆ uncertaintyCurve

◆ uncertaintyCurveName

◆ uncertaintyZones

◆ uncertaintyZonesName