Emulation of the hardware jet finder. More...

#include <L1GctHardwareJetFinder.h>

Inheritance diagram for L1GctHardwareJetFinder:

Public Member Functions
void	fetchInput () override
	get input data from sources More...

	L1GctHardwareJetFinder (int id)
	id is 0-8 for -ve Eta jetfinders, 9-17 for +ve Eta, for increasing Phi. More...

void	process () override
	process the data, fill output buffers More...

virtual void	reset ()
	include additional reset functionality More...

	~L1GctHardwareJetFinder () override

Public Member Functions inherited from L1GctJetFinderBase
unsigned	getCenJetSeed () const

unsigned	getEtaBoundry () const

etTotalType	getEtSum () const
	Get the scalar sum of Et summed over the input regions. More...

etCompInternJfType	getExSum () const
	Get the x component of vector Et summed over the input regions. More...

etCompInternJfType	getEySum () const
	Get the y component of vector Et summed over the input regions. More...

unsigned	getFwdJetSeed () const

hfTowerSumsType	getHfSums () const
	Get the Hf tower Et sums and tower-over-threshold counts. More...

unsigned	getHtmSumJetThreshold () const

etHadType	getHtSum () const
	Get the scalar sum of Ht summed over jets above threshold. More...

unsigned	getHttSumJetThreshold () const

htCompInternJfType	getHxSum () const
	Get the x component of vector Ht summed over jets above threshold. More...

htCompInternJfType	getHySum () const
	Get the y component of vector Ht summed over jets above threshold. More...

RegionsVector	getInputRegions () const
	Return input data. More...

std::vector< L1GctInternEtSum >	getInternalEtSums () const
	get et sums in raw format - to be stored in the event More...

std::vector< L1GctInternHtMiss >	getInternalHtMiss () const

std::vector< L1GctInternJetData >	getInternalJets () const
	get output jets in raw format - to be stored in the event More...

const lutPtrVector	getJetEtCalLuts () const
	Return pointers to calibration LUTs. More...

JetVector	getJets () const
	Get the located jets. More...

RegionsVector	getKeptProtoJets () const
	get protoJets kept More...

RawJetVector	getRawJets () const
	get output jets in raw format More...

RegionsVector	getRcvdProtoJets () const
	get protoJets received from neighbour More...

RegionsVector	getSentProtoJets () const
	get protoJets sent to neighbour More...

unsigned	getTauIsolationThreshold () const

unsigned	getTauJetSeed () const

	L1GctJetFinderBase (int id)
	id is 0-8 for -ve Eta jetfinders, 9-17 for +ve Eta, for increasing Phi. More...

void	setEnergySumMasks (const L1GctChannelMask *chmask)
	Set masks for energy summing. More...

void	setInputRegion (const L1CaloRegion &region)
	Set input data. More...

void	setJetEtCalibrationLuts (const lutPtrVector &jfluts)
	Set pointer to calibration Lut - needed to complete the setup. More...

void	setJetFinderParams (const L1GctJetFinderParams *jfpars)
	Set pointer to parameters - needed to complete the setup. More...

void	setNeighbourJetFinders (const std::vector< L1GctJetFinderBase *> &neighbours)
	Set pointers to neighbours - needed to complete the setup. More...

bool	setupOk () const
	Check setup is Ok. More...

void	setupTauAlgo (const bool useImprovedAlgo, const bool ignoreVetoBitsForIsolation)
	Setup the tau algorithm parameters. More...

	~L1GctJetFinderBase () override

Public Member Functions inherited from L1GctProcessor
	L1GctProcessor ()

void	reset ()
	complete reset of processor More...

void	setBxRange (const int firstBx, const int numberOfBx)
	define the bunch crossing range to process More...

void	setNextBx (const int bxnum)
	clear input data buffers and process a new bunch crossing More...

void	setTerse ()

bool	setupOk () const
	Method to check the setup for this processor. Returns true by default. More...

void	setVerbose ()
	control output messages More...

virtual	~L1GctProcessor ()

Protected Member Functions
unsigned	centralCol0 () const override

unsigned	maxRegionsIn () const override

unsigned	nCols () const override

Protected Member Functions inherited from L1GctJetFinderBase
etTotalType	calcEtStrip (const UShort strip) const
	Calculates total (raw) energy in a phi strip. More...

hfTowerSumsType	calcHfSums () const
	Calculates Et sum and number of towers over threshold in Hf. More...

etTotalType	calcHtStrip (const UShort strip) const
	Calculates total calibrated energy in jets (Ht) sum. More...

void	doEnergySums ()
	Fill the Et strip sums and Ht sum. All jetFinders should call this in process(). More...

void	doEtSums ()
	Calculates scalar and vector sum of Et over input regions. More...

void	doHtSums ()
	Calculates scalar and vector sum of Ht over calibrated jets. More...

void	fetchProtoJetsFromNeighbour (const fetchType ft)
	fetch the protoJets from neighbour jetFinder More...

void	resetPipelines () override

void	resetProcessor () override
	Separate reset methods for the processor itself and any data stored in pipelines. More...

void	setupObjects () override
	Initialise inputs with null objects for the correct bunch crossing if required. More...

void	sortJets ()
	Sort the found jets. All jetFinders should call this in process(). More...

Protected Member Functions inherited from L1GctProcessor
int	bxAbs () const

int	bxMax () const

int	bxMin () const
	Support for multiple beam crossing operation. More...

int	bxRel () const

int	numOfBx () const

Private Member Functions
void	convertClustersToOutputJets ()
	Organise the final clustered jets into L1GctJets. More...

void	convertClustersToProtoJets ()
	Organise the pre-clustered jets into the ones we keep and those we send to the neighbour. More...

void	findFinalClusters ()
	Convert protojets to final jets. More...

void	findJets ()
	The second stage of clustering, called by process() More...

void	findLocalMaxima ()
	Find local maxima in the search array. More...

void	findProtoClusters ()
	Convert local maxima to clusters. More...

void	findProtoJets ()
	The first stage of clustering, called by fetchInput() More...

L1GctRegion	makeProtoJet (L1GctRegion localMax)
	Method to make a single proto-jet. More...

Private Attributes
RegionsVector	m_cluster00

RegionsVector	m_clusters
	Each local maximum becomes a cluster. More...

RegionsVector	m_localMax00

RegionsVector	m_localMaxima
	Local vectors used during both stages of clustering. More...

unsigned	m_numberOfClusters
	The number of local Maxima/clusters found at each stage of clustering. More...

Static Private Attributes
static const unsigned int	CENTRAL_COL0 = 0

static const unsigned int	MAX_REGIONS_IN
	The real jetFinders must define these constants. More...

static const unsigned int	N_COLS = 2

Friends
std::ostream &	operator<< (std::ostream &os, const L1GctHardwareJetFinder &algo)
	Overload << operator. More...

Additional Inherited Members
Public Types inherited from L1GctJetFinderBase
typedef L1GctTwosComplement< L1GctInternEtSum::kJetMissEtNBits >	etCompInternJfType

typedef L1GctUnsignedInt< L1GctInternEtSum::kTotEtOrHtNBits >	etHadType

typedef L1GctUnsignedInt< L1GctInternEtSum::kTotEtOrHtNBits >	etTotalType

typedef L1GctTwosComplement< L1GctInternHtMiss::kJetMissHtNBits >	htCompInternJfType

typedef std::vector< L1GctJetCand >	JetVector

typedef L1GctJet::lutPtr	lutPtr

typedef std::vector< lutPtr >	lutPtrVector

enum	maxValues { etTotalMaxValue = L1GctInternEtSum::kTotEtOrHtMaxValue, htTotalMaxValue = L1GctInternEtSum::kTotEtOrHtMaxValue }

typedef Pipeline< L1GctJet >	RawJetPipeline

typedef std::vector< L1GctJet >	RawJetVector

typedef std::vector< L1GctRegion >	RegionsVector

typedef unsigned long int	ULong

typedef unsigned short int	UShort

Static Public Attributes inherited from L1GctJetFinderBase
static const unsigned int	COL_OFFSET = L1GctJetFinderParams::NUMBER_ETA_VALUES + N_EXTRA_REGIONS_ETA00
	The index offset between columns. More...

static const unsigned int	MAX_JETS_OUT = 6
	Max of 6 jets found per jetfinder in a 2*11 search area. More...

static const unsigned int	N_EXTRA_REGIONS_ETA00 = 2
	Number of additional regions to process on the "wrong" side of eta=0 (determines COL_OFFSET) More...

static const unsigned int	N_JF_PER_WHEEL = ((L1CaloRegionDetId::N_PHI) / 2)
	No of jetFinders per Wheel. More...

Protected Types inherited from L1GctJetFinderBase
enum	fetchType { TOP, BOT, TOPBOT }
	different ways of getting the neighbour data More...

Protected Attributes inherited from L1GctJetFinderBase
unsigned	m_CenJetSeed

unsigned	m_EtaBoundry

bool	m_EtmMask [11]

bool	m_EttMask [11]

unsigned	m_FwdJetSeed

bool	m_gotChannelMask
	Remember whether channel mask have been stored. More...

bool	m_gotJetEtCalLuts
	Remember whether jet Et calibration Lut pointers have been stored. More...

bool	m_gotJetFinderParams
	Remember whether jetfinder parameters have been stored. More...

bool	m_gotNeighbourPointers
	Remember whether the neighbour pointers have been stored. More...

bool	m_HtmMask [11]

unsigned	m_HtmSumJetThreshold

bool	m_HttMask [11]

unsigned	m_HttSumJetThreshold

int	m_id
	algo ID More...

bool	m_idInRange
	Remember whether range check on the input ID was ok. More...

bool	m_ignoreTauVetoBitsForIsolation

RegionsVector	m_inputRegions

lutPtrVector	m_jetEtCalLuts
	Jet Et Conversion LUT pointer. More...

RegionsVector	m_keptProtoJets
	List of pre-clustered jets retained locally as input to the final clustering. More...

unsigned	m_minColThisJf
	parameter to determine which Regions belong in our acceptance More...

std::vector< L1GctJetFinderBase * >	m_neighbourJetFinders
	Store neighbour pointers. More...

etTotalType	m_outputEtSum
	output Et strip sums and Ht - refactored More...

etCompInternJfType	m_outputExSum

etCompInternJfType	m_outputEySum

hfTowerSumsType	m_outputHfSums

etHadType	m_outputHtSum

htCompInternJfType	m_outputHxSum

htCompInternJfType	m_outputHySum

RawJetVector	m_outputJets
	output jets More...

bool	m_positiveEtaWheel

RegionsVector	m_rcvdProtoJets
	List of pre-clustered jets received from neighbour before the final stage of clustering. More...

RegionsVector	m_sentProtoJets
	List of pre-clustered jets to be sent to neighbour after the first stage of clustering. More...

JetVector	m_sortedJets

unsigned	m_tauIsolationThreshold

unsigned	m_TauJetSeed

bool	m_useImprovedTauAlgo
	Setup parameters for the tau jet algorithm. More...

Protected Attributes inherited from L1GctProcessor
bool	m_verbose
	Flag to control output messages. More...

Detailed Description

Emulation of the hardware jet finder.

Definition at line 18 of file L1GctHardwareJetFinder.h.

Constructor & Destructor Documentation

◆ L1GctHardwareJetFinder()

L1GctHardwareJetFinder::L1GctHardwareJetFinder ( int id )

id is 0-8 for -ve Eta jetfinders, 9-17 for +ve Eta, for increasing Phi.

Definition at line 9 of file L1GctHardwareJetFinder.cc.

References CENTRAL_COL0, L1GctJetFinderBase::m_id, L1GctJetFinderBase::m_minColThisJf, L1CaloRegionDetId::N_PHI, and reset().

     : L1GctJetFinderBase(id),
       m_localMaxima(MAX_JETS_OUT),
       m_clusters(MAX_JETS_OUT),
       m_numberOfClusters(0),
       m_localMax00(2),
       m_cluster00(2) {
   this->reset();
   // Initialise parameters for Region input calculations in the
   // derived class so we get the right values of constants.
   static const unsigned NPHI = L1CaloRegionDetId::N_PHI;
   m_minColThisJf = (NPHI + m_id * 2 - CENTRAL_COL0) % NPHI;
 }

◆ ~L1GctHardwareJetFinder()

L1GctHardwareJetFinder::~L1GctHardwareJetFinder ( )

override

Definition at line 23 of file L1GctHardwareJetFinder.cc.

23 {}

Member Function Documentation

◆ centralCol0()

unsigned L1GctHardwareJetFinder::centralCol0 ( ) const

inlineoverrideprotectedvirtual

Reimplemented from L1GctJetFinderBase.

Definition at line 41 of file L1GctHardwareJetFinder.h.

References CENTRAL_COL0.

Referenced by findFinalClusters(), and findLocalMaxima().

41 { return CENTRAL_COL0; }

L1GctHardwareJetFinder::CENTRAL_COL0

static const unsigned int CENTRAL_COL0

Definition: L1GctHardwareJetFinder.h:48

◆ convertClustersToOutputJets()

void L1GctHardwareJetFinder::convertClustersToOutputJets ( )

private

Organise the final clustered jets into L1GctJets.

Definition at line 425 of file L1GctHardwareJetFinder.cc.

References ecaldqm::isForward(), dqmiolumiharvest::j, L1GctJetFinderBase::m_CenJetSeed, m_clusters, L1GctJetFinderBase::m_EtaBoundry, L1GctJetFinderBase::m_FwdJetSeed, L1GctJetFinderBase::m_outputJets, L1GctJetFinderBase::MAX_JETS_OUT, and groupFilesInBlocks::temp.

Referenced by findJets().

                                                          {
   for (unsigned j = 0; j < MAX_JETS_OUT; ++j) {
     bool isForward = (m_clusters.at(j).rctEta() >= m_EtaBoundry);
     unsigned JET_THRESHOLD = (isForward ? m_FwdJetSeed : m_CenJetSeed);
     if (m_clusters.at(j).et() >= JET_THRESHOLD) {
       L1GctJet temp(m_clusters.at(j).et(),
                     m_clusters.at(j).gctEta(),
                     m_clusters.at(j).gctPhi(),
                     m_clusters.at(j).overFlow(),
                     isForward,
                     m_clusters.at(j).tauVeto(),
                     m_clusters.at(j).bx());
       m_outputJets.at(j) = temp;
     }
   }
 }

◆ convertClustersToProtoJets()

void L1GctHardwareJetFinder::convertClustersToProtoJets ( )

private

Organise the pre-clustered jets into the ones we keep and those we send to the neighbour.

Definition at line 413 of file L1GctHardwareJetFinder.cc.

References ecaldqm::isForward(), dqmiolumiharvest::j, L1GctJetFinderBase::m_CenJetSeed, m_clusters, L1GctJetFinderBase::m_EtaBoundry, L1GctJetFinderBase::m_FwdJetSeed, L1GctJetFinderBase::m_keptProtoJets, L1GctJetFinderBase::m_sentProtoJets, and L1GctJetFinderBase::MAX_JETS_OUT.

Referenced by findProtoJets().

                                                         {
   for (unsigned j = 0; j < MAX_JETS_OUT; ++j) {
     bool isForward = (m_clusters.at(j).rctEta() >= m_EtaBoundry);
     unsigned JET_THRESHOLD = (isForward ? m_FwdJetSeed : m_CenJetSeed);
     if (m_clusters.at(j).et() >= JET_THRESHOLD) {
       m_keptProtoJets.at(j) = m_clusters.at(j);
       m_sentProtoJets.at(j) = m_clusters.at(j);
     }
   }
 }

◆ fetchInput()

void L1GctHardwareJetFinder::fetchInput ( )

overridevirtual

get input data from sources

Implements L1GctJetFinderBase.

Definition at line 34 of file L1GctHardwareJetFinder.cc.

References findProtoJets(), and L1GctJetFinderBase::setupOk().

                                         {
   if (setupOk()) {
     findProtoJets();
   }
 }

◆ findFinalClusters()

void L1GctHardwareJetFinder::findFinalClusters ( )

private

Convert protojets to final jets.

Definition at line 317 of file L1GctHardwareJetFinder.cc.

Referenced by findJets().

                                                {
   m_clusters.clear();
   m_clusters.resize(MAX_JETS_OUT);
 
   // Loop over proto-jets received from neighbours.
   // Form a jet to send to the output if there is no proto-jet nearby in the
   // list of jets found locally. If local jets are found nearby, form a jet
   // if the received jet has higher Et than any one of the local ones.
   for (unsigned j = 0; j < MAX_JETS_OUT; ++j) {
     unsigned et0 = m_rcvdProtoJets.at(j).et();
     unsigned localEta0 = m_rcvdProtoJets.at(j).rctEta();
     unsigned localPhi0 = m_rcvdProtoJets.at(j).rctPhi();
     unsigned JET_THRESHOLD = ((localEta0 >= m_EtaBoundry) ? m_FwdJetSeed : m_CenJetSeed);
     if (et0 >= JET_THRESHOLD) {
       bool storeJet = false;
       bool isolated = true;
       // eta00 boundary check/veto
       if (localEta0 == 0) {
         unsigned neighbourEt = m_cluster00.at(1 - localPhi0).et();
         isolated &= et0 >= neighbourEt;
       }
       // If the jet is NOT vetoed, look at the jets found locally (m_keptProtoJets).
       // We accept the jet if there are no local jets nearby, or if the local jet
       // (there should be no more than one) has lower Et.
       if (isolated) {
         for (unsigned k = 0; k < MAX_JETS_OUT; ++k) {
           unsigned et1 = m_keptProtoJets.at(k).et();
           unsigned localEta1 = m_keptProtoJets.at(k).rctEta();
           unsigned localPhi1 = m_keptProtoJets.at(k).rctPhi();
           if (et1 > 0) {
             bool distantJet = ((localPhi0 == localPhi1) || (localEta1 > localEta0 + 1) || (localEta0 > localEta1 + 1));
 
             isolated &= distantJet;
             storeJet |= !distantJet && ((et0 > et1) || ((et0 == et1) && localPhi0 == 1));
           }
         }
       }
 
       storeJet |= isolated;
 
       if (storeJet) {
         // Start with the et sum, tau veto and overflow flags of the protoJet (2x3 regions)
         unsigned etCluster = et0;
         bool ovrFlowOr = m_rcvdProtoJets.at(j).overFlow();
         bool tauVetoOr = m_rcvdProtoJets.at(j).tauVeto();
         unsigned rgnsAboveIsoThreshold = (m_rcvdProtoJets.at(j).featureBit0() ? 1 : 0);
 
         // Combine with the corresponding regions from
         // the local array to make a 3x3 jet cluster
         unsigned column = 1 - localPhi0;
         // Which rows are we looking over?
         unsigned rowStart, rowEnd;
         static const unsigned row0 = N_EXTRA_REGIONS_ETA00 - 1;
         rowStart = row0 + localEta0;
         if (localEta0 < COL_OFFSET - row0 - 2) {
           rowEnd = rowStart + 3;
         } else {
           rowEnd = COL_OFFSET;
         }
         unsigned index = COL_OFFSET * (this->centralCol0() + column) + rowStart;
         for (unsigned row = rowStart; row < rowEnd; ++row) {
           etCluster += m_inputRegions.at(index).et();
           ovrFlowOr |= m_inputRegions.at(index).overFlow();
           if (m_useImprovedTauAlgo) {
             if (!m_ignoreTauVetoBitsForIsolation) {
               tauVetoOr |= m_inputRegions.at(index).tauVeto();
             }
             // check the region energy against the isolation threshold
             if (m_inputRegions.at(index).et() >= m_tauIsolationThreshold) {
               rgnsAboveIsoThreshold++;
             }
           } else {
             tauVetoOr |= m_inputRegions.at(index).tauVeto();
           }
 
           ++index;
         }
 
         // Store the new jet
         unsigned eta = m_rcvdProtoJets.at(j).gctEta();
         unsigned phi = m_rcvdProtoJets.at(j).gctPhi();
         int16_t bx = m_rcvdProtoJets.at(j).bx();
 
         // Use the number of towers over threshold for the isolated tau algorithm
         if (m_useImprovedTauAlgo) {
           tauVetoOr |= (rgnsAboveIsoThreshold > 1);
         }
 
         L1GctRegion temp(L1GctRegion::makeFinalJetRegion(etCluster, ovrFlowOr, tauVetoOr, eta, phi, bx));
         m_clusters.at(j) = temp;
       }
     }
   }
 }

◆ findJets()

void L1GctHardwareJetFinder::findJets ( )

private

The second stage of clustering, called by process()

Definition at line 59 of file L1GctHardwareJetFinder.cc.

References convertClustersToOutputJets(), and findFinalClusters().

Referenced by process().

                                       {
   findFinalClusters();
   convertClustersToOutputJets();
 }

◆ findLocalMaxima()

void L1GctHardwareJetFinder::findLocalMaxima ( )

private

Find local maxima in the search array.

Both clustering stages need to find local maxima in the search array.

Definition at line 66 of file L1GctHardwareJetFinder.cc.

References centralCol0(), L1GctJetFinderBase::COL_OFFSET, L1GctJetFinderBase::m_CenJetSeed, L1GctJetFinderBase::m_EtaBoundry, L1GctJetFinderBase::m_FwdJetSeed, L1GctJetFinderBase::m_inputRegions, m_localMax00, m_localMaxima, m_numberOfClusters, L1GctJetFinderBase::m_positiveEtaWheel, L1GctJetFinderBase::MAX_JETS_OUT, and phi.

Referenced by findProtoJets().

                                              {
   m_localMaxima.clear();
   m_localMaxima.resize(MAX_JETS_OUT);
   m_localMax00.clear();
   m_localMax00.resize(2);
 
   UShort jetNum = 0;  //holds the number of jets currently found
   UShort centreIndex = COL_OFFSET * this->centralCol0();
   for (UShort column = 0; column < 2; ++column)  //Find jets in the central search region
   {
     // The input regions include two extra bins on the other side of eta=0. This allows "seamless"
     // jetfinding across the eta=0 boundary. We skip the first input region in each row. We perform
     // the full pre-clustering on the next region but store the resulting clusters separately
     // from the main list of output pre-clusters - they will be used in the final cluster stage to
     // make sure we do not produce jets in adjacent regions on opposite sides of eta=0.
     ++centreIndex;
     for (UShort row = 1; row < COL_OFFSET; ++row) {
       // Here's the array of greater-than and greater-or-equal tests
       // to ensure each localMaximum appears once and only once in the list
       // It is different for forward and backward eta.
       unsigned JET_THRESHOLD = ((row > m_EtaBoundry) ? m_FwdJetSeed : m_CenJetSeed);
       bool localMax = !m_inputRegions.at(centreIndex).empty() && (m_inputRegions.at(centreIndex).et() >= JET_THRESHOLD);
       if (m_positiveEtaWheel) {  // Forward eta
         localMax &= (m_inputRegions.at(centreIndex).et() >= m_inputRegions.at(centreIndex - 1).et());
         if (row < (COL_OFFSET - 1)) {
           localMax &= (m_inputRegions.at(centreIndex).et() > m_inputRegions.at(centreIndex + 1).et());
         }
         if (column == 0) {
           localMax &= (m_inputRegions.at(centreIndex).et() > m_inputRegions.at(centreIndex + COL_OFFSET).et());
           localMax &= (m_inputRegions.at(centreIndex).et() > m_inputRegions.at(centreIndex + COL_OFFSET - 1).et());
           if (row < (COL_OFFSET - 1)) {
             localMax &= (m_inputRegions.at(centreIndex).et() > m_inputRegions.at(centreIndex + COL_OFFSET + 1).et());
           }
         } else {
           localMax &= (m_inputRegions.at(centreIndex).et() >= m_inputRegions.at(centreIndex - COL_OFFSET).et());
           localMax &= (m_inputRegions.at(centreIndex).et() >= m_inputRegions.at(centreIndex - COL_OFFSET - 1).et());
           if (row < (COL_OFFSET - 1)) {
             localMax &= (m_inputRegions.at(centreIndex).et() >= m_inputRegions.at(centreIndex - COL_OFFSET + 1).et());
           }
         }
       } else {  // Backward eta
         localMax &= (m_inputRegions.at(centreIndex).et() > m_inputRegions.at(centreIndex - 1).et());
         if (row < (COL_OFFSET - 1)) {
           localMax &= (m_inputRegions.at(centreIndex).et() >= m_inputRegions.at(centreIndex + 1).et());
         }
         if (column == 0) {
           localMax &= (m_inputRegions.at(centreIndex).et() >= m_inputRegions.at(centreIndex + COL_OFFSET).et());
           localMax &= (m_inputRegions.at(centreIndex).et() >= m_inputRegions.at(centreIndex + COL_OFFSET - 1).et());
           if (row < (COL_OFFSET - 1)) {
             localMax &= (m_inputRegions.at(centreIndex).et() >= m_inputRegions.at(centreIndex + COL_OFFSET + 1).et());
           }
         } else {
           localMax &= (m_inputRegions.at(centreIndex).et() > m_inputRegions.at(centreIndex - COL_OFFSET).et());
           localMax &= (m_inputRegions.at(centreIndex).et() > m_inputRegions.at(centreIndex - COL_OFFSET - 1).et());
           if (row < (COL_OFFSET - 1)) {
             localMax &= (m_inputRegions.at(centreIndex).et() > m_inputRegions.at(centreIndex - COL_OFFSET + 1).et());
           }
         }
       }
       if (localMax) {
         if (row > 1) {
           if (jetNum < MAX_JETS_OUT) {
             m_localMaxima.at(jetNum) = m_inputRegions.at(centreIndex);
             ++jetNum;
           }
         }
         // Treat row 1 as a separate case. It's not required for jetfinding but
         // is used for vetoing of jets double counted across the eta=0 boundary
         else {
           unsigned phi = m_inputRegions.at(centreIndex).rctPhi();
           m_localMax00.at(phi) = m_inputRegions.at(centreIndex);
         }
       }
       ++centreIndex;
     }
   }
 
   m_numberOfClusters = jetNum;
 }

◆ findProtoClusters()

void L1GctHardwareJetFinder::findProtoClusters ( )

private

Convert local maxima to clusters.

Definition at line 149 of file L1GctHardwareJetFinder.cc.

References dqmiolumiharvest::j, dqmdumpme::k, m_cluster00, m_clusters, m_localMax00, m_localMaxima, m_numberOfClusters, makeProtoJet(), L1GctJetFinderBase::MAX_JETS_OUT, and groupFilesInBlocks::temp.

Referenced by findProtoJets().

                                                {
   m_clusters.clear();
   m_clusters.resize(MAX_JETS_OUT);
   m_cluster00.clear();
   m_cluster00.resize(2);
 
   RegionsVector topJets(MAX_JETS_OUT), botJets(MAX_JETS_OUT);
   std::vector<unsigned> topJetsPosition(MAX_JETS_OUT), botJetsPosition(MAX_JETS_OUT);
   unsigned numberOfTopJets = 0, numberOfBotJets = 0;
 
   // Loop over local maxima
   for (unsigned j = 0; j < m_numberOfClusters; ++j) {
     // Make a proto-jet cluster
     L1GctRegion temp = makeProtoJet(m_localMaxima.at(j));
 
     if (m_localMaxima.at(j).rctPhi() == 0) {
       // Store "top edge" jets
       topJets.at(numberOfTopJets) = temp;
       topJetsPosition.at(numberOfTopJets) = 0;
       for (unsigned k = 0; k < numberOfTopJets; ++k) {
         if (topJets.at(numberOfTopJets).et() >= topJets.at(k).et()) {
           ++topJetsPosition.at(k);
         }
         if (topJets.at(numberOfTopJets).et() <= topJets.at(k).et()) {
           ++topJetsPosition.at(numberOfTopJets);
         }
       }
       ++numberOfTopJets;
     } else {
       // Store "bottom edge" jets
       botJets.at(numberOfBotJets) = temp;
       botJetsPosition.at(numberOfBotJets) = 0;
       for (unsigned k = 0; k < numberOfBotJets; ++k) {
         if (botJets.at(numberOfBotJets).et() >= botJets.at(k).et()) {
           ++botJetsPosition.at(k);
         }
         if (botJets.at(numberOfBotJets).et() <= botJets.at(k).et()) {
           ++botJetsPosition.at(numberOfBotJets);
         }
       }
       ++numberOfBotJets;
     }
   }
   // Now we've found all the proto-jets, copy the best ones to the output array
   //
   // We fill the first half of the array with "bottom jets"
   // and the remainder with "top jets". For cases where
   // we have found too many jets in one phi column,
   // we keep those with the highest Et.
   static const unsigned int MAX_TOPBOT_JETS = MAX_JETS_OUT / 2;
   unsigned pos = 0;
   for (unsigned j = 0; j < numberOfBotJets; ++j) {
     if (botJetsPosition.at(j) < MAX_TOPBOT_JETS) {
       m_clusters.at(pos++) = botJets.at(j);
     }
   }
   pos = MAX_TOPBOT_JETS;
   for (unsigned j = 0; j < numberOfTopJets; ++j) {
     if (topJetsPosition.at(j) < MAX_TOPBOT_JETS) {
       m_clusters.at(pos++) = topJets.at(j);
     }
   }
   // Finally, deal with eta00 maxima
   if (!m_localMax00.at(0).empty())
     m_cluster00.at(0) = makeProtoJet(m_localMax00.at(0));
   if (!m_localMax00.at(1).empty())
     m_cluster00.at(1) = makeProtoJet(m_localMax00.at(1));
 }

◆ findProtoJets()

void L1GctHardwareJetFinder::findProtoJets ( )

private

The first stage of clustering, called by fetchInput()

HERE IS THE JETFINDER CODE.

The first stage of clustering, called by fetchInput()

Definition at line 52 of file L1GctHardwareJetFinder.cc.

References convertClustersToProtoJets(), findLocalMaxima(), and findProtoClusters().

Referenced by fetchInput().

                                            {
   findLocalMaxima();
   findProtoClusters();
   convertClustersToProtoJets();
 }

◆ makeProtoJet()

L1GctRegion L1GctHardwareJetFinder::makeProtoJet ( L1GctRegion localMax )

private

Method to make a single proto-jet.

Definition at line 219 of file L1GctHardwareJetFinder.cc.

References nano_mu_digi_cff::bx, L1CaloRegion::bx(), L1GctJetFinderBase::COL_OFFSET, PVValHelper::eta, L1CaloRegion::gctEta(), L1CaloRegion::gctPhi(), L1GctJetFinderBase::m_ignoreTauVetoBitsForIsolation, L1GctJetFinderBase::m_inputRegions, L1GctJetFinderBase::m_positiveEtaWheel, L1GctJetFinderBase::m_tauIsolationThreshold, L1GctJetFinderBase::m_useImprovedTauAlgo, L1GctRegion::makeProtoJetRegion(), L1CaloRegionDetId::N_ETA, L1GctJetFinderBase::N_EXTRA_REGIONS_ETA00, phi, L1GctRegion::rctEta(), L1CaloRegion::rctPhi(), and groupFilesInBlocks::temp.

Referenced by findProtoClusters().

                                                                      {
   unsigned eta = localMax.gctEta();
   unsigned phi = localMax.gctPhi();
   int16_t bx = localMax.bx();
 
   unsigned localEta = localMax.rctEta();
   unsigned localPhi = localMax.rctPhi();
 
   unsigned etCluster = 0;
   bool ovrFlowOr = false;
   bool tauVetoOr = false;
   unsigned rgnsAboveIsoThreshold = 0;
 
   // check for row00
   const unsigned midEta = (L1CaloRegionDetId::N_ETA) / 2;
   bool wrongEtaWheel = ((!m_positiveEtaWheel) && (eta >= midEta)) || ((m_positiveEtaWheel) && (eta < midEta));
 
   // Which rows are we looking over?
   unsigned rowStart, rowEnd, rowMid;
   static const unsigned row0 = N_EXTRA_REGIONS_ETA00 - 1;
   if (wrongEtaWheel) {
     if (localEta > row0 - 1) {
       rowStart = 0;
       rowMid = 0;
     } else {
       rowStart = row0 - 1 - localEta;
       rowMid = rowStart + 1;
     }
     if (localEta > row0 + 2) {  // Shouldn't happen, but big problems if it does
       rowEnd = 0;
     } else {
       rowEnd = row0 + 2 - localEta;
     }
   } else {
     rowStart = row0 + localEta;
     rowMid = rowStart + 1;
     if (localEta < COL_OFFSET - row0 - 2) {
       rowEnd = rowStart + 3;
     } else {
       rowEnd = COL_OFFSET;
     }
   }
 
   for (unsigned row = rowStart; row < rowEnd; ++row) {
     for (unsigned column = 0; column < 2; ++column) {
       unsigned index = column * COL_OFFSET + row;
       etCluster += m_inputRegions.at(index).et();
       ovrFlowOr |= m_inputRegions.at(index).overFlow();
       // Distinguish between central and tau-flagged jets. Two versions of the algorithm.
       if (m_useImprovedTauAlgo) {
         //===========================================================================================
         // "Old" version of improved tau algorithm tests the tau veto for the central region always
         //  if ((row==(localEta+N_EXTRA_REGIONS_ETA00)) && (column==localPhi)) {
         //    // central region - check the tau veto
         //    tauVetoOr |= m_inputRegions.at(index).tauVeto();
         //  } else {
         //    // other regions - check the tau veto if required
         //    if (!m_ignoreTauVetoBitsForIsolation) {
         //      tauVetoOr |= m_inputRegions.at(index).tauVeto();
         //    }
         //    // check the region energy against the isolation threshold
         //    if (m_inputRegions.at(index).et() >= m_tauIsolationThreshold) {
         //      rgnsAboveIsoThreshold++;
         //    }
         //  }
         //===========================================================================================
 
         // In the hardware, the ignoreTauVetoBitsForIsolation switch ignores all the veto bits,
         // including the one for the central region.
         if (!((row == rowMid) && (column == localPhi))) {
           // non-central region - check the region energy against the isolation threshold
           if (m_inputRegions.at(index).et() >= m_tauIsolationThreshold) {
             rgnsAboveIsoThreshold++;
           }
         }
         // all regions - check the tau veto if required
         if (!m_ignoreTauVetoBitsForIsolation) {
           tauVetoOr |= m_inputRegions.at(index).tauVeto();
         }
         // End of improved tau algorithm
       } else {
         // Original tau algorithm
         tauVetoOr |= m_inputRegions.at(index).tauVeto();
       }
     }
   }
   // Encode the number of towers over threshold for the isolated tau algorithm
   bool tauFeatureBit = false;
   if (m_useImprovedTauAlgo) {
     tauVetoOr |= (rgnsAboveIsoThreshold > 1);
     tauFeatureBit |= (rgnsAboveIsoThreshold == 1);
   }
 
   L1GctRegion temp(L1GctRegion::makeProtoJetRegion(etCluster, ovrFlowOr, tauVetoOr, tauFeatureBit, eta, phi, bx));
   return temp;
 }

◆ maxRegionsIn()

unsigned L1GctHardwareJetFinder::maxRegionsIn ( ) const

inlineoverrideprotectedvirtual

*** End of event data ***

Reimplemented from L1GctJetFinderBase.

Definition at line 40 of file L1GctHardwareJetFinder.h.

References MAX_REGIONS_IN.

40 { return MAX_REGIONS_IN; }

L1GctHardwareJetFinder::MAX_REGIONS_IN

static const unsigned int MAX_REGIONS_IN

The real jetFinders must define these constants.

Definition: L1GctHardwareJetFinder.h:46

◆ nCols()

unsigned L1GctHardwareJetFinder::nCols ( ) const

inlineoverrideprotectedvirtual

Reimplemented from L1GctJetFinderBase.

Definition at line 42 of file L1GctHardwareJetFinder.h.

References N_COLS.

42 { return N_COLS; }

L1GctHardwareJetFinder::N_COLS

static const unsigned int N_COLS

Definition: L1GctHardwareJetFinder.h:47

◆ process()

void L1GctHardwareJetFinder::process ( )

overridevirtual

process the data, fill output buffers

Implements L1GctJetFinderBase.

Definition at line 40 of file L1GctHardwareJetFinder.cc.

References L1GctJetFinderBase::doEnergySums(), L1GctJetFinderBase::fetchProtoJetsFromNeighbour(), findJets(), L1GctJetFinderBase::setupOk(), L1GctJetFinderBase::sortJets(), and L1GctJetFinderBase::TOPBOT.

                                      {
   if (setupOk()) {
     fetchProtoJetsFromNeighbour(TOPBOT);
     findJets();
     sortJets();
     doEnergySums();
   }
 }

◆ reset()

void L1GctHardwareJetFinder::reset ( void )

virtual

include additional reset functionality

Definition at line 32 of file L1GctHardwareJetFinder.cc.

References L1GctProcessor::reset().

Referenced by L1GctHardwareJetFinder().

32 { L1GctJetFinderBase::reset(); }

L1GctProcessor::reset

void reset()

complete reset of processor

Definition: L1GctProcessor.h:28

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<<	(	std::ostream &	os,
		const L1GctHardwareJetFinder &	algo
	)

friend

Overload << operator.

Definition at line 25 of file L1GctHardwareJetFinder.cc.

                                                                            {
   os << "===L1GctHardwareJetFinder===" << std::endl;
   const L1GctJetFinderBase* temp = &algo;
   os << *temp;
   return os;
 }

Member Data Documentation

◆ CENTRAL_COL0

const unsigned int L1GctHardwareJetFinder::CENTRAL_COL0 = 0

staticprivate

Definition at line 48 of file L1GctHardwareJetFinder.h.

Referenced by centralCol0(), and L1GctHardwareJetFinder().

◆ m_cluster00

RegionsVector L1GctHardwareJetFinder::m_cluster00

private

Definition at line 60 of file L1GctHardwareJetFinder.h.

Referenced by findFinalClusters(), and findProtoClusters().

◆ m_clusters

RegionsVector L1GctHardwareJetFinder::m_clusters

private

Each local maximum becomes a cluster.

Definition at line 53 of file L1GctHardwareJetFinder.h.

Referenced by convertClustersToOutputJets(), convertClustersToProtoJets(), findFinalClusters(), and findProtoClusters().

◆ m_localMax00

RegionsVector L1GctHardwareJetFinder::m_localMax00

private

Definition at line 59 of file L1GctHardwareJetFinder.h.

Referenced by findLocalMaxima(), and findProtoClusters().

◆ m_localMaxima

RegionsVector L1GctHardwareJetFinder::m_localMaxima

private

Local vectors used during both stages of clustering.

Definition at line 51 of file L1GctHardwareJetFinder.h.

Referenced by findLocalMaxima(), and findProtoClusters().

◆ m_numberOfClusters

unsigned L1GctHardwareJetFinder::m_numberOfClusters

private

The number of local Maxima/clusters found at each stage of clustering.

Definition at line 56 of file L1GctHardwareJetFinder.h.

Referenced by findLocalMaxima(), and findProtoClusters().

◆ MAX_REGIONS_IN

const unsigned int L1GctHardwareJetFinder::MAX_REGIONS_IN

staticprivate

Initial value:

=

(((L1CaloRegionDetId::N_ETA) / 2) + N_EXTRA_REGIONS_ETA00) * L1GctHardwareJetFinder::N_COLS

The real jetFinders must define these constants.

Dependent on number of rows and columns.

Definition at line 46 of file L1GctHardwareJetFinder.h.

Referenced by maxRegionsIn().

◆ N_COLS

const unsigned int L1GctHardwareJetFinder::N_COLS = 2

staticprivate

Definition at line 47 of file L1GctHardwareJetFinder.h.

Referenced by nCols().

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ L1GctHardwareJetFinder()

◆ ~L1GctHardwareJetFinder()

Member Function Documentation

◆ centralCol0()

◆ convertClustersToOutputJets()

◆ convertClustersToProtoJets()

◆ fetchInput()

◆ findFinalClusters()

◆ findJets()

◆ findLocalMaxima()

◆ findProtoClusters()

◆ findProtoJets()

◆ makeProtoJet()

◆ maxRegionsIn()

◆ nCols()

◆ process()

◆ reset()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ CENTRAL_COL0

◆ m_cluster00

◆ m_clusters

◆ m_localMax00

◆ m_localMaxima

◆ m_numberOfClusters

◆ MAX_REGIONS_IN

◆ N_COLS