#include <HLTJetHFCleaner.h>

Inheritance diagram for HLTJetHFCleaner< JetType >:

Public Types
typedef std::vector< JetType >	JetCollection

typedef edm::Ref< JetCollection >	JetRef

Public Types inherited from edm::global::EDProducerBase
typedef EDProducerBase	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

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

	~HLTJetHFCleaner () override=default

Public Member Functions inherited from edm::global::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

EDProducer &	operator= (const EDProducer &)=delete

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

bool	wantsStreamLuminosityBlocks () const final

bool	wantsStreamRuns () const final

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

ModuleDescription const &	moduleDescription () const

	~EDProducerBase () 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

std::vector< bool > const &	recordProvenanceList () 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)

TypeLabelList const &	typeLabelList () const
	used by the fwk to register the list of products of this module More...

	~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

std::vector< ESProxyIndex > const &	esGetTokenIndicesVector (edm::Transition iTrans) const

std::vector< ESRecordIndex > const &	esGetTokenRecordIndicesVector (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::array< std::vector< ModuleDescription const > , NumBranchTypes > &modulesAll, std::vector< ModuleProcessName > &modulesInPreviousProcesses, 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	selectInputProcessBlocks (ProductRegistry const &productRegistry, ProcessBlockHelperBase const &processBlockHelperBase)

ProductResolverIndexAndSkipBit	uncheckedIndexFrom (EDGetToken) const

void	updateLookup (BranchType iBranchType, ProductResolverIndexHelper const &, bool iPrefetchMayGet)

void	updateLookup (eventsetup::ESRecordsToProxyIndices const &)

virtual	~EDConsumerBase () noexcept(false)

Static Public Member Functions
static void	fillDescriptions (edm::ConfigurationDescriptions &descriptions)

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

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

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

Private Attributes
const bool	applySigmaEtaPhiCornerCut_

const bool	applySigmaEtaPhiCut_

const bool	applyStripSizeCut_

const float	centralEtaStripSizeMax_

const edm::EDGetTokenT< edm::ValueMap< int > >	centralEtaStripSizeToken_

const float	cornerCutSigmaEtaEta_

const float	cornerCutSigmaPhiPhi_

const float	dphiJetMetMin_

const float	jetEtaMax_

const float	jetEtaMin_

const float	jetPtMin_

const edm::EDGetTokenT< std::vector< JetType > >	jetToken_

const edm::EDGetTokenT< edm::View< reco::MET > >	metToken_

const edm::EDGetTokenT< edm::ValueMap< float > >	sigmaEtaEtaToken_

const float	sigmaEtaPhiDiffMax_

const edm::EDGetTokenT< edm::ValueMap< float > >	sigmaPhiPhiToken_

Additional Inherited Members
Protected Member Functions inherited from edm::ProducerBase
template<Transition Tr = Transition::Event>
auto	produces (std::string instanceName) noexcept
	declare what type of product will make and with which optional label More...

template<Transition B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<BranchType B>
BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

BranchAliasSetter	produces (const TypeID &id, std::string instanceName=std::string(), bool recordProvenance=true)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<class ProductType >
BranchAliasSetterT< ProductType >	produces ()

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , BranchType B>
BranchAliasSetterT< ProductType >	produces ()

template<class ProductType >
BranchAliasSetterT< ProductType >	produces (std::string instanceName)

template<typename ProductType , Transition B>
BranchAliasSetterT< ProductType >	produces ()

template<Transition Tr = Transition::Event>
auto	produces () noexcept

ProducesCollector	producesCollector ()

Protected Member Functions inherited from edm::EDConsumerBase
template<typename ProductType , BranchType B = InEvent>
EDGetTokenT< ProductType >	consumes (edm::InputTag const &tag)

template<BranchType B = InEvent>
EDConsumerBaseAdaptor< B >	consumes (edm::InputTag tag) noexcept

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<Transition Tr = Transition::Event>
constexpr auto	esConsumes ()

template<Transition Tr = Transition::Event>
auto	esConsumes (ESInputTag tag)

template<Transition Tr = Transition::Event>
ESGetTokenGeneric	esConsumes (eventsetup::EventSetupRecordKey const &iRecord, eventsetup::DataKey const &iKey)
	Used with EventSetupRecord::doGet. More...

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)

void	resetItemsToGetFrom (BranchType iType)

Detailed Description

template<typename JetType>
class HLTJetHFCleaner< JetType >

Description: Cleaning module that produces a cleaned set of jets after applying forward jet cuts.

Implementation: This module creates a new HF-cleaned jet collection by skimming out the forward jets that fail the forward jet cuts. Only the forward high pt jets (|eta| > etaMin_ & pt > jetPtMin_) are considered for the cuts. The cuts are based on the following HF shape variables: sigmaEtaEta, sigmaPhiPhi and centralStripSize.

This module applies the following cuts to such jets: sigmaEtaEta - sigmaPhiPhi <= sigmaEtaPhiDiffMax_ centralStripSize <= centralEtaStripSizeMax_

In addition, forward jets in the corner-region phase space of sigmaEtaEta-sigmaPhiPhi phase space, such that: (sigmaEtaEta < cornerCutSigmaEtaEta_) & (sigmaPhiPhi < cornerCutSigmaPhiPhi_) the jets will be discarded as well.

All cuts (and whether to apply the cuts) can be configured using the PSet interface of this module.

Definition at line 52 of file HLTJetHFCleaner.h.

Member Typedef Documentation

◆ JetCollection

template<typename JetType >

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

Definition at line 54 of file HLTJetHFCleaner.h.

◆ JetRef

template<typename JetType >

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

Definition at line 55 of file HLTJetHFCleaner.h.

Constructor & Destructor Documentation

◆ HLTJetHFCleaner()

template<typename JetType >

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

explicit

Definition at line 89 of file HLTJetHFCleaner.h.

     : jetToken_(consumes(iConfig.getParameter<edm::InputTag>("jets"))),
       metToken_(consumes(iConfig.getParameter<edm::InputTag>("mets"))),
       sigmaEtaEtaToken_(consumes(iConfig.getParameter<edm::InputTag>("sigmaEtaEta"))),
       sigmaPhiPhiToken_(consumes(iConfig.getParameter<edm::InputTag>("sigmaPhiPhi"))),
       centralEtaStripSizeToken_(consumes(iConfig.getParameter<edm::InputTag>("centralEtaStripSize"))),
       jetPtMin_(iConfig.getParameter<double>("jetPtMin")),
       dphiJetMetMin_(iConfig.getParameter<double>("dphiJetMetMin")),
       jetEtaMin_(iConfig.getParameter<double>("jetEtaMin")),
       jetEtaMax_(iConfig.getParameter<double>("jetEtaMax")),
       sigmaEtaPhiDiffMax_(iConfig.getParameter<double>("sigmaEtaPhiDiffMax")),
       centralEtaStripSizeMax_(iConfig.getParameter<int>("centralEtaStripSizeMax")),
       cornerCutSigmaEtaEta_(iConfig.getParameter<double>("cornerCutSigmaEtaEta")),
       cornerCutSigmaPhiPhi_(iConfig.getParameter<double>("cornerCutSigmaPhiPhi")),
       applySigmaEtaPhiCornerCut_(iConfig.getParameter<bool>("applySigmaEtaPhiCornerCut")),
       applySigmaEtaPhiCut_(iConfig.getParameter<bool>("applySigmaEtaPhiCut")),
       applyStripSizeCut_(iConfig.getParameter<bool>("applyStripSizeCut")) {
   produces<JetCollection>();
 }

◆ ~HLTJetHFCleaner()

template<typename JetType >

HLTJetHFCleaner< JetType >::~HLTJetHFCleaner ( )

overridedefault

Member Function Documentation

◆ fillDescriptions()

template<typename JetType >

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

static

Definition at line 188 of file HLTJetHFCleaner.h.

References edm::ConfigurationDescriptions::addWithDefaultLabel(), submitPVResolutionJobs::desc, and HLT_2022v12_cff::InputTag.

                                                                                           {
   edm::ParameterSetDescription desc;
   desc.add<edm::InputTag>("jets", edm::InputTag("hltAK4PFJetsTightIDCorrected"))->setComment("Input jet collection.");
   desc.add<edm::InputTag>("mets", edm::InputTag("hltMet"))->setComment("Input MET collection.");
   desc.add<edm::InputTag>("sigmaEtaEta", edm::InputTag("hltHFJetShowerShape", "sigmaEtaEta"))
       ->setComment("Input collection which stores the sigmaEtaEta values per jet.");
   desc.add<edm::InputTag>("sigmaPhiPhi", edm::InputTag("hltHFJetShowerShape", "sigmaPhiPhi"))
       ->setComment("Input collection which stores the sigmaPhiPhis values per jet.");
   desc.add<edm::InputTag>("centralEtaStripSize", edm::InputTag("hltHFJetShowerShape", "centralEtaStripSize"))
       ->setComment("Input collection which stores the central strip size values per jet.");
   desc.add<double>("jetPtMin", 100)->setComment("The minimum pt value for a jet such that the cuts will be applied.");
   desc.add<double>("dphiJetMetMin", 2.5)
       ->setComment(
           "The minimum value for deltaPhi between jet and MET, such that the cuts will be applied to a given jet.");
   desc.add<double>("jetEtaMin", 2.9)->setComment("Minimum value of jet |eta| for which the cuts will be applied.");
   desc.add<double>("jetEtaMax", 5.0)->setComment("Maximum value of jet |eta| for which the cuts will be applied.");
   desc.add<double>("sigmaEtaPhiDiffMax", 0.05)
       ->setComment("Determines the threshold in the following cut: sigmaEtaEta-sigmaPhiPhi <= X");
   desc.add<double>("cornerCutSigmaEtaEta", 0.02)
       ->setComment(
           "Corner cut value for sigmaEtaEta. Jets will be cut if both sigmaEtaEta and sigmaPhiPhi are lower than the "
           "corner value.");
   desc.add<double>("cornerCutSigmaPhiPhi", 0.02)
       ->setComment(
           "Corner cut value for sigmaPhiPhi. Jets will be cut if both sigmaEtaEta and sigmaPhiPhi are lower than the "
           "corner value.");
   desc.add<int>("centralEtaStripSizeMax", 2)
       ->setComment("Determines the threshold in the following cut: centralEtaStripSize <= X");
   desc.add<bool>("applySigmaEtaPhiCornerCut", true)->setComment("Boolean specifying whether to apply the corner cut.");
   desc.add<bool>("applySigmaEtaPhiCut", true)
       ->setComment("Boolean specifying whether to apply the sigmaEtaEta-sigmaPhiPhi cut.");
   desc.add<bool>("applyStripSizeCut", true)
       ->setComment("Boolean specifying whether to apply the centralEtaStripSize cut.");
   descriptions.addWithDefaultLabel(desc);
 }

◆ produce()

template<typename JetType >

void HLTJetHFCleaner< JetType >::produce	(	edm::StreamID	,
		edm::Event &	iEvent,
		const edm::EventSetup &
	)		const

overrideprivatevirtual

Implements edm::global::EDProducerBase.

Definition at line 110 of file HLTJetHFCleaner.h.

References funct::abs(), reco::deltaPhi(), Exception, iEvent, metsig::jet, PDWG_EXODelayedJetMET_cff::jets, singleTopDQM_cfi::mets, eostools::move(), or, HLT_2022v12_cff::sigmaEtaEta, HLT_2022v12_cff::sigmaPhiPhi, and parallelization::uint.

                                                                                                 {
   auto const jets = iEvent.getHandle(jetToken_);
   auto const& mets = iEvent.get(metToken_);
 
   // The set of cleaned jets
   auto cleaned_jets = std::make_unique<JetCollection>();
   cleaned_jets->reserve(jets->size());
 
   // Check if length of the MET vector is 1, throw exception otherwise
   if (mets.size() != 1) {
     throw cms::Exception("ComparisonFailure") << "Size of reco::MET collection is different from 1";
   }
   auto const met_phi = mets.front().phi();
 
   // HF shape variables gathered from valueMaps
   // Normally, these valueMaps are the output of the HFJetShowerShape module:
   // https://github.com/cms-sw/cmssw/blob/master/RecoJets/JetProducers/plugins/HFJetShowerShape.cc
   auto const& sigmaEtaEtas = iEvent.get(sigmaEtaEtaToken_);
   auto const& sigmaPhiPhis = iEvent.get(sigmaPhiPhiToken_);
   auto const& centralEtaStripSizes = iEvent.get(centralEtaStripSizeToken_);
 
   // Loop over the jets and do cleaning
   for (uint ijet = 0; ijet < jets->size(); ijet++) {
     auto const jet = (*jets)[ijet];
     auto const withinEtaRange = (std::abs(jet.eta()) < jetEtaMax_) and (std::abs(jet.eta()) > jetEtaMin_);
     // Cuts are applied to jets that are back to back with MET
     if (std::abs(reco::deltaPhi(jet.phi(), met_phi)) <= dphiJetMetMin_) {
       cleaned_jets->emplace_back(jet);
       continue;
     }
     // If the jet is outside the range that we're interested in,
     // append it to the cleaned jets collection and continue
     if ((jet.pt() < jetPtMin_) or (!withinEtaRange)) {
       cleaned_jets->emplace_back(jet);
       continue;
     }
 
     JetRef const jetRef(jets, ijet);
 
     // Cuts related to eta and phi width of HF showers:
     // Sigma eta-phi based cut + central strip size cut
     // We'll apply the sigma eta+phi dependent cut only if requested via the config file
     if (applySigmaEtaPhiCut_) {
       // Sigma eta eta and sigma phi phi
       auto const sigmaEtaEta = sigmaEtaEtas[jetRef];
       auto const sigmaPhiPhi = sigmaPhiPhis[jetRef];
 
       // Check if sigma eta eta and sigma phi phi are both set to -1.
       // If this is the case, we can skip the jet without evaluating any mask.
       if ((sigmaEtaEta < 0) and (sigmaPhiPhi < 0)) {
         cleaned_jets->emplace_back(jet);
         continue;
       }
 
       auto passSigmaEtaPhiCut = (sigmaEtaEta - sigmaPhiPhi) <= sigmaEtaPhiDiffMax_;
 
       if (applySigmaEtaPhiCornerCut_) {
         auto const inCorner = (sigmaEtaEta < cornerCutSigmaEtaEta_) and (sigmaPhiPhi < cornerCutSigmaPhiPhi_);
         passSigmaEtaPhiCut &= !inCorner;
       }
       if (!passSigmaEtaPhiCut) {
         continue;
       }
     }
 
     // Cut related to central strip size
     if (applyStripSizeCut_ and (centralEtaStripSizes[jetRef] > centralEtaStripSizeMax_)) {
       continue;
     }
 
     cleaned_jets->emplace_back(jet);
   }
 
   iEvent.put(std::move(cleaned_jets));
 }

Member Data Documentation

◆ applySigmaEtaPhiCornerCut_

template<typename JetType >

const bool HLTJetHFCleaner< JetType >::applySigmaEtaPhiCornerCut_

private

Definition at line 83 of file HLTJetHFCleaner.h.

◆ applySigmaEtaPhiCut_

template<typename JetType >

const bool HLTJetHFCleaner< JetType >::applySigmaEtaPhiCut_

private

Definition at line 84 of file HLTJetHFCleaner.h.

◆ applyStripSizeCut_

template<typename JetType >

const bool HLTJetHFCleaner< JetType >::applyStripSizeCut_

private

Definition at line 85 of file HLTJetHFCleaner.h.

◆ centralEtaStripSizeMax_

template<typename JetType >

const float HLTJetHFCleaner< JetType >::centralEtaStripSizeMax_

private

Definition at line 80 of file HLTJetHFCleaner.h.

◆ centralEtaStripSizeToken_

template<typename JetType >

const edm::EDGetTokenT<edm::ValueMap<int> > HLTJetHFCleaner< JetType >::centralEtaStripSizeToken_

private

Definition at line 69 of file HLTJetHFCleaner.h.

◆ cornerCutSigmaEtaEta_

template<typename JetType >

const float HLTJetHFCleaner< JetType >::cornerCutSigmaEtaEta_

private

Definition at line 81 of file HLTJetHFCleaner.h.

◆ cornerCutSigmaPhiPhi_

template<typename JetType >

const float HLTJetHFCleaner< JetType >::cornerCutSigmaPhiPhi_

private

Definition at line 82 of file HLTJetHFCleaner.h.

◆ dphiJetMetMin_

template<typename JetType >

const float HLTJetHFCleaner< JetType >::dphiJetMetMin_

private

Definition at line 73 of file HLTJetHFCleaner.h.

◆ jetEtaMax_

template<typename JetType >

const float HLTJetHFCleaner< JetType >::jetEtaMax_

private

Definition at line 77 of file HLTJetHFCleaner.h.

◆ jetEtaMin_

template<typename JetType >

const float HLTJetHFCleaner< JetType >::jetEtaMin_

private

Definition at line 76 of file HLTJetHFCleaner.h.

◆ jetPtMin_

template<typename JetType >

const float HLTJetHFCleaner< JetType >::jetPtMin_

private

Definition at line 72 of file HLTJetHFCleaner.h.

◆ jetToken_

template<typename JetType >

const edm::EDGetTokenT<std::vector<JetType> > HLTJetHFCleaner< JetType >::jetToken_

private

Definition at line 64 of file HLTJetHFCleaner.h.

◆ metToken_

template<typename JetType >

const edm::EDGetTokenT<edm::View<reco::MET> > HLTJetHFCleaner< JetType >::metToken_

private

Definition at line 65 of file HLTJetHFCleaner.h.

◆ sigmaEtaEtaToken_

template<typename JetType >

const edm::EDGetTokenT<edm::ValueMap<float> > HLTJetHFCleaner< JetType >::sigmaEtaEtaToken_

private

Definition at line 67 of file HLTJetHFCleaner.h.

◆ sigmaEtaPhiDiffMax_

template<typename JetType >

const float HLTJetHFCleaner< JetType >::sigmaEtaPhiDiffMax_

private

Definition at line 79 of file HLTJetHFCleaner.h.

◆ sigmaPhiPhiToken_

template<typename JetType >

const edm::EDGetTokenT<edm::ValueMap<float> > HLTJetHFCleaner< JetType >::sigmaPhiPhiToken_

private

Definition at line 68 of file HLTJetHFCleaner.h.

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename JetType> class HLTJetHFCleaner< JetType >

Member Typedef Documentation

◆ JetCollection

◆ JetRef

Constructor & Destructor Documentation

◆ HLTJetHFCleaner()

◆ ~HLTJetHFCleaner()

Member Function Documentation

◆ fillDescriptions()

◆ produce()

Member Data Documentation

◆ applySigmaEtaPhiCornerCut_

◆ applySigmaEtaPhiCut_

◆ applyStripSizeCut_

◆ centralEtaStripSizeMax_

◆ centralEtaStripSizeToken_

◆ cornerCutSigmaEtaEta_

◆ cornerCutSigmaPhiPhi_

◆ dphiJetMetMin_

◆ jetEtaMax_

◆ jetEtaMin_

◆ jetPtMin_

◆ jetToken_

◆ metToken_

◆ sigmaEtaEtaToken_

◆ sigmaEtaPhiDiffMax_

◆ sigmaPhiPhiToken_

template<typename JetType>
class HLTJetHFCleaner< JetType >