Represents the final stage of L1 jet processing. More...

#include <L1GctJetFinalStage.h>

Inheritance diagram for L1GctJetFinalStage:

Public Types
typedef Pipeline< L1GctJetCand >	JetPipeline

typedef std::vector< L1GctJetCand >	JetVector

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

JetVector	getCentralJets () const
	get the central jets output data More...

JetVector	getForwardJets () const
	get the forward jets output data More...

JetVector	getInputCentralJets () const
	get the central jets input data More...

JetVector	getInputForwardJets () const
	get the forward jets input data More...

JetVector	getInputTauJets () const
	get the tau jets input data More...

JetVector	getTauJets () const
	get the tau jets output data More...

	L1GctJetFinalStage (const std::vector< L1GctWheelJetFpga * > &m_wheelFpgas)
	Takes a vector of 2 wheel jet FPGA pointers, with which to get input data from. More...

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

void	setInputCentralJet (int i, const L1GctJetCand &jet)
	set the central jets input data More...

void	setInputForwardJet (int i, const L1GctJetCand &jet)
	set the forward jets input data More...

void	setInputTauJet (int i, const L1GctJetCand &jet)
	set the tau jets input data More...

bool	setupOk () const

	~L1GctJetFinalStage ()

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

Static Public Attributes
static const unsigned int	MAX_WHEEL_FPGAS = 2
	Max number of wheel FPGA pointers. More...

Protected Member Functions
virtual void	resetPipelines ()

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

virtual void	setupObjects ()
	Initialise inputs with null objects for the correct bunch crossing if required. 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	storeJets (JetVector &storageVector, const JetVector &jets, unsigned short iWheel)
	Enters jets into the specified storageVector, according to which wheel card we are taking them from. More...

Private Attributes
JetPipeline	m_centralJets

L1GctJetSorter *	m_centralJetSorter
	Jet sorters. More...

JetPipeline	m_forwardJets

L1GctJetSorter *	m_forwardJetSorter

JetVector	m_inputCentralJets

JetVector	m_inputForwardJets

JetVector	m_inputTauJets

bool	m_setupOk

JetPipeline	m_tauJets

L1GctJetSorter *	m_tauJetSorter

std::vector< L1GctWheelJetFpga * >	m_wheelFpgas
	wheel jet FPGAs More...

Static Private Attributes
static const int	MAX_JETS_IN = L1GctJetFinalStage::MAX_WHEEL_FPGAS*L1GctWheelJetFpga::MAX_JETS_OUT
	Max number of jets of each type coming in. More...

static const int	MAX_JETS_OUT = 4
	Max number of jets of each type going out. More...

Friends
std::ostream &	operator<< (std::ostream &os, const L1GctJetFinalStage &fpga)
	Overload << operator. More...

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

Detailed Description

Represents the final stage of L1 jet processing.

Takes as input the jet data from the two Wheel Jet FPGAs and outputs the top four of each type of jet - central, forward, and tau - for the whole of the CMS detector.

Author: Jim Brooke & Robert Frazier

Date: June 2006

Definition at line 25 of file L1GctJetFinalStage.h.

Member Typedef Documentation

typedef Pipeline<L1GctJetCand> L1GctJetFinalStage::JetPipeline

Definition at line 29 of file L1GctJetFinalStage.h.

typedef std::vector<L1GctJetCand> L1GctJetFinalStage::JetVector

Definition at line 28 of file L1GctJetFinalStage.h.

Constructor & Destructor Documentation

L1GctJetFinalStage::L1GctJetFinalStage ( const std::vector< L1GctWheelJetFpga * > & m_wheelFpgas )

Takes a vector of 2 wheel jet FPGA pointers, with which to get input data from.

Definition at line 16 of file L1GctJetFinalStage.cc.

References i, m_setupOk, L1GctProcessor::m_verbose, m_wheelFpgas, and MAX_WHEEL_FPGAS.

                                                                                      :
   L1GctProcessor(),
   m_wheelFpgas(wheelFpgas),
   m_centralJetSorter(new L1GctJetSorter()),
   m_forwardJetSorter(new L1GctJetSorter()),
   m_tauJetSorter(new L1GctJetSorter()),
   m_inputCentralJets(MAX_JETS_IN),
   m_inputForwardJets(MAX_JETS_IN),
   m_inputTauJets(MAX_JETS_IN),
   m_centralJets(MAX_JETS_OUT),
   m_forwardJets(MAX_JETS_OUT),
   m_tauJets(MAX_JETS_OUT),
   m_setupOk(true)
 {
   if(m_wheelFpgas.size() != MAX_WHEEL_FPGAS)
     {
       m_setupOk = false;
       if (m_verbose) {
     edm::LogWarning("L1GctSetupError")
       << "L1GctJetFinalStage::L1GctJetFinalStage() : Jet Final Stage instance has been incorrectly constructed!\n"
       << "This class needs " << MAX_WHEEL_FPGAS << " wheel jet FPGA pointers, yet only " << m_wheelFpgas.size()
       << " wheel jet FPGA pointers are present.\n";
       }
     }
   
   for(unsigned int i=0; i < MAX_WHEEL_FPGAS; ++i)
     {
       if(m_wheelFpgas.at(i) == 0)
     {
       m_setupOk = false;
       if (m_verbose) {
         edm::LogWarning("L1GctSetupError")
           << "L1GctJetFinalStage::L1GctJetFinalStage() : Jet Final Stage instance has been incorrectly constructed!\n"
           << "Wheel jet FPGA pointer " << i << " has not been set!\n";
       }
     }
     }  
   if (!m_setupOk && m_verbose) {
     edm::LogError("L1GctSetupError") << "L1GctJetFinalStage has been incorrectly constructed";
   }
 }

L1GctJetFinalStage::~L1GctJetFinalStage ( )

Definition at line 58 of file L1GctJetFinalStage.cc.

References m_centralJetSorter, m_forwardJetSorter, and m_tauJetSorter.

 {
   if (m_centralJetSorter != 0) delete m_centralJetSorter;
   if (m_forwardJetSorter != 0) delete m_forwardJetSorter;
   if (m_tauJetSorter != 0)     delete m_tauJetSorter;
 }

Member Function Documentation

void L1GctJetFinalStage::fetchInput ( )

virtual

get input data from sources

Implements L1GctProcessor.

Definition at line 124 of file L1GctJetFinalStage.cc.

References m_inputCentralJets, m_inputForwardJets, m_inputTauJets, m_setupOk, m_wheelFpgas, MAX_WHEEL_FPGAS, and storeJets().

Referenced by L1GlobalCaloTrigger::bxProcess().

 {
   if (m_setupOk) {
     // We fetch and store the negative eta jets first. This ensures they have
     // higher priority when sorting equal rank jets.
     for(unsigned short iWheel=0; iWheel < MAX_WHEEL_FPGAS; ++iWheel)
       {
     storeJets(m_inputCentralJets, m_wheelFpgas.at(iWheel)->getCentralJets(), iWheel);
     storeJets(m_inputForwardJets, m_wheelFpgas.at(iWheel)->getForwardJets(), iWheel);
     storeJets(m_inputTauJets, m_wheelFpgas.at(iWheel)->getTauJets(), iWheel);
       }
   }
 }

JetVector L1GctJetFinalStage::getCentralJets ( ) const

inline

get the central jets output data

Definition at line 53 of file L1GctJetFinalStage.h.

References m_centralJets.

Referenced by L1GlobalCaloTrigger::getCentralJets().

JetVector L1GctJetFinalStage::getForwardJets ( ) const

inline

get the forward jets output data

Definition at line 54 of file L1GctJetFinalStage.h.

References m_forwardJets.

Referenced by L1GlobalCaloTrigger::getForwardJets().

JetVector L1GctJetFinalStage::getInputCentralJets ( ) const

inline

get the central jets input data

Definition at line 49 of file L1GctJetFinalStage.h.

References m_inputCentralJets.

JetVector L1GctJetFinalStage::getInputForwardJets ( ) const

inline

get the forward jets input data

Definition at line 50 of file L1GctJetFinalStage.h.

References m_inputForwardJets.

JetVector L1GctJetFinalStage::getInputTauJets ( ) const

inline

get the tau jets input data

Definition at line 51 of file L1GctJetFinalStage.h.

References m_inputTauJets.

JetVector L1GctJetFinalStage::getTauJets ( ) const

inline

get the tau jets output data

Definition at line 55 of file L1GctJetFinalStage.h.

References m_tauJets.

Referenced by L1GlobalCaloTrigger::getTauJets().

void L1GctJetFinalStage::process ( )

virtual

process the data, fill output buffers

Implements L1GctProcessor.

Definition at line 138 of file L1GctJetFinalStage.cc.

References L1GctProcessor::bxRel(), L1GctJetSorter::getSortedJets(), m_centralJets, m_centralJetSorter, m_forwardJets, m_forwardJetSorter, m_inputCentralJets, m_inputForwardJets, m_inputTauJets, m_setupOk, m_tauJets, m_tauJetSorter, L1GctJetSorter::setJets(), and L1GctProcessor::Pipeline< T >::store().

 {
   if (m_setupOk) {
     //Process jets
     m_centralJetSorter->setJets(m_inputCentralJets);
     m_forwardJetSorter->setJets(m_inputForwardJets);
     m_tauJetSorter->setJets(m_inputTauJets);
 
     m_centralJets.store(m_centralJetSorter->getSortedJets(), bxRel());
     m_forwardJets.store(m_forwardJetSorter->getSortedJets(), bxRel());
     m_tauJets.store    (m_tauJetSorter->getSortedJets(),     bxRel());
   }
 }

void L1GctJetFinalStage::resetPipelines ( )

protectedvirtual

Implements L1GctProcessor.

Definition at line 118 of file L1GctJetFinalStage.cc.

References m_centralJets, m_forwardJets, m_tauJets, L1GctProcessor::numOfBx(), and L1GctProcessor::Pipeline< T >::reset().

                                         {
   m_centralJets.reset(numOfBx());
   m_forwardJets.reset(numOfBx());
   m_tauJets.reset    (numOfBx());
 }

void L1GctJetFinalStage::resetProcessor ( )

protectedvirtual

Separate reset methods for the processor itself and any data stored in pipelines.

Implements L1GctProcessor.

Definition at line 107 of file L1GctJetFinalStage.cc.

References m_inputCentralJets, m_inputForwardJets, m_inputTauJets, and MAX_JETS_IN.

                                         {
   //Clear all jet data
   m_inputCentralJets.clear();
   m_inputForwardJets.clear();
   m_inputTauJets.clear();
   //Resize the vectors
   m_inputCentralJets.resize(MAX_JETS_IN);
   m_inputForwardJets.resize(MAX_JETS_IN);
   m_inputTauJets.resize(MAX_JETS_IN);
 }

void L1GctJetFinalStage::setInputCentralJet	(	int	i,
		const L1GctJetCand &	jet
	)

set the central jets input data

Definition at line 152 of file L1GctJetFinalStage.cc.

References L1GctJetCand::bx(), L1GctProcessor::bxAbs(), L1GctJetCand::empty(), L1GctJetCand::isCentral(), metsig::jet, m_inputCentralJets, and MAX_JETS_IN.

 {
   if( ((jet.isCentral() && jet.bx() == bxAbs()) || jet.empty())
       && (i >= 0 && i < MAX_JETS_IN))
   {
     m_inputCentralJets.at(i) = jet;
   }
 }

void L1GctJetFinalStage::setInputForwardJet	(	int	i,
		const L1GctJetCand &	jet
	)

set the forward jets input data

Definition at line 161 of file L1GctJetFinalStage.cc.

References L1GctJetCand::bx(), L1GctProcessor::bxAbs(), L1GctJetCand::empty(), L1GctJetCand::isForward(), metsig::jet, m_inputForwardJets, and MAX_JETS_IN.

 {
   if( ((jet.isForward() && jet.bx() == bxAbs()) || jet.empty())
      && (i >= 0 && i < MAX_JETS_IN))
   {
     m_inputForwardJets.at(i) = jet;
   }
 }

void L1GctJetFinalStage::setInputTauJet	(	int	i,
		const L1GctJetCand &	jet
	)

set the tau jets input data

Definition at line 170 of file L1GctJetFinalStage.cc.

References L1GctJetCand::bx(), L1GctProcessor::bxAbs(), L1GctJetCand::empty(), L1GctJetCand::isTau(), metsig::jet, m_inputTauJets, and MAX_JETS_IN.

 {
   if( ((jet.isTau() && jet.bx() == bxAbs()) || jet.empty())
     && (i >= 0 && i < MAX_JETS_IN))
   {
     m_inputTauJets.at(i) = jet;
   }
 }

virtual void L1GctJetFinalStage::setupObjects ( )

inlineprotectedvirtual

Initialise inputs with null objects for the correct bunch crossing if required.

Implements L1GctProcessor.

Definition at line 65 of file L1GctJetFinalStage.h.

65 {}

bool L1GctJetFinalStage::setupOk ( ) const

inline

Definition at line 57 of file L1GctJetFinalStage.h.

References m_setupOk.

Referenced by L1GlobalCaloTrigger::setupOk().

57 { return m_setupOk; }

L1GctJetFinalStage::m_setupOk

bool m_setupOk

Definition: L1GctJetFinalStage.h:90

void L1GctJetFinalStage::storeJets	(	JetVector &	storageVector,
		const JetVector &	jets,
		unsigned short	iWheel
	)

private

Enters jets into the specified storageVector, according to which wheel card we are taking them from.

Definition at line 179 of file L1GctJetFinalStage.cc.

References L1GctProcessor::bxAbs(), and L1GctWheelJetFpga::MAX_JETS_OUT.

Referenced by fetchInput().

 {
   for(unsigned short iJet = 0; iJet < L1GctWheelJetFpga::MAX_JETS_OUT; ++iJet)
   {
     if (jets.at(iJet).bx() == bxAbs()) {
       storageVector.at((iWheel*L1GctWheelJetFpga::MAX_JETS_OUT) + iJet) = jets.at(iJet);
     }
   }
 }

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	os,
		const L1GctJetFinalStage &	fpga
	)

friend

Overload << operator.

Definition at line 65 of file L1GctJetFinalStage.cc.

 {
   os << "===L1GctJetFinalStage===" << endl;
   os << "No. of Wheel Jet FPGAs " << fpga.m_wheelFpgas.size() << std::endl;
   for(unsigned i=0; i < fpga.m_wheelFpgas.size(); i++)
     {
       os << "WheelJetFpga* " << i << " = " << fpga.m_wheelFpgas.at(i) << endl;
     } 
   os << "No. of input central Jets " << fpga.m_inputCentralJets.size() << std::endl;
   for(unsigned i=0; i < fpga.m_inputCentralJets.size(); i++)
     {
       os << fpga.m_inputCentralJets.at(i);
     } 
   os << "No. of input forward Jets " << fpga.m_inputForwardJets.size() << std::endl;
   for(unsigned i=0; i < fpga.m_inputForwardJets.size(); i++)
     {
       os << fpga.m_inputForwardJets.at(i);
     } 
   os << "No. of raw tau Jets " << fpga.m_inputTauJets.size() << std::endl;
   for(unsigned i=0; i < fpga.m_inputTauJets.size(); i++)
     {
       os << fpga.m_inputTauJets.at(i);
     } 
   os << "No. of output central Jets " << fpga.m_centralJets.contents.size() << std::endl;
   for(unsigned i=0; i < fpga.m_centralJets.contents.size(); i++)
     {
       os << fpga.m_centralJets.contents.at(i);
     } 
   os << "No. of output forward Jets " << fpga.m_forwardJets.contents.size() << std::endl;
   for(unsigned i=0; i < fpga.m_forwardJets.contents.size(); i++)
     {
       os << fpga.m_forwardJets.contents.at(i);
     } 
   os << "No. of output tau Jets " << fpga.m_tauJets.contents.size() << std::endl;
   for(unsigned i=0; i < fpga.m_tauJets.contents.size(); i++)
     {
       os << fpga.m_tauJets.contents.at(i);
     } 
   os << endl;
   return os;
 }