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

Inheritance diagram for FFTJetPileupEstimator:

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

	~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

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)

	~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

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::vector< ModuleDescription const * > &modules, 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

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::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

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

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)

	FFTJetPileupEstimator ()=delete

	FFTJetPileupEstimator (const FFTJetPileupEstimator &)=delete

FFTJetPileupEstimator &	operator= (const FFTJetPileupEstimator &)=delete

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	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::FFTJetPileupEstimator ( const edm::ParameterSet & ps )

explicit

Definition at line 111 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::~FFTJetPileupEstimator ( )

override

Definition at line 139 of file FFTJetPileupEstimator.cc.

140 {

141 }

FFTJetPileupEstimator::FFTJetPileupEstimator ( )

privatedelete

FFTJetPileupEstimator::FFTJetPileupEstimator ( const FFTJetPileupEstimator & )

privatedelete

Member Function Documentation

void FFTJetPileupEstimator::beginJob ( void )

overrideprotectedvirtual

Reimplemented from edm::EDProducer.

Definition at line 183 of file FFTJetPileupEstimator.cc.

184 {

185 }

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

private

Definition at line 194 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);
 }

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

private

Definition at line 230 of file FFTJetPileupEstimator.cc.

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

Referenced by produce().

 {
     edm::ESHandle<FFTJetLookupTableSequence> h;
     StaticFFTJetLookupTableSequenceLoader::instance().load(
         iSetup, calibTableRecord, h);
     boost::shared_ptr<npstat::StorableMultivariateFunctor> uz =
         (*h)[calibTableCategory][uncertaintyZonesName];
     boost::shared_ptr<npstat::StorableMultivariateFunctor> cc =
         (*h)[calibTableCategory][calibrationCurveName];
     boost::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);
 }

template<class Ptr >

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

inlineprivate

Definition at line 70 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

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

void FFTJetPileupEstimator::endJob ( void )

overrideprotectedvirtual

Reimplemented from edm::EDProducer.

Definition at line 188 of file FFTJetPileupEstimator.cc.

189 {

190 }

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

privatedelete

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

overrideprotected

Definition at line 148 of file FFTJetPileupEstimator.cc.

References calibrateFromConfig(), calibrateFromDB(), cdfvalue, reco::DiscretizedEnergyFlow::data(), Exception, filterNumber, edm::Event::getByToken(), h, input, inputToken, loadCalibFromDB, eostools::move(), reco::DiscretizedEnergyFlow::nEtaBins(), reco::DiscretizedEnergyFlow::nPhiBins(), fftjetcommon_cfi::nScales, outputLabel, edm::Event::put(), and heppy_report::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);
 }