FFTJetPileupEstimator Class Reference

#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::stream::EDProducer<>
	EDProducer ()=default
	EDProducer (const EDProducer &)=delete
bool	hasAbilityToProduceInBeginLumis () const final
bool	hasAbilityToProduceInBeginProcessBlocks () const final
bool	hasAbilityToProduceInBeginRuns () const final
bool	hasAbilityToProduceInEndLumis () const final
bool	hasAbilityToProduceInEndProcessBlocks () const final
bool	hasAbilityToProduceInEndRuns () const final
const EDProducer &	operator= (const EDProducer &)=delete

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

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
FFTJetLookupTableSequenceLoader	esLoader
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::stream::EDProducer<>
using	CacheTypes = CacheContexts< T... >
using	GlobalCache = typename CacheTypes::GlobalCache
using	HasAbility = AbilityChecker< T... >
using	InputProcessBlockCache = typename CacheTypes::InputProcessBlockCache
using	LuminosityBlockCache = typename CacheTypes::LuminosityBlockCache
using	LuminosityBlockContext = LuminosityBlockContextT< LuminosityBlockCache, RunCache, GlobalCache >
using	LuminosityBlockSummaryCache = typename CacheTypes::LuminosityBlockSummaryCache
using	RunCache = typename CacheTypes::RunCache
using	RunContext = RunContextT< RunCache, GlobalCache >
using	RunSummaryCache = typename CacheTypes::RunSummaryCache

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 DefaultFFTJetRcdMapper< DataType >::acquireToken(), calibrationCurve, calibTableRecord, checkConfig(), esLoader, 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);

  esLoader.acquireToken(calibTableRecord, consumesCollector());
}

FFTJetPileupEstimator() [2/3]

FFTJetPileupEstimator::FFTJetPileupEstimator ( )

delete

FFTJetPileupEstimator() [3/3]

FFTJetPileupEstimator::FFTJetPileupEstimator ( const FFTJetPileupEstimator &  )

delete

~FFTJetPileupEstimator()

FFTJetPileupEstimator::~FFTJetPileupEstimator ( )

override

Definition at line 132 of file FFTJetPileupEstimator.cc.

{}

Member Function Documentation

calibrateFromConfig()

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

private

Definition at line 166 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 194 of file FFTJetPileupEstimator.cc.

References calibrationCurveName, calibTableCategory, calibTableRecord, esLoader, h, DefaultFFTJetRcdMapper< DataType >::load(), ptToDensityFactor, mitigatedMETSequence_cff::U, uncertaintyCurveName, and uncertaintyZonesName.

Referenced by produce().

                                                                                                                     {
  edm::ESHandle<FFTJetLookupTableSequence> h = esLoader.load(calibTableRecord, iSetup);
  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 64 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

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

operator=()

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

delete

produce()

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

overrideprotected

Definition at line 139 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 77 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

calibrationCurveName

std::string FFTJetPileupEstimator::calibrationCurveName

private

Definition at line 96 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

calibTableCategory

std::string FFTJetPileupEstimator::calibTableCategory

private

Definition at line 94 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

calibTableRecord

std::string FFTJetPileupEstimator::calibTableRecord

private

Definition at line 93 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB(), and FFTJetPileupEstimator().

cdfvalue

double FFTJetPileupEstimator::cdfvalue

private

Definition at line 73 of file FFTJetPileupEstimator.cc.

Referenced by produce().

esLoader

FFTJetLookupTableSequenceLoader FFTJetPileupEstimator::esLoader

private

Definition at line 100 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB(), and FFTJetPileupEstimator().

filterNumber

unsigned FFTJetPileupEstimator::filterNumber

private

Definition at line 75 of file FFTJetPileupEstimator.cc.

Referenced by produce().

inputLabel

edm::InputTag FFTJetPileupEstimator::inputLabel

private

Definition at line 69 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

inputToken

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

private

Definition at line 70 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator(), and produce().

loadCalibFromDB

bool FFTJetPileupEstimator::loadCalibFromDB

private

Definition at line 98 of file FFTJetPileupEstimator.cc.

Referenced by produce().

outputLabel

std::string FFTJetPileupEstimator::outputLabel

private

Definition at line 72 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator(), and produce().

ptToDensityFactor

double FFTJetPileupEstimator::ptToDensityFactor

private

Definition at line 74 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromConfig(), and calibrateFromDB().

uncertaintyCurve

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

private

Definition at line 78 of file FFTJetPileupEstimator.cc.

Referenced by FFTJetPileupEstimator().

uncertaintyCurveName

std::string FFTJetPileupEstimator::uncertaintyCurveName

private

Definition at line 97 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().

uncertaintyZones

std::vector<double> FFTJetPileupEstimator::uncertaintyZones

private

Definition at line 76 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromConfig().

uncertaintyZonesName

std::string FFTJetPileupEstimator::uncertaintyZonesName

private

Definition at line 95 of file FFTJetPileupEstimator.cc.

Referenced by calibrateFromDB().