Produces a collection of jets cleaned against leading leptons. More...

#include <HLTJetsCleanedFromLeadingLeptons.h>

Inheritance diagram for HLTJetsCleanedFromLeadingLeptons< JetType >:

Classes
class	EtaPhiE
	An auxiliary class to store momentum parametrised in eta, phi, and energy. More...

Public Types
typedef std::vector< JetType >	JetCollection

typedef std::vector< edm::RefVector< JetCollection, JetType, edm::refhelper::FindUsingAdvance< JetCollection, JetType > > >	JetCollectionVector

typedef edm::Ref< JetCollection >	JetRef

typedef edm::RefVector< JetCollection >	JetRefVector

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
	HLTJetsCleanedFromLeadingLeptons (edm::ParameterSet const &iConfig)
	Constructor. More...

virtual void	produce (edm::Event &iEvent, edm::EventSetup const &iSetup)
	Produces jets cleaned against leptons. 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)

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

EDConsumerBase &	operator= (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)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)
	Describes configuration of the plugin. More...

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Attributes
edm::EDGetTokenT< std::vector< JetType > >	jetToken
	Token to access a collection of jets. More...

edm::EDGetTokenT< trigger::TriggerFilterObjectWithRefs >	leptonToken
	Token to identify a collection of leptons that pass an HLT filter. More...

double	minDeltaR2
	A square of the minimal allowed angular separation between a lepton and a jet. More...

unsigned	numLeptons
	Number of leading leptons against which the jets are cleaned. More...

Additional Inherited Members
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

template<typename JetType>
class HLTJetsCleanedFromLeadingLeptons< JetType >

Produces a collection of jets cleaned against leading leptons.

Author: Andrey Popov, inspired by code by Lukasz Kreczko Leptons (muons or electrons) are read from results of a previous HLT filter. They are ordered in energy, and the user can configure how many leading leptons are used to clean jets. If the requested number is larger than the total number of leptons, all of them are used.

The plugin loops over the given collection of jets and exclude ones that are close to one of the leading leptons. References to surviving jets are stored in the same format as expected by the HLTJetCollectionsFilter plugin.

Definition at line 30 of file HLTJetsCleanedFromLeadingLeptons.h.

Member Typedef Documentation

template<typename JetType >

typedef std::vector<JetType> HLTJetsCleanedFromLeadingLeptons< JetType >::JetCollection

Definition at line 33 of file HLTJetsCleanedFromLeadingLeptons.h.

template<typename JetType >

typedef std::vector<edm::RefVector<JetCollection, JetType, edm::refhelper::FindUsingAdvance<JetCollection, JetType> > > HLTJetsCleanedFromLeadingLeptons< JetType >::JetCollectionVector

Definition at line 38 of file HLTJetsCleanedFromLeadingLeptons.h.

template<typename JetType >

typedef edm::Ref<JetCollection> HLTJetsCleanedFromLeadingLeptons< JetType >::JetRef

Definition at line 34 of file HLTJetsCleanedFromLeadingLeptons.h.

template<typename JetType >

typedef edm::RefVector<JetCollection> HLTJetsCleanedFromLeadingLeptons< JetType >::JetRefVector

Definition at line 35 of file HLTJetsCleanedFromLeadingLeptons.h.

Constructor & Destructor Documentation

template<typename JetType >

HLTJetsCleanedFromLeadingLeptons< JetType >::HLTJetsCleanedFromLeadingLeptons ( edm::ParameterSet const & iConfig )

Constructor.

Definition at line 155 of file HLTJetsCleanedFromLeadingLeptons.h.

References edm::ParameterSet::getParameter(), HLTJetsCleanedFromLeadingLeptons< JetType >::jetToken, and HLTJetsCleanedFromLeadingLeptons< JetType >::leptonToken.

                                 :
     minDeltaR2(std::pow(iConfig.getParameter<double>("minDeltaR"), 2)),
     numLeptons(iConfig.getParameter<unsigned>("numLeptons"))
 {
     leptonToken = consumes<trigger::TriggerFilterObjectWithRefs>(
      iConfig.getParameter<edm::InputTag>("leptons"));
     jetToken = consumes<std::vector<JetType>>(iConfig.getParameter<edm::InputTag>("jets"));
     
     produces<JetCollectionVector>();
 }

Member Function Documentation

template<typename JetType >

void HLTJetsCleanedFromLeadingLeptons< JetType >::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Describes configuration of the plugin.

Definition at line 169 of file HLTJetsCleanedFromLeadingLeptons.h.

References edm::ConfigurationDescriptions::add(), edm::ParameterSetDescription::add(), and defaultModuleLabel().

 {
     edm::ParameterSetDescription desc;
     
     desc.add<edm::InputTag>("leptons", edm::InputTag("triggerFilterObjectWithRefs"))->
      setComment("A collection of leptons that pass an HLT filter");
     desc.add<edm::InputTag>("jets", edm::InputTag("jetCollection"))->
      setComment("A collection of jets");
     desc.add<double>("minDeltaR", 0.3)->
      setComment("Minimal allowed angular separation between a jet and a lepton");
     desc.add<unsigned>("numLeptons", 1)->
      setComment("Number of leading leptons against which the jets are cleaned");
     
     descriptions.add(defaultModuleLabel<HLTJetsCleanedFromLeadingLeptons<JetType>>(), desc);
 }

template<typename JetType >

void HLTJetsCleanedFromLeadingLeptons< JetType >::produce	(	edm::Event &	iEvent,
		edm::EventSetup const &	iSetup
	)

virtual

Produces jets cleaned against leptons.

Implements edm::stream::EDProducerBase.

Definition at line 188 of file HLTJetsCleanedFromLeadingLeptons.h.

References fastPrimaryVertexProducer_cfi::clusters, reco::deltaR2(), genericTrackCleaner_cfi::electrons, SimCluster::energy(), SimCluster::eta(), edm::Event::getByToken(), trigger::TriggerRefsCollections::getObjects(), fwrapper::jets, HLTJetsCleanedFromLeadingLeptons< JetType >::jetToken, HLTJetsCleanedFromLeadingLeptons< JetType >::leptonToken, HLTJetsCleanedFromLeadingLeptons< JetType >::minDeltaR2, eostools::move(), electronCleaner_cfi::muons, HLTJetsCleanedFromLeadingLeptons< JetType >::numLeptons, muon::overlap(), SimCluster::phi(), jetCleaner_cfi::photons, edm::RefVector< C, T, F >::push_back(), edm::Event::put(), SimDataFormats::CaloAnalysis::sc, trigger::TriggerCluster, trigger::TriggerElectron, trigger::TriggerMuon, and trigger::TriggerPhoton.

 {
     // Read results of the lepton filter
     edm::Handle<trigger::TriggerFilterObjectWithRefs> filterOutput;
     iEvent.getByToken(leptonToken, filterOutput);
     
     // Momenta of the leptons that passed the filter will be pushed into a vector
     std::vector<EtaPhiE> leptonMomenta;
     
     
     // First, assume these are muons and try to store their momenta
     trigger::VRmuon muons;
     filterOutput->getObjects(trigger::TriggerMuon, muons);
     
     for (auto const &muRef: muons)  // the collection might be empty
         leptonMomenta.emplace_back(muRef->eta(), muRef->phi(), muRef->energy());
     
     
     // Then get the momenta as if these are electrons. Electrons are tricky because they can be
     //stored with three types of trigger objects: TriggerElectron, TriggerPhoton, and
     //TriggerCluster. Try them one by one.
     trigger::VRelectron electrons;
     filterOutput->getObjects(trigger::TriggerElectron, electrons);
     
     for (auto const &eRef: electrons)  // the collection might be empty
     {
         auto const &sc = eRef->superCluster();
         leptonMomenta.emplace_back(sc->eta(), sc->phi(), sc->energy());
     }
     
     trigger::VRphoton photons;
     filterOutput->getObjects(trigger::TriggerPhoton, photons);
     
     for (auto const &eRef: photons)  // the collection might be empty
     {
         auto const &sc = eRef->superCluster();
         leptonMomenta.emplace_back(sc->eta(), sc->phi(), sc->energy());
     }
     
     trigger::VRphoton clusters;
     filterOutput->getObjects(trigger::TriggerCluster, clusters);
     
     for (auto const &eRef: clusters)  // the collection might be empty
     {
         auto const &sc = eRef->superCluster();
         leptonMomenta.emplace_back(sc->eta(), sc->phi(), sc->energy());
     }
     
     
     // Make sure the momenta are sorted
     std::sort(leptonMomenta.rbegin(), leptonMomenta.rend());
     
     
     // Read the source collection of jets
     edm::Handle<JetCollection> jetHandle;
     iEvent.getByToken(jetToken, jetHandle);
     JetCollection const &jets = *jetHandle;
     
     
     // Put references to jets that are not matched to leptons into a dedicated collection
     JetRefVector cleanedJetRefs;
     unsigned const numLeptonsToLoop = std::min<unsigned>(leptonMomenta.size(), numLeptons);
     
     for (unsigned iJet = 0; iJet < jets.size(); ++iJet)
     {
         bool overlap = false;
         
         for (unsigned iLepton = 0; iLepton < numLeptonsToLoop; ++iLepton)
             if (reco::deltaR2(leptonMomenta.at(iLepton), jets.at(iJet)) < minDeltaR2)
             {
                 overlap = true;
                 break;
             }
         
         if (not overlap)
             cleanedJetRefs.push_back(JetRef(jetHandle, iJet));
     }
     
     
     // Store the collection in the event
     std::unique_ptr<JetCollectionVector> product(new JetCollectionVector);
     //^ Have to use the depricated unique_ptr here because this is what edm::Event::put expects
     product->emplace_back(cleanedJetRefs);
     iEvent.put(std::move(product));
 }