Produces a ValueMap between TauJetCorrFactors and the originating reco taus. More...

#include "PhysicsTools/PatAlgos/interface/TauJetCorrFactorsProducer.h"

Inheritance diagram for pat::TauJetCorrFactorsProducer:

Classes
struct	payloadMappingType

Public Types
typedef edm::ValueMap < pat::TauJetCorrFactors >	JetCorrFactorsMap
	value map for JetCorrFactors (to be written into the event) More...

Public Types inherited from edm::stream::EDProducer<>
typedef CacheContexts< T...>	CacheTypes

typedef CacheTypes::GlobalCache	GlobalCache

typedef AbilityChecker< T...>	HasAbility

typedef CacheTypes::LuminosityBlockCache	LuminosityBlockCache

typedef LuminosityBlockContextT < LuminosityBlockCache, RunCache, GlobalCache >	LuminosityBlockContext

typedef CacheTypes::LuminosityBlockSummaryCache	LuminosityBlockSummaryCache

typedef CacheTypes::RunCache	RunCache

typedef RunContextT< RunCache, GlobalCache >	RunContext

typedef CacheTypes::RunSummaryCache	RunSummaryCache

Public Types inherited from edm::stream::EDProducerBase
typedef EDProducerAdaptorBase	ModuleType

Public Types inherited from edm::ProducerBase
typedef ProductRegistryHelper::TypeLabelList	TypeLabelList

Public Types inherited from edm::EDConsumerBase
typedef ProductLabels	Labels

Public Member Functions
virtual void	produce (edm::Event &, const edm::EventSetup &) override
	everything that needs to be done per event More...

	TauJetCorrFactorsProducer (const edm::ParameterSet &)
	default constructor More...

	~TauJetCorrFactorsProducer ()
	default destructor More...

Public Member Functions inherited from edm::stream::EDProducer<>
	EDProducer ()=default

Public Member Functions inherited from edm::stream::EDProducerBase
	EDProducerBase ()

ModuleDescription const &	moduleDescription () const

virtual	~EDProducerBase ()

Public Member Functions inherited from edm::ProducerBase
void	callWhenNewProductsRegistered (std::function< void(BranchDescription const &)> const &func)

	ProducerBase ()

void	registerProducts (ProducerBase , ProductRegistry , ModuleDescription const &)

std::function< void(BranchDescription const &)>	registrationCallback () const
	used by the fwk to register list of products More...

virtual	~ProducerBase ()

Public Member Functions inherited from edm::EDConsumerBase
std::vector< ConsumesInfo >	consumesInfo () const

	EDConsumerBase ()

ProductHolderIndexAndSkipBit	indexFrom (EDGetToken, BranchType, TypeID const &) const

void	itemsMayGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

void	itemsToGet (BranchType, std::vector< ProductHolderIndexAndSkipBit > &) const

std::vector < ProductHolderIndexAndSkipBit > const &	itemsToGetFromEvent () const

void	labelsForToken (EDGetToken iToken, Labels &oLabels) const

void	modulesDependentUpon (const std::string &iProcessName, std::vector< const char * > &oModuleLabels) const

void	modulesWhoseProductsAreConsumed (std::vector< ModuleDescription const * > &modules, ProductRegistry const &preg, std::map< std::string, ModuleDescription const * > const &labelsToDesc, std::string const &processName) const

bool	registeredToConsume (ProductHolderIndex, bool, BranchType) const

bool	registeredToConsumeMany (TypeID const &, BranchType) const

void	updateLookup (BranchType iBranchType, ProductHolderIndexHelper const &)

virtual	~EDConsumerBase ()

Private Types
typedef std::vector< int >	vint
	mapping of reconstructed tau decay modes to payloads More...

typedef std::vector< std::string >	vstring
	jec levels More...

Private Member Functions
float	evaluate (edm::View< reco::BaseTau >::const_iterator &, boost::shared_ptr< FactorizedJetCorrector > &, int)
	evaluate jet correction factor up to a given level More...

std::vector < JetCorrectorParameters >	params (const JetCorrectorParametersCollection &, const std::vector< std::string > &) const
	return the jec parameters as input to the FactorizedJetCorrector for different flavors More...

Private Attributes
std::string	defaultPayload_

vstring	levels_

std::string	moduleLabel_
	python label of this TauJetCorrFactorsProducer module More...

std::vector< payloadMappingType >	payloadMappings_

edm::EDGetTokenT< edm::View < reco::BaseTau > >	srcToken_
	input tau-jet collection More...

Additional Inherited Members
Static Public Member Functions inherited from edm::stream::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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)

Detailed Description

Produces a ValueMap between TauJetCorrFactors and the originating reco taus.

The TauJetCorrFactorsProducer produces a set of tau-jet energy correction factors, defined in the class pat::TauJetCorrFactors. This vector is linked to the originating reco taus through an edm::ValueMap. The initializing parameters of the module can be found in the recoLayer1/tauJetCorrFactors_cfi.py of the PatAlgos package. In the standard PAT workflow the module has to be run before the creation of the pat::Tau. The edm::ValueMap will then be embedded into the pat::Tau.

Jets corrected up to a given correction level can then be accessed via the pat::Tau member function correctedJet. For more details have a look into the class description of the pat::Tau.

Definition at line 38 of file TauJetCorrFactorsProducer.h.

Member Typedef Documentation

typedef edm::ValueMap<pat::TauJetCorrFactors> pat::TauJetCorrFactorsProducer::JetCorrFactorsMap

value map for JetCorrFactors (to be written into the event)

Definition at line 42 of file TauJetCorrFactorsProducer.h.

typedef std::vector<int> pat::TauJetCorrFactorsProducer::vint

private

mapping of reconstructed tau decay modes to payloads

Definition at line 68 of file TauJetCorrFactorsProducer.h.

typedef std::vector<std::string> pat::TauJetCorrFactorsProducer::vstring

private

jec levels

Definition at line 88 of file TauJetCorrFactorsProducer.h.

Constructor & Destructor Documentation

TauJetCorrFactorsProducer::TauJetCorrFactorsProducer ( const edm::ParameterSet & cfg )

explicit

default constructor

Definition at line 15 of file TauJetCorrFactorsProducer.cc.

References pat::TauJetCorrFactorsProducer::payloadMappingType::decayModes_, defaultPayload_, edm::ParameterSet::getParameter(), Parameters::parameters, pat::TauJetCorrFactorsProducer::payloadMappingType::payload_, payloadMappings_, and AlCaHLTBitMon_QueryRunRegistry::string.

   : moduleLabel_(cfg.getParameter<std::string>("@module_label")),
     srcToken_(consumes<edm::View<reco::BaseTau> >(cfg.getParameter<edm::InputTag>("src"))),
     levels_(cfg.getParameter<std::vector<std::string> >("levels"))
 {
   typedef std::vector<edm::ParameterSet> vParameterSet;
   vParameterSet parameters = cfg.getParameter<vParameterSet>("parameters");
   for ( vParameterSet::const_iterator param = parameters.begin();
     param != parameters.end(); ++param ) {
     payloadMappingType payloadMapping;
 
     payloadMapping.payload_ = param->getParameter<std::string>("payload");
 
     vstring decayModes_string = param->getParameter<vstring>("decayModes");
     for ( vstring::const_iterator decayMode = decayModes_string.begin();
       decayMode != decayModes_string.end(); ++decayMode ) {
       if ( (*decayMode) == "*" ) {
     defaultPayload_ = payloadMapping.payload_;
       } else {
     payloadMapping.decayModes_.push_back(atoi(decayMode->data()));
       }
     }
 
     if ( payloadMapping.decayModes_.size() > 0 ) payloadMappings_.push_back(payloadMapping);
   }
 
   produces<TauJetCorrFactorsMap>();
 }

pat::TauJetCorrFactorsProducer::~TauJetCorrFactorsProducer ( )

inline

default destructor

Definition at line 48 of file TauJetCorrFactorsProducer.h.

48 {};

Member Function Documentation

float TauJetCorrFactorsProducer::evaluate	(	edm::View< reco::BaseTau >::const_iterator &	tauJet,
		boost::shared_ptr< FactorizedJetCorrector > &	corrector,
		int	corrLevel
	)

private

evaluate jet correction factor up to a given level

Definition at line 57 of file TauJetCorrFactorsProducer.cc.

Referenced by produce().

 {
   corrector->setJetEta(tauJet->eta());
   corrector->setJetPt(tauJet->pt());
   corrector->setJetE(tauJet->energy());
   return corrector->getSubCorrections()[corrLevel];
 }

std::vector< JetCorrectorParameters > TauJetCorrFactorsProducer::params	(	const JetCorrectorParametersCollection &	jecParameters,
		const std::vector< std::string > &	levels
	)		const

private

return the jec parameters as input to the FactorizedJetCorrector for different flavors

Definition at line 45 of file TauJetCorrFactorsProducer.cc.

References JetCorrectorParametersCollection::push_back().

Referenced by produce().

 {
   std::vector<JetCorrectorParameters> retVal;
   for ( std::vector<std::string>::const_iterator corrLevel = levels.begin();
     corrLevel != levels.end(); ++corrLevel ) {
     const JetCorrectorParameters& jecParameter_level = jecParameters[*corrLevel];
     retVal.push_back(jecParameter_level);
   }
   return retVal;
 }

void TauJetCorrFactorsProducer::produce	(	edm::Event &	evt,
		const edm::EventSetup &	es
	)

overridevirtual

everything that needs to be done per event

Implements edm::stream::EDProducerBase.

Definition at line 67 of file TauJetCorrFactorsProducer.cc.

References mvaPFMET_cff::corrector, reco::PFTau::decayMode(), defaultPayload_, evaluate(), edm::helper::Filler< Map >::fill(), edm::EventSetup::get(), edm::Event::getByToken(), customizeTrackingMonitorSeedNumber::idx, edm::helper::Filler< Map >::insert(), patTestJEC_cfi::jec, levels_, moduleLabel_, params(), payloadMappings_, edm::Event::put(), srcToken_, and AlCaHLTBitMon_QueryRunRegistry::string.

 {
   // get tau-jet collection from the event
   edm::Handle<edm::View<reco::BaseTau> > tauJets;
   evt.getByToken(srcToken_, tauJets);
 
   typedef boost::shared_ptr<FactorizedJetCorrector> FactorizedJetCorrectorPtr;
   std::map<std::string, FactorizedJetCorrectorPtr> correctorMapping;
 
   // fill the tauJetCorrFactors
   std::vector<TauJetCorrFactors> tauJetCorrections;
   for ( edm::View<reco::BaseTau>::const_iterator tauJet = tauJets->begin();
     tauJet != tauJets->end(); ++tauJet ) {
 
     // the TauJetCorrFactors::CorrectionFactor is a std::pair<std::string, float>
     // the string corresponds to the label of the correction level, the float to the tau-jet energy correction factor.
     // The first correction level is predefined with label 'Uncorrected'. The correction factor is 1.
     std::vector<TauJetCorrFactors::CorrectionFactor> jec;
     jec.push_back(std::make_pair(std::string("Uncorrected"), 1.0));
 
     if ( levels_.size() == 0 )
       throw cms::Exception("No JECFactors")
     << "You request to create a jetCorrFactors object with no JEC Levels indicated. \n"
     << "This makes no sense, either you should correct this or drop the module from \n"
     << "the sequence.";
 
     std::string payload = defaultPayload_;
     if ( dynamic_cast<const reco::PFTau*>(&(*tauJet)) ) {
       const reco::PFTau* pfTauJet = dynamic_cast<const reco::PFTau*>(&(*tauJet));
       for ( std::vector<payloadMappingType>::const_iterator payloadMapping = payloadMappings_.begin();
         payloadMapping != payloadMappings_.end(); ++payloadMapping ) {
     for( vint::const_iterator decayMode = payloadMapping->decayModes_.begin();
          decayMode != payloadMapping->decayModes_.end(); ++decayMode ) {
       if ( pfTauJet->decayMode() == (*decayMode) ) payload = payloadMapping->payload_;
     }
       }
     }
 
     // retrieve JEC parameters from the DB and build a new corrector,
     // in case it does not exist already for current payload
     if ( correctorMapping.find(payload) == correctorMapping.end() ) {
       edm::ESHandle<JetCorrectorParametersCollection> jecParameters;
       es.get<JetCorrectionsRecord>().get(payload, jecParameters);
 
       correctorMapping[payload] = FactorizedJetCorrectorPtr(new FactorizedJetCorrector(params(*jecParameters, levels_)));
     }
     FactorizedJetCorrectorPtr& corrector = correctorMapping[payload];
 
     // evaluate tau-jet energy corrections
     size_t numLevels = levels_.size();
     for ( size_t idx = 0; idx < numLevels; ++idx ) {
       const std::string& corrLevel = levels_[idx];
 
       float jecFactor = evaluate(tauJet, corrector, idx);
 
       // push back the set of JetCorrFactors: the first entry corresponds to the label
       // of the correction level. The second parameter corresponds to the jec factor.
       // In the default configuration the CorrectionFactor will look like this:
       //   'Uncorrected' : 1 ;
       //   'L2Relative'  : x ;
       //   'L3Absolute'  : x ;
       jec.push_back(std::make_pair(corrLevel.substr(0, corrLevel.find("_")), jecFactor));
     }
 
     // create the actual object with the scale factors we want the valuemap to refer to
     // moduleLabel_ corresponds to the python label of the TauJetCorrFactorsProducer module instance
     TauJetCorrFactors tauJetCorrection(moduleLabel_, jec);
     tauJetCorrections.push_back(tauJetCorrection);
   }
 
   // build the valuemap
   std::auto_ptr<TauJetCorrFactorsMap> jecMapping(new TauJetCorrFactorsMap());
   TauJetCorrFactorsMap::Filler filler(*jecMapping);
   // tauJets and tauJetCorrections vectors have their indices aligned by construction
   filler.insert(tauJets, tauJetCorrections.begin(), tauJetCorrections.end());
   filler.fill(); // do the actual filling
 
   // add valuemap to the event
   evt.put(jecMapping);
 }