CMS 3D CMS Logo

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

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

Inheritance diagram for FFTJetPileupEstimator:
edm::EDProducer edm::ProducerBase edm::EDConsumerBase edm::ProductRegistryHelper

Public Member Functions

 FFTJetPileupEstimator (const edm::ParameterSet &)
 
 ~FFTJetPileupEstimator ()
 
- Public Member Functions inherited from edm::EDProducer
 EDProducer ()
 
ModuleDescription const & moduleDescription () const
 
virtual ~EDProducer ()
 
- 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 ()
 
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, std::unordered_multimap< std::string, edm::ProductResolverIndex > const &iIndicies, std::string const &moduleLabel)
 
virtual ~ProducerBase () noexcept(false)
 
- Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfoconsumesInfo () const
 
 EDConsumerBase ()
 
 EDConsumerBase (EDConsumerBase const &)=delete
 
 EDConsumerBase (EDConsumerBase &&)=default
 
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
 
EDConsumerBaseoperator= (EDConsumerBase &&)=default
 
bool registeredToConsume (ProductResolverIndex, bool, BranchType) const
 
bool registeredToConsumeMany (TypeID const &, BranchType) const
 
void updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)
 
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 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::FFTJetPileupSummarycalibrateFromConfig (double uncalibrated) const
 
std::unique_ptr< reco::FFTJetPileupSummarycalibrateFromDB (double uncalibrated, const edm::EventSetup &iSetup) const
 
template<class Ptr >
void checkConfig (const Ptr &ptr, const char *message)
 
 FFTJetPileupEstimator ()
 
 FFTJetPileupEstimator (const FFTJetPileupEstimator &)
 
FFTJetPileupEstimatoroperator= (const FFTJetPileupEstimator &)
 

Private Attributes

std::auto_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::DiscretizedEnergyFlowinputToken
 
bool loadCalibFromDB
 
std::string outputLabel
 
double ptToDensityFactor
 
std::auto_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
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)
 

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.

114  init_param(double, cdfvalue),
115  init_param(double, ptToDensityFactor),
116  init_param(unsigned, filterNumber),
117  init_param(std::vector<double>, uncertaintyZones),
124 {
126  ps.getParameter<edm::ParameterSet>("calibrationCurve"));
127  checkConfig(calibrationCurve, "bad calibration curve definition");
128 
130  ps.getParameter<edm::ParameterSet>("uncertaintyCurve"));
131  checkConfig(uncertaintyCurve, "bad uncertainty curve definition");
132 
133  inputToken = consumes<reco::DiscretizedEnergyFlow>(inputLabel);
134 
135  produces<reco::FFTJetPileupSummary>(outputLabel);
136 }
T getParameter(std::string const &) const
std::auto_ptr< fftjet::Functor1< double, double > > calibrationCurve
edm::EDGetTokenT< reco::DiscretizedEnergyFlow > inputToken
std::auto_ptr< fftjet::Functor1< double, double > > fftjet_Function_parser(const edm::ParameterSet &ps)
std::vector< double > uncertaintyZones
std::auto_ptr< fftjet::Functor1< double, double > > uncertaintyCurve
#define init_param(type, varname)
void checkConfig(const Ptr &ptr, const char *message)
FFTJetPileupEstimator::~FFTJetPileupEstimator ( )

Definition at line 139 of file FFTJetPileupEstimator.cc.

140 {
141 }
FFTJetPileupEstimator::FFTJetPileupEstimator ( )
private
FFTJetPileupEstimator::FFTJetPileupEstimator ( const FFTJetPileupEstimator )
private

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

195 {
196  const double pileupRho = ptToDensityFactor*(*calibrationCurve)(curve);
197  const double rhoUncert = ptToDensityFactor*(*uncertaintyCurve)(curve);
198 
199  // Determine the uncertainty zone of the estimate. The "curve"
200  // has to be above or equal to uncertaintyZones[i] but below
201  // uncertaintyZones[i + 1] (the second condition is also satisfied
202  // by i == uncertaintyZones.size() - 1). Of course, it is assumed
203  // that the vector of zones is configured appropriately -- the zone
204  // boundaries must be presented in the increasing order.
205  int uncertaintyCode = -1;
206  if (!uncertaintyZones.empty())
207  {
208  const unsigned nZones = uncertaintyZones.size();
209  for (unsigned i = 0; i < nZones; ++i)
210  if (curve >= uncertaintyZones[i])
211  {
212  if (i == nZones - 1U)
213  {
214  uncertaintyCode = i;
215  break;
216  }
217  else if (curve < uncertaintyZones[i + 1])
218  {
219  uncertaintyCode = i;
220  break;
221  }
222  }
223  }
224 
225  return std::make_unique<reco::FFTJetPileupSummary>(curve, pileupRho, rhoUncert, uncertaintyCode);
226 }
std::vector< double > uncertaintyZones
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().

232 {
235  iSetup, calibTableRecord, h);
236  boost::shared_ptr<npstat::StorableMultivariateFunctor> uz =
238  boost::shared_ptr<npstat::StorableMultivariateFunctor> cc =
240  boost::shared_ptr<npstat::StorableMultivariateFunctor> uc =
242 
243  const double pileupRho = ptToDensityFactor*(*cc)(&curve, 1U);
244  const double rhoUncert = ptToDensityFactor*(*uc)(&curve, 1U);
245  const int uncertaintyCode = round((*uz)(&curve, 1U));
246 
247  return std::make_unique<reco::FFTJetPileupSummary>(curve, pileupRho, rhoUncert, uncertaintyCode);
248 }
FWCore Framework interface EventSetupRecordImplementation h
Helper function to determine trigger accepts.
static const Mapper & instance()
template<class Ptr >
void FFTJetPileupEstimator::checkConfig ( const Ptr &  ptr,
const char *  message 
)
inlineprivate

Definition at line 70 of file FFTJetPileupEstimator.cc.

References NULL.

Referenced by FFTJetPileupEstimator().

71  {
72  if (ptr.get() == NULL)
73  throw cms::Exception("FFTJetBadConfig") << message << std::endl;
74  }
#define NULL
Definition: scimark2.h:8
void FFTJetPileupEstimator::endJob ( void  )
overrideprotectedvirtual

Reimplemented from edm::EDProducer.

Definition at line 188 of file FFTJetPileupEstimator.cc.

189 {
190 }
FFTJetPileupEstimator& FFTJetPileupEstimator::operator= ( const FFTJetPileupEstimator )
private
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.

150 {
152  iEvent.getByToken(inputToken, input);
153 
154  const reco::DiscretizedEnergyFlow& h(*input);
155  const unsigned nScales = h.nEtaBins();
156  const unsigned nCdfvalues = h.nPhiBins();
157 
158  const unsigned fixedCdfvalueBin = static_cast<unsigned>(
159  std::floor(cdfvalue*nCdfvalues));
160  if (fixedCdfvalueBin >= nCdfvalues)
161  {
162  throw cms::Exception("FFTJetBadConfig")
163  << "Bad cdf value" << std::endl;
164  }
165  if (filterNumber >= nScales)
166  {
167  throw cms::Exception("FFTJetBadConfig")
168  << "Bad filter number" << std::endl;
169  }
170 
171  // Simple fixed-point pile-up estimate
172  const double curve = h.data()[filterNumber*nCdfvalues + fixedCdfvalueBin];
173 
174  std::unique_ptr<reco::FFTJetPileupSummary> summary;
175  if (loadCalibFromDB)
176  summary = calibrateFromDB(curve, iSetup);
177  else
178  summary = calibrateFromConfig(curve);
179  iEvent.put(std::move(summary), outputLabel);
180 }
OrphanHandle< PROD > put(std::unique_ptr< PROD > product)
Put a new product.
Definition: Event.h:122
FWCore Framework interface EventSetupRecordImplementation h
Helper function to determine trigger accepts.
bool getByToken(EDGetToken token, Handle< PROD > &result) const
Definition: Event.h:460
std::unique_ptr< reco::FFTJetPileupSummary > calibrateFromDB(double uncalibrated, const edm::EventSetup &iSetup) const
static std::string const input
Definition: EdmProvDump.cc:44
edm::EDGetTokenT< reco::DiscretizedEnergyFlow > inputToken
std::unique_ptr< reco::FFTJetPileupSummary > calibrateFromConfig(double uncalibrated) const
def move(src, dest)
Definition: eostools.py:510

Member Data Documentation

std::auto_ptr<fftjet::Functor1<double,double> > FFTJetPileupEstimator::calibrationCurve
private

Definition at line 84 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

std::string FFTJetPileupEstimator::calibrationCurveName
private

Definition at line 103 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

std::string FFTJetPileupEstimator::calibTableCategory
private

Definition at line 101 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

std::string FFTJetPileupEstimator::calibTableRecord
private

Definition at line 100 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

double FFTJetPileupEstimator::cdfvalue
private

Definition at line 80 of file FFTJetPileupEstimator.cc.

Referenced by produce().

unsigned FFTJetPileupEstimator::filterNumber
private

Definition at line 82 of file FFTJetPileupEstimator.cc.

Referenced by produce().

edm::InputTag FFTJetPileupEstimator::inputLabel
private

Definition at line 76 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

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

Definition at line 77 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator(), and produce().

bool FFTJetPileupEstimator::loadCalibFromDB
private

Definition at line 105 of file FFTJetPileupEstimator.cc.

Referenced by produce().

std::string FFTJetPileupEstimator::outputLabel
private

Definition at line 79 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator(), and produce().

double FFTJetPileupEstimator::ptToDensityFactor
private

Definition at line 81 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromConfig(), and calibrateFromDB().

std::auto_ptr<fftjet::Functor1<double,double> > FFTJetPileupEstimator::uncertaintyCurve
private

Definition at line 85 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

std::string FFTJetPileupEstimator::uncertaintyCurveName
private

Definition at line 104 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

std::vector<double> FFTJetPileupEstimator::uncertaintyZones
private

Definition at line 83 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromConfig().

std::string FFTJetPileupEstimator::uncertaintyZonesName
private

Definition at line 102 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().