#include <L1Trigger/L1CaloTrigger/plugin/Phase1L1TJetProducer.cc>

Inheritance diagram for Phase1L1TJetProducer:

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

template<class Handle >
std::vector< std::vector< edm::Ptr< reco::Candidate > > >	prepareInputsIntoRegions (const Handle triggerPrimitives)

	~Phase1L1TJetProducer () override

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

	EDProducer (const EDProducer &)=delete

SerialTaskQueue *	globalLuminosityBlocksQueue () final

SerialTaskQueue *	globalRunsQueue () final

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

bool	wantsGlobalLuminosityBlocks () const final

bool	wantsGlobalRuns () const final

bool	wantsInputProcessBlocks () const final

bool	wantsProcessBlocks () const final

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

ModuleDescription const &	moduleDescription () const

bool	wantsStreamLuminosityBlocks () const

bool	wantsStreamRuns () 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::one::EDProducerBase
static const std::string &	baseType ()

static void	fillDescriptions (ConfigurationDescriptions &descriptions)

static void	prevalidate (ConfigurationDescriptions &descriptions)

Private Member Functions
reco::CaloJet	buildJetFromSeed (const std::tuple< int, int > &seed) const

std::vector< reco::CaloJet >	buildJetsFromSeeds (const std::vector< std::tuple< int, int >> &seeds) const

std::vector< reco::CaloJet >	buildJetsFromSeedsWithPUSubtraction (const std::vector< std::tuple< int, int >> &seeds, bool killZeroPt) const

l1t::EtSum	computeMET (const double etaCut, l1t::EtSum::EtSumType sumType) const

template<class Container >
void	fillCaloGrid (TH2F &caloGrid, const Container &triggerPrimitives, const unsigned int regionIndex)

std::vector< std::tuple< int, int > >	findSeeds (float seedThreshold) const
	Finds the seeds in the caloGrid, seeds are saved in a vector that contain the index in the TH2F of each seed. More...

std::pair< float, float >	getCandidateDigiEtaPhi (const float eta, const float phi, const unsigned int regionIndex) const

unsigned int	getRegionIndex (const unsigned int phiRegion, const unsigned int etaRegion) const

float	getTowerEnergy (int iEta, int iPhi) const
	Get the energy of a certain tower while correctly handling phi periodicity in case of overflow. More...

template<class Handle >
std::vector< std::vector< reco::CandidatePtr > >	prepareInputsIntoRegions (const Handle triggerPrimitives)

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

std::pair< double, double >	regionEtaPhiLowEdges (const unsigned int regionIndex) const

std::pair< double, double >	regionEtaPhiUpEdges (const unsigned int regionIndex) const

void	subtract9x9Pileup (reco::CaloJet &jet) const

bool	trimTower (const int etaIndex, const int phiIndex) const

Private Attributes
std::unique_ptr< TH2F >	caloGrid_

std::vector< double >	cosPhi_

std::vector< double >	etaBinning_

double	etalsb_

std::vector< double >	etaRegionEdges_

edm::EDGetTokenT< edm::View< reco::Candidate > >	inputCollectionTag_

unsigned int	jetIEtaSize_

unsigned int	jetIPhiSize_

unsigned int	maxInputsPerRegion_

double	metAbsEtaCut_

double	metHFAbsEtaCut_

size_t	nBinsEta_

unsigned int	nBinsPhi_

std::string	outputCollectionName_

double	phiLow_

double	philsb_

std::vector< double >	phiRegionEdges_

double	phiUp_

double	ptlsb_

bool	puSubtraction_

double	seedPtThreshold_

std::vector< double >	sinPhi_

bool	trimmedGrid_

bool	vetoZeroPt_

Additional Inherited Members
Public Types inherited from edm::one::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

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

Description: Produces jets with a phase-1 like sliding window algorithm using a collection of reco::Candidates in input. Also calculates MET from the histogram used to find the jets.

INPUT PARAMETERS ***
etaBinning: vdouble with eta binning (allows non-homogeneous binning in eta)
nBinsPhi: uint32, number of bins in phi
phiLow: double, min phi (typically -pi)
phiUp: double, max phi (typically +pi)
jetIEtaSize: uint32, jet cluster size in ieta
jetIPhiSize: uint32, jet cluster size in iphi
trimmedGrid: Flag (bool) to remove three bins in each corner of grid in jet finding
seedPtThreshold: double, threshold of the seed tower
pt/eta/philsb : lsb of quantities used in firmware implementation
puSubtraction: bool, runs chunky doughnut pile-up subtraction, 9x9 jet only
eta/phiRegionEdges: Boundaries of the input (PF) regions
maxInputsPerRegion: Truncate number of inputes per input (PF) region
sin/cosPhi: Value of sin/cos phi in the middle of each bin of the grid.
met{HF}AbsETaCut: Eta selection of input candidates for calculation of MET
outputCollectionName: string, tag for the output collection
vetoZeroPt: bool, controls whether jets with 0 pt should be save. 
It matters if PU is ON, as you can get negative or zero pt jets after it.
inputCollectionTag: inputtag, collection of reco::candidates used as input to the algo

Definition at line 62 of file Phase1L1TJetProducer.cc.

Constructor & Destructor Documentation

◆ Phase1L1TJetProducer()

Phase1L1TJetProducer::Phase1L1TJetProducer ( const edm::ParameterSet & iConfig )

explicit

Definition at line 165 of file Phase1L1TJetProducer.cc.

References edm::ParameterSet::getParameter().

     :  // getting configuration settings
       inputCollectionTag_{
           consumes<edm::View<reco::Candidate>>(iConfig.getParameter<edm::InputTag>("inputCollectionTag"))},
       etaBinning_(iConfig.getParameter<std::vector<double>>("etaBinning")),
       nBinsEta_(etaBinning_.size() - 1),
       nBinsPhi_(iConfig.getParameter<unsigned int>("nBinsPhi")),
       phiLow_(iConfig.getParameter<double>("phiLow")),
       phiUp_(iConfig.getParameter<double>("phiUp")),
       jetIEtaSize_(iConfig.getParameter<unsigned int>("jetIEtaSize")),
       jetIPhiSize_(iConfig.getParameter<unsigned int>("jetIPhiSize")),
       trimmedGrid_(iConfig.getParameter<bool>("trimmedGrid")),
       seedPtThreshold_(iConfig.getParameter<double>("seedPtThreshold")),
       ptlsb_(iConfig.getParameter<double>("ptlsb")),
       philsb_(iConfig.getParameter<double>("philsb")),
       etalsb_(iConfig.getParameter<double>("etalsb")),
       puSubtraction_(iConfig.getParameter<bool>("puSubtraction")),
       vetoZeroPt_(iConfig.getParameter<bool>("vetoZeroPt")),
       etaRegionEdges_(iConfig.getParameter<std::vector<double>>("etaRegions")),
       phiRegionEdges_(iConfig.getParameter<std::vector<double>>("phiRegions")),
       maxInputsPerRegion_(iConfig.getParameter<unsigned int>("maxInputsPerRegion")),
       sinPhi_(iConfig.getParameter<std::vector<double>>("sinPhi")),
       cosPhi_(iConfig.getParameter<std::vector<double>>("cosPhi")),
       metAbsEtaCut_(iConfig.getParameter<double>("metAbsEtaCut")),
       metHFAbsEtaCut_(iConfig.getParameter<double>("metHFAbsEtaCut")),
       outputCollectionName_(iConfig.getParameter<std::string>("outputCollectionName")) {
   caloGrid_ =
       std::make_unique<TH2F>("caloGrid", "Calorimeter grid", nBinsEta_, etaBinning_.data(), nBinsPhi_, phiLow_, phiUp_);
   caloGrid_->GetXaxis()->SetTitle("#eta");
   caloGrid_->GetYaxis()->SetTitle("#phi");
   produces<std::vector<reco::CaloJet>>(outputCollectionName_).setBranchAlias(outputCollectionName_);
   produces<std::vector<l1t::EtSum>>(outputCollectionName_ + "MET").setBranchAlias(outputCollectionName_ + "MET");
 }

◆ ~Phase1L1TJetProducer()

Phase1L1TJetProducer::~Phase1L1TJetProducer ( )

override

Definition at line 199 of file Phase1L1TJetProducer.cc.

199 {}

Member Function Documentation

◆ buildJetFromSeed()

reco::CaloJet Phase1L1TJetProducer::buildJetFromSeed ( const std::tuple< int, int > & seed ) const

private

Definition at line 361 of file Phase1L1TJetProducer.cc.

References caloGrid_, getTowerEnergy(), L1TowerCalibrationProducer_cfi::iEta, createfilelist::int, metsig::jet, jetIEtaSize_, jetIPhiSize_, fileCollector::seed, trimmedGrid_, and trimTower().

Referenced by buildJetsFromSeeds(), and buildJetsFromSeedsWithPUSubtraction().

                                                                                        {
   int iEta = std::get<0>(seed);
   int iPhi = std::get<1>(seed);
 
   int etaHalfSize = (int)jetIEtaSize_ / 2;
   int phiHalfSize = (int)jetIPhiSize_ / 2;
 
   float ptSum = 0;
   // Scanning through the grid centered on the seed
   for (int etaIndex = -etaHalfSize; etaIndex <= etaHalfSize; etaIndex++) {
     for (int phiIndex = -phiHalfSize; phiIndex <= phiHalfSize; phiIndex++) {
       if (trimmedGrid_) {
         if (trimTower(etaIndex, phiIndex))
           continue;
       }
       ptSum += getTowerEnergy(iEta + etaIndex, iPhi + phiIndex);
     }
   }
 
   // Creating a jet with eta phi centered on the seed and momentum equal to the sum of the pt of the components
   reco::Candidate::PolarLorentzVector ptVector;
   ptVector.SetPt(ptSum);
   ptVector.SetEta(caloGrid_->GetXaxis()->GetBinCenter(iEta));
   ptVector.SetPhi(caloGrid_->GetYaxis()->GetBinCenter(iPhi));
   reco::CaloJet jet;
   jet.setP4(ptVector);
   return jet;
 }

◆ buildJetsFromSeeds()

std::vector< reco::CaloJet > Phase1L1TJetProducer::buildJetsFromSeeds ( const std::vector< std::tuple< int, int >> & seeds ) const

private

Definition at line 406 of file Phase1L1TJetProducer.cc.

References buildJetFromSeed(), metsig::jet, PDWG_EXODelayedJetMET_cff::jets, fileCollector::seed, and DetachedQuadStep_cff::seeds.

Referenced by produce().

                                                       {
   // For each seed take a grid centered on the seed of the size specified by the user
   // Sum the pf in the grid, that will be the pt of the l1t jet. Eta and phi of the jet is taken from the seed.
   std::vector<reco::CaloJet> jets;
   for (const auto& seed : seeds) {
     reco::CaloJet jet = buildJetFromSeed(seed);
     jets.push_back(jet);
   }
   return jets;
 }

◆ buildJetsFromSeedsWithPUSubtraction()

std::vector< reco::CaloJet > Phase1L1TJetProducer::buildJetsFromSeedsWithPUSubtraction	(	const std::vector< std::tuple< int, int >> &	seeds,
		bool	killZeroPt
	)		const

private

Definition at line 390 of file Phase1L1TJetProducer.cc.

References buildJetFromSeed(), metsig::jet, PDWG_EXODelayedJetMET_cff::jets, fileCollector::seed, DetachedQuadStep_cff::seeds, subtract9x9Pileup(), and vetoZeroPt_.

Referenced by produce().

                                                                        {
   // For each seed take a grid centered on the seed of the size specified by the user
   // Sum the pf in the grid, that will be the pt of the l1t jet. Eta and phi of the jet is taken from the seed.
   std::vector<reco::CaloJet> jets;
   for (const auto& seed : seeds) {
     reco::CaloJet jet = buildJetFromSeed(seed);
     subtract9x9Pileup(jet);
     //killing jets with 0 pt
     if ((vetoZeroPt_) && (jet.pt() <= 0))
       continue;
     jets.push_back(jet);
   }
   return jets;
 }

◆ computeMET()

l1t::EtSum Phase1L1TJetProducer::computeMET	(	const double	etaCut,
		l1t::EtSum::EtSumType	sumType
	)		const

private

Definition at line 572 of file Phase1L1TJetProducer.cc.

References caloGrid_, cosPhi_, fftjetproducer_cfi::etaCut, mps_fire::i, DiDispStaMuonMonitor_cfi::pt, ptlsb_, sinPhi_, mathSSE::sqrt(), and pileupReCalc_HLTpaths::trunc.

Referenced by produce().

                                                                                               {
   const auto lowEtaBin = caloGrid_->GetXaxis()->FindBin(-1.0 * etaCut);
   const auto highEtaBin = caloGrid_->GetXaxis()->FindBin(etaCut) - 1;
   const auto phiProjection = caloGrid_->ProjectionY("temp", lowEtaBin, highEtaBin);
 
   // Use digitised quantities when summing to improve agreement with firmware
   int totalDigiPx{0};
   int totalDigiPy{0};
 
   for (int i = 1; i < phiProjection->GetNbinsX() + 1; ++i) {
     double pt = phiProjection->GetBinContent(i);
     totalDigiPx += trunc(floor(pt / ptlsb_) * cosPhi_[i - 1]);
     totalDigiPy += trunc(floor(pt / ptlsb_) * sinPhi_[i - 1]);
   }
 
   double lMET = floor(sqrt(totalDigiPx * totalDigiPx + totalDigiPy * totalDigiPy)) * ptlsb_;
 
   math::PtEtaPhiMLorentzVector lMETVector(lMET, 0, acos(totalDigiPx / (lMET / ptlsb_)), 0);
   l1t::EtSum lMETSum(lMETVector, sumType, 0, 0, 0, 0);
   return lMETSum;
 }

◆ fillCaloGrid()

template<class Container >

void Phase1L1TJetProducer::fillCaloGrid	(	TH2F &	caloGrid,
		const Container &	triggerPrimitives,
		const unsigned int	regionIndex
	)

private

Definition at line 419 of file Phase1L1TJetProducer.cc.

References getCandidateDigiEtaPhi().

                                                                         {
   //Filling the calo grid with the primitives
   for (const auto& primitiveIterator : triggerPrimitives) {
     // Get digitised (floating point with reduced precision) eta and phi
     std::pair<float, float> digi_EtaPhi =
         getCandidateDigiEtaPhi(primitiveIterator->eta(), primitiveIterator->phi(), regionIndex);
 
     caloGrid.Fill(static_cast<float>(digi_EtaPhi.first),
                   static_cast<float>(digi_EtaPhi.second),
                   static_cast<float>(primitiveIterator->pt()));
   }
 }

◆ fillDescriptions()

void Phase1L1TJetProducer::fillDescriptions ( edm::ConfigurationDescriptions & descriptions )

static

Definition at line 488 of file Phase1L1TJetProducer.cc.

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

                                                                                       {
   edm::ParameterSetDescription desc;
   desc.add<edm::InputTag>("inputCollectionTag", edm::InputTag("l1pfCandidates", "Puppi"));
   desc.add<std::vector<double>>("etaBinning");
   desc.add<unsigned int>("nBinsPhi", 72);
   desc.add<double>("phiLow", -M_PI);
   desc.add<double>("phiUp", M_PI);
   desc.add<unsigned int>("jetIEtaSize", 7);
   desc.add<unsigned int>("jetIPhiSize", 7);
   desc.add<bool>("trimmedGrid", false);
   desc.add<double>("seedPtThreshold", 5);
   desc.add<double>("ptlsb", 0.25), desc.add<double>("philsb", 0.0043633231), desc.add<double>("etalsb", 0.0043633231),
       desc.add<bool>("puSubtraction", false);
   desc.add<string>("outputCollectionName", "UncalibratedPhase1L1TJetFromPfCandidates");
   desc.add<bool>("vetoZeroPt", true);
   desc.add<std::vector<double>>("etaRegions");
   desc.add<std::vector<double>>("phiRegions");
   desc.add<unsigned int>("maxInputsPerRegion", 18);
   desc.add<std::vector<double>>("sinPhi");
   desc.add<std::vector<double>>("cosPhi");
   desc.add<double>("metAbsEtaCut", 3);
   desc.add<double>("metHFAbsEtaCut", 5);
   descriptions.add("Phase1L1TJetProducer", desc);
 }

◆ findSeeds()

std::vector< std::tuple< int, int > > Phase1L1TJetProducer::findSeeds ( float seedThreshold ) const

private

Finds the seeds in the caloGrid, seeds are saved in a vector that contain the index in the TH2F of each seed.

Definition at line 306 of file Phase1L1TJetProducer.cc.

References caloGrid_, getTowerEnergy(), L1TowerCalibrationProducer_cfi::iEta, createfilelist::int, jetIEtaSize_, jetIPhiSize_, DetachedQuadStep_cff::seeds, trimmedGrid_, and trimTower().

Referenced by produce().

                                                                                        {
   int nBinsX = caloGrid_->GetNbinsX();
   int nBinsY = caloGrid_->GetNbinsY();
 
   std::vector<std::tuple<int, int>> seeds;
 
   int etaHalfSize = (int)jetIEtaSize_ / 2;
   int phiHalfSize = (int)jetIPhiSize_ / 2;
 
   // for each point of the grid check if it is a local maximum
   // to do so I take a point, and look if is greater than the points around it (in the 9x9 neighborhood)
   // to prevent mutual exclusion, I check greater or equal for points above and right to the one I am considering (including the top-left point)
   // to prevent mutual exclusion, I check greater for points below and left to the one I am considering (including the bottom-right point)
 
   for (int iPhi = 1; iPhi <= nBinsY; iPhi++) {
     for (int iEta = 1; iEta <= nBinsX; iEta++) {
       float centralPt = caloGrid_->GetBinContent(iEta, iPhi);
       if (centralPt < seedThreshold)
         continue;
       bool isLocalMaximum = true;
 
       // Scanning through the grid centered on the seed
       for (int etaIndex = -etaHalfSize; etaIndex <= etaHalfSize; etaIndex++) {
         for (int phiIndex = -phiHalfSize; phiIndex <= phiHalfSize; phiIndex++) {
           if (trimmedGrid_) {
             if (trimTower(etaIndex, phiIndex))
               continue;
           }
 
           if ((etaIndex == 0) && (phiIndex == 0))
             continue;
           if (phiIndex > 0) {
             if (phiIndex > -etaIndex) {
               isLocalMaximum = ((isLocalMaximum) && (centralPt > getTowerEnergy(iEta + etaIndex, iPhi + phiIndex)));
             } else {
               isLocalMaximum = ((isLocalMaximum) && (centralPt >= getTowerEnergy(iEta + etaIndex, iPhi + phiIndex)));
             }
           } else {
             if (phiIndex >= -etaIndex) {
               isLocalMaximum = ((isLocalMaximum) && (centralPt > getTowerEnergy(iEta + etaIndex, iPhi + phiIndex)));
             } else {
               isLocalMaximum = ((isLocalMaximum) && (centralPt >= getTowerEnergy(iEta + etaIndex, iPhi + phiIndex)));
             }
           }
         }
       }
       if (isLocalMaximum) {
         seeds.emplace_back(iEta, iPhi);
       }
     }
   }
 
   return seeds;
 }

◆ getCandidateDigiEtaPhi()

std::pair< float, float > Phase1L1TJetProducer::getCandidateDigiEtaPhi	(	const float	eta,
		const float	phi,
		const unsigned int	regionIndex
	)		const

private

Definition at line 434 of file Phase1L1TJetProducer.cc.

References caloGrid_, PVValHelper::eta, etalsb_, mps_fire::i, phi, philsb_, regionEtaPhiLowEdges(), and regionEtaPhiUpEdges().

Referenced by fillCaloGrid().

                                                                                                            {
   std::pair<double, double> regionLowEdges = regionEtaPhiLowEdges(regionIndex);
 
   int digitisedEta = floor((eta - regionLowEdges.second) / etalsb_);
   int digitisedPhi = floor((phi - regionLowEdges.first) / philsb_);
 
   // If eta or phi is on a bin edge
   // Put in bin above, to match behaviour of HLS
   // Unless it's on the last bin of this pf region
   // Then it is placed in the last bin, not the overflow
   TAxis* etaAxis = caloGrid_->GetXaxis();
   std::pair<double, double> regionUpEdges = regionEtaPhiUpEdges(regionIndex);
   int digiEtaEdgeLastBinUp = floor((regionUpEdges.second - regionLowEdges.second) / etalsb_);
   // If the digi eta is outside the last bin of this pf region
   // Set the digitised quantity so it would be in the last bin
   // These cases could be avoided by sorting input candidates based on digitised eta/phi
   if (digitisedEta >= digiEtaEdgeLastBinUp) {
     digitisedEta = digiEtaEdgeLastBinUp - 1;
   } else {
     for (int i = 0; i < etaAxis->GetNbins(); ++i) {
       if (etaAxis->GetBinUpEdge(i) < regionLowEdges.second)
         continue;
       int digiEdgeBinUp = floor((etaAxis->GetBinUpEdge(i) - regionLowEdges.second) / etalsb_);
       if (digiEdgeBinUp == digitisedEta) {
         digitisedEta += 1;
       }
     }
   }
 
   // Similar for phi
   TAxis* phiAxis = caloGrid_->GetYaxis();
   int digiPhiEdgeLastBinUp = floor((regionUpEdges.first - regionLowEdges.first) / philsb_);
   if (digitisedPhi >= digiPhiEdgeLastBinUp) {
     digitisedPhi = digiPhiEdgeLastBinUp - 1;
   } else {
     for (int i = 0; i < phiAxis->GetNbins(); ++i) {
       if (phiAxis->GetBinUpEdge(i) < regionLowEdges.first)
         continue;
       int digiEdgeBinUp = floor((phiAxis->GetBinUpEdge(i) - regionLowEdges.first) / philsb_);
       if (digiEdgeBinUp == digitisedPhi) {
         digitisedPhi += 1;
       }
     }
   }
 
   // Convert digitised eta and phi back to floating point quantities with reduced precision
   float floatDigitisedEta = (digitisedEta + 0.5) * etalsb_ + regionLowEdges.second;
   float floatDigitisedPhi = (digitisedPhi + 0.5) * philsb_ + regionLowEdges.first;
 
   return std::pair<float, float>{floatDigitisedEta, floatDigitisedPhi};
 }

◆ getRegionIndex()

unsigned int Phase1L1TJetProducer::getRegionIndex	(	const unsigned int	phiRegion,
		const unsigned int	etaRegion
	)		const

private

Definition at line 550 of file Phase1L1TJetProducer.cc.

References phiRegionEdges_.

Referenced by prepareInputsIntoRegions().

                                                                                                                   {
   return etaRegion * (phiRegionEdges_.size() - 1) + phiRegion;
 }

◆ getTowerEnergy()

float Phase1L1TJetProducer::getTowerEnergy	(	int	iEta,
		int	iPhi
	)		const

private

Get the energy of a certain tower while correctly handling phi periodicity in case of overflow.

Definition at line 201 of file Phase1L1TJetProducer.cc.

References caloGrid_, L1TowerCalibrationProducer_cfi::iEta, hgcalTowerMapProducer_cfi::nBinsEta, and l1tSlwPFPuppiJets_cfi::nBinsPhi.

Referenced by buildJetFromSeed(), findSeeds(), and subtract9x9Pileup().

                                                                    {
   // We return the pt of a certain bin in the calo grid, taking account of the phi periodicity when overflowing (e.g. phi > phiSize), and returning 0 for the eta out of bounds
 
   int nBinsEta = caloGrid_->GetNbinsX();
   int nBinsPhi = caloGrid_->GetNbinsY();
   while (iPhi < 1) {
     iPhi += nBinsPhi;
   }
   while (iPhi > nBinsPhi) {
     iPhi -= nBinsPhi;
   }
   if (iEta < 1) {
     return 0;
   }
   if (iEta > nBinsEta) {
     return 0;
   }
   return caloGrid_->GetBinContent(iEta, iPhi);
 }

◆ prepareInputsIntoRegions() [1/2]

template<class Handle >

std::vector<std::vector<reco::CandidatePtr> > Phase1L1TJetProducer::prepareInputsIntoRegions ( const Handle triggerPrimitives )

private

◆ prepareInputsIntoRegions() [2/2]

template<class Handle >

std::vector<std::vector<edm::Ptr<reco::Candidate> > > Phase1L1TJetProducer::prepareInputsIntoRegions ( const Handle triggerPrimitives )

Definition at line 514 of file Phase1L1TJetProducer.cc.

References etaRegionEdges_, getRegionIndex(), mps_fire::i, PixelMapPlotter::inputs, maxInputsPerRegion_, phiRegionEdges_, cmsswSequenceInfo::tp, and pfDeepBoostedJetPreprocessParams_cfi::upper_bound.

                                     {
   std::vector<std::vector<reco::CandidatePtr>> inputsInRegions{etaRegionEdges_.size() * (phiRegionEdges_.size() - 1)};
 
   for (unsigned int i = 0; i < triggerPrimitives->size(); ++i) {
     reco::CandidatePtr tp(triggerPrimitives, i);
 
     if (tp->phi() < phiRegionEdges_.front() || tp->phi() >= phiRegionEdges_.back() ||
         tp->eta() < etaRegionEdges_.front() || tp->eta() >= etaRegionEdges_.back())
       continue;
 
     // Which phi region does this tp belong to
     auto it_phi = phiRegionEdges_.begin();
     it_phi = std::upper_bound(phiRegionEdges_.begin(), phiRegionEdges_.end(), tp->phi()) - 1;
 
     // Which eta region does this tp belong to
     auto it_eta = etaRegionEdges_.begin();
     it_eta = std::upper_bound(etaRegionEdges_.begin(), etaRegionEdges_.end(), tp->eta()) - 1;
 
     if (it_phi != phiRegionEdges_.end() && it_eta != etaRegionEdges_.end()) {
       auto phiRegion = it_phi - phiRegionEdges_.begin();
       auto etaRegion = it_eta - etaRegionEdges_.begin();
       inputsInRegions[getRegionIndex(phiRegion, etaRegion)].emplace_back(tp);
     }
   }
 
   // Truncate number of inputs in each pf region
   for (auto& inputs : inputsInRegions) {
     if (inputs.size() > maxInputsPerRegion_) {
       inputs.resize(maxInputsPerRegion_);
     }
   }
 
   return inputsInRegions;
 }

◆ produce()

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

overrideprivatevirtual

Implements edm::one::EDProducerBase.

Definition at line 221 of file Phase1L1TJetProducer.cc.

References buildJetsFromSeeds(), buildJetsFromSeedsWithPUSubtraction(), caloGrid_, computeMET(), findSeeds(), iEvent, inputCollectionTag_, L1Analysis::kMissingEt, L1Analysis::kMissingEtHF, metAbsEtaCut_, metHFAbsEtaCut_, eostools::move(), outputCollectionName_, reco::LeafCandidate::pt(), puSubtraction_, seedPtThreshold_, jetUpdater_cfi::sort, and vetoZeroPt_.

                                                                                 {
   edm::Handle<edm::View<reco::Candidate>> inputCollectionHandle;
   iEvent.getByToken(inputCollectionTag_, inputCollectionHandle);
 
   // sort inputs into PF regions
   std::vector<std::vector<reco::CandidatePtr>> inputsInRegions = prepareInputsIntoRegions<>(inputCollectionHandle);
 
   // histogramming the data
   caloGrid_->Reset();
   for (unsigned int iInputRegion = 0; iInputRegion < inputsInRegions.size(); ++iInputRegion) {
     fillCaloGrid<>(*(caloGrid_), inputsInRegions[iInputRegion], iInputRegion);
   }
 
   // find the seeds
   const auto& seedsVector = findSeeds(seedPtThreshold_);  // seedPtThreshold = 5
   // build jets from the seeds
   auto l1jetVector =
       puSubtraction_ ? buildJetsFromSeedsWithPUSubtraction(seedsVector, vetoZeroPt_) : buildJetsFromSeeds(seedsVector);
 
   // sort by pt
   std::sort(l1jetVector.begin(), l1jetVector.end(), [](const reco::CaloJet& jet1, const reco::CaloJet& jet2) {
     return jet1.pt() > jet2.pt();
   });
 
   auto l1jetVectorPtr = std::make_unique<std::vector<reco::CaloJet>>(l1jetVector);
   iEvent.put(std::move(l1jetVectorPtr), outputCollectionName_);
 
   // calculate METs
   l1t::EtSum lMET = computeMET(metAbsEtaCut_, l1t::EtSum::EtSumType::kMissingEt);
   l1t::EtSum lMETHF = computeMET(metHFAbsEtaCut_, l1t::EtSum::EtSumType::kMissingEtHF);
   std::unique_ptr<std::vector<l1t::EtSum>> lSumVectorPtr(new std::vector<l1t::EtSum>(0));
   lSumVectorPtr->push_back(lMET);
   lSumVectorPtr->push_back(lMETHF);
   iEvent.put(std::move(lSumVectorPtr), this->outputCollectionName_ + "MET");
 
   return;
 }

◆ regionEtaPhiLowEdges()

std::pair< double, double > Phase1L1TJetProducer::regionEtaPhiLowEdges ( const unsigned int regionIndex ) const

private

Definition at line 554 of file Phase1L1TJetProducer.cc.

References etaRegionEdges_, and phiRegionEdges_.

Referenced by getCandidateDigiEtaPhi().

                                                                                                        {
   unsigned int phiRegion = regionIndex % (phiRegionEdges_.size() - 1);
   unsigned int etaRegion = (regionIndex - phiRegion) / (phiRegionEdges_.size() - 1);
   return std::pair<double, double>{phiRegionEdges_.at(phiRegion), etaRegionEdges_.at(etaRegion)};
 }

◆ regionEtaPhiUpEdges()

std::pair< double, double > Phase1L1TJetProducer::regionEtaPhiUpEdges ( const unsigned int regionIndex ) const

private

Definition at line 560 of file Phase1L1TJetProducer.cc.

References etaRegionEdges_, and phiRegionEdges_.

Referenced by getCandidateDigiEtaPhi().

                                                                                                       {
   unsigned int phiRegion = regionIndex % (phiRegionEdges_.size() - 1);
   unsigned int etaRegion = (regionIndex - phiRegion) / (phiRegionEdges_.size() - 1);
   if (phiRegion == phiRegionEdges_.size() - 1) {
     return std::pair<double, double>{phiRegionEdges_.at(phiRegion), etaRegionEdges_.at(etaRegion + 1)};
   } else if (etaRegion == etaRegionEdges_.size() - 1) {
     return std::pair<double, double>{phiRegionEdges_.at(phiRegion + 1), etaRegionEdges_.at(etaRegion)};
   }
 
   return std::pair<double, double>{phiRegionEdges_.at(phiRegion + 1), etaRegionEdges_.at(etaRegion + 1)};
 }

◆ subtract9x9Pileup()

void Phase1L1TJetProducer::subtract9x9Pileup ( reco::CaloJet & jet ) const

private

Definition at line 259 of file Phase1L1TJetProducer.cc.

References caloGrid_, getTowerEnergy(), metsig::jet, SiStripPI::max, x, x_scroll_max, x_scroll_min, y, y_scroll_max, and y_scroll_min.

Referenced by buildJetsFromSeedsWithPUSubtraction().

                                                                    {
   // these variables host the total pt in each sideband and the total pileup contribution
   float topBandPt = 0;
   float leftBandPt = 0;
   float rightBandPt = 0;
   float bottomBandPt = 0;
   float pileUpEnergy;
 
   // hold the jet's x-y (and z, as I have to use it, even if 2D) location in the histo
   int xCenter, yCenter, zCenter;
   // Retrieving histo-coords for seed
   caloGrid_->GetBinXYZ(caloGrid_->FindFixBin(jet.eta(), jet.phi()), xCenter, yCenter, zCenter);
 
   // Computing pileup
   for (int x = x_scroll_min; x <= x_scroll_max; x++) {
     for (int y = y_scroll_min; y < y_scroll_max; y++) {
       // top band, I go up 5 squares to reach the bottom of the top band
       // +x scrolls from left to right, +y scrolls up
       topBandPt += getTowerEnergy(xCenter + x, yCenter + (5 + y));
       // left band, I go left 5 squares (-5) to reach the bottom of the top band
       // +x scrolls from bottom to top, +y scrolls left
       leftBandPt += getTowerEnergy(xCenter - (5 + y), yCenter + x);
       // right band, I go right 5 squares (+5) to reach the bottom of the top band
       // +x scrolls from bottom to top, +y scrolls right
       rightBandPt += getTowerEnergy(xCenter + (5 + y), yCenter + x);
       // right band, I go right 5 squares (+5) to reach the bottom of the top band
       // +x scrolls from bottom to top, +y scrolls right
       bottomBandPt += getTowerEnergy(xCenter + x, yCenter - (5 + y));
     }
   }
   // adding bands and removing the maximum band (equivalent to adding the three minimum bands)
   pileUpEnergy = topBandPt + leftBandPt + rightBandPt + bottomBandPt -
                  std::max(topBandPt, std::max(leftBandPt, std::max(rightBandPt, bottomBandPt)));
 
   //preparing the new 4-momentum vector
   reco::Candidate::PolarLorentzVector ptVector;
   // removing pu contribution
   float ptAfterPUSubtraction = jet.pt() - pileUpEnergy;
   ptVector.SetPt((ptAfterPUSubtraction > 0) ? ptAfterPUSubtraction : 0);
   ptVector.SetEta(jet.eta());
   ptVector.SetPhi(jet.phi());
   //updating the jet
   jet.setP4(ptVector);
   jet.setPileup(pileUpEnergy);
   return;
 }

◆ trimTower()

bool Phase1L1TJetProducer::trimTower	(	const int	etaIndex,
		const int	phiIndex
	)		const

private

Definition at line 594 of file Phase1L1TJetProducer.cc.

References jetIEtaSize_, and jetIPhiSize_.

Referenced by buildJetFromSeed(), and findSeeds().

                                                                                  {
   int etaHalfSize = jetIEtaSize_ / 2;
   int phiHalfSize = jetIPhiSize_ / 2;
 
   if (etaIndex == -etaHalfSize || etaIndex == etaHalfSize) {
     if (phiIndex <= -phiHalfSize + 1 || phiIndex >= phiHalfSize - 1) {
       return true;
     }
   } else if (etaIndex == -etaHalfSize + 1 || etaIndex == etaHalfSize - 1) {
     if (phiIndex == -phiHalfSize || phiIndex == phiHalfSize) {
       return true;
     }
   }
 
   return false;
 }

Member Data Documentation

◆ caloGrid_

std::unique_ptr<TH2F> Phase1L1TJetProducer::caloGrid_

private

Definition at line 134 of file Phase1L1TJetProducer.cc.

Referenced by buildJetFromSeed(), computeMET(), findSeeds(), getCandidateDigiEtaPhi(), getTowerEnergy(), produce(), and subtract9x9Pileup().

◆ cosPhi_

std::vector<double> Phase1L1TJetProducer::cosPhi_

private

Definition at line 157 of file Phase1L1TJetProducer.cc.

Referenced by computeMET().

◆ etaBinning_

std::vector<double> Phase1L1TJetProducer::etaBinning_

private

Definition at line 136 of file Phase1L1TJetProducer.cc.

◆ etalsb_

double Phase1L1TJetProducer::etalsb_

private

Definition at line 147 of file Phase1L1TJetProducer.cc.

Referenced by getCandidateDigiEtaPhi().

◆ etaRegionEdges_

std::vector<double> Phase1L1TJetProducer::etaRegionEdges_

private

Definition at line 151 of file Phase1L1TJetProducer.cc.

Referenced by prepareInputsIntoRegions(), regionEtaPhiLowEdges(), and regionEtaPhiUpEdges().

◆ inputCollectionTag_

edm::EDGetTokenT<edm::View<reco::Candidate> > Phase1L1TJetProducer::inputCollectionTag_

private

Definition at line 132 of file Phase1L1TJetProducer.cc.

Referenced by produce().

◆ jetIEtaSize_

unsigned int Phase1L1TJetProducer::jetIEtaSize_

private

Definition at line 141 of file Phase1L1TJetProducer.cc.

Referenced by buildJetFromSeed(), findSeeds(), and trimTower().

◆ jetIPhiSize_

unsigned int Phase1L1TJetProducer::jetIPhiSize_

private

Definition at line 142 of file Phase1L1TJetProducer.cc.

Referenced by buildJetFromSeed(), findSeeds(), and trimTower().

◆ maxInputsPerRegion_

unsigned int Phase1L1TJetProducer::maxInputsPerRegion_

private

Definition at line 154 of file Phase1L1TJetProducer.cc.

Referenced by prepareInputsIntoRegions().

◆ metAbsEtaCut_

double Phase1L1TJetProducer::metAbsEtaCut_

private

Definition at line 159 of file Phase1L1TJetProducer.cc.

Referenced by produce().

◆ metHFAbsEtaCut_

double Phase1L1TJetProducer::metHFAbsEtaCut_

private

Definition at line 161 of file Phase1L1TJetProducer.cc.

Referenced by produce().

◆ nBinsEta_

size_t Phase1L1TJetProducer::nBinsEta_

private

Definition at line 137 of file Phase1L1TJetProducer.cc.

◆ nBinsPhi_

unsigned int Phase1L1TJetProducer::nBinsPhi_

private

Definition at line 138 of file Phase1L1TJetProducer.cc.

◆ outputCollectionName_

std::string Phase1L1TJetProducer::outputCollectionName_

private

Definition at line 162 of file Phase1L1TJetProducer.cc.

Referenced by produce().

◆ phiLow_

double Phase1L1TJetProducer::phiLow_

private

Definition at line 139 of file Phase1L1TJetProducer.cc.

◆ philsb_

double Phase1L1TJetProducer::philsb_

private

Definition at line 146 of file Phase1L1TJetProducer.cc.

Referenced by getCandidateDigiEtaPhi().

◆ phiRegionEdges_

std::vector<double> Phase1L1TJetProducer::phiRegionEdges_

private

Definition at line 152 of file Phase1L1TJetProducer.cc.

Referenced by getRegionIndex(), prepareInputsIntoRegions(), regionEtaPhiLowEdges(), and regionEtaPhiUpEdges().

◆ phiUp_

double Phase1L1TJetProducer::phiUp_

private

Definition at line 140 of file Phase1L1TJetProducer.cc.

◆ ptlsb_

double Phase1L1TJetProducer::ptlsb_

private

Definition at line 145 of file Phase1L1TJetProducer.cc.

Referenced by computeMET().

◆ puSubtraction_

bool Phase1L1TJetProducer::puSubtraction_

private

Definition at line 148 of file Phase1L1TJetProducer.cc.

Referenced by produce().

◆ seedPtThreshold_

double Phase1L1TJetProducer::seedPtThreshold_

private

Definition at line 144 of file Phase1L1TJetProducer.cc.

Referenced by produce().

◆ sinPhi_

std::vector<double> Phase1L1TJetProducer::sinPhi_

private

Definition at line 156 of file Phase1L1TJetProducer.cc.

Referenced by computeMET().

◆ trimmedGrid_

bool Phase1L1TJetProducer::trimmedGrid_

private

Definition at line 143 of file Phase1L1TJetProducer.cc.

Referenced by buildJetFromSeed(), and findSeeds().

◆ vetoZeroPt_

bool Phase1L1TJetProducer::vetoZeroPt_

private

Definition at line 149 of file Phase1L1TJetProducer.cc.

Referenced by buildJetsFromSeedsWithPUSubtraction(), and produce().

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Phase1L1TJetProducer()

◆ ~Phase1L1TJetProducer()

Member Function Documentation

◆ buildJetFromSeed()

◆ buildJetsFromSeeds()

◆ buildJetsFromSeedsWithPUSubtraction()

◆ computeMET()

◆ fillCaloGrid()

◆ fillDescriptions()

◆ findSeeds()

◆ getCandidateDigiEtaPhi()

◆ getRegionIndex()

◆ getTowerEnergy()

◆ prepareInputsIntoRegions() [1/2]

◆ prepareInputsIntoRegions() [2/2]

◆ produce()

◆ regionEtaPhiLowEdges()

◆ regionEtaPhiUpEdges()

◆ subtract9x9Pileup()

◆ trimTower()

Member Data Documentation

◆ caloGrid_

◆ cosPhi_

◆ etaBinning_

◆ etalsb_

◆ etaRegionEdges_

◆ inputCollectionTag_

◆ jetIEtaSize_

◆ jetIPhiSize_

◆ maxInputsPerRegion_

◆ metAbsEtaCut_

◆ metHFAbsEtaCut_

◆ nBinsEta_

◆ nBinsPhi_

◆ outputCollectionName_

◆ phiLow_

◆ philsb_

◆ phiRegionEdges_

◆ phiUp_

◆ ptlsb_

◆ puSubtraction_

◆ seedPtThreshold_

◆ sinPhi_

◆ trimmedGrid_

◆ vetoZeroPt_