L1CaloEmCand Class Reference

Level-1 Region Calorimeter Trigger EM candidate. More...

#include <L1CaloEmCand.h>

Public Member Functions
int16_t	bx () const
	get bunch-crossing index More...
bool	empty () const
	is there any information in the candidate More...
unsigned	index () const
	get index on cable More...
bool	isolated () const
	which stream did this come from More...
	L1CaloEmCand ()
	default constructor (for vector initialisation etc.) More...
	L1CaloEmCand (uint16_t data, unsigned crate, bool iso)
	construct from raw data, no source - used by TextToDigi More...
	L1CaloEmCand (uint16_t data, unsigned crate, bool iso, uint16_t index, int16_t bx, bool dummy)
	L1CaloEmCand (unsigned rank, unsigned region, unsigned card, unsigned crate, bool iso)
	construct from components for emulation More...
	L1CaloEmCand (unsigned rank, unsigned region, unsigned card, unsigned crate, bool iso, uint16_t index, int16_t bx)
	construct from components for emulation (including index) More...
int	operator!= (const L1CaloEmCand &c) const
	inequality operator More...
int	operator== (const L1CaloEmCand &c) const
	equality operator, including rank, isolation, position More...
unsigned	rank () const
	get rank bits More...
uint16_t	raw () const
	get the raw data More...
unsigned	rctCard () const
	get RCT receiver card More...
unsigned	rctCrate () const
	get RCT crate More...
unsigned	rctRegion () const
	get RCT region ID More...
L1CaloRegionDetId	regionId () const
	get DetID object More...
void	setBx (int16_t bx)
	set BX More...
	~L1CaloEmCand ()
	destructor More...

Private Attributes
int16_t	m_bx
uint16_t	m_data
uint16_t	m_index
bool	m_iso
uint16_t	m_rctCrate

Detailed Description

Level-1 Region Calorimeter Trigger EM candidate.

Author

Jim Brooke

Date

June 2006

Definition at line 18 of file L1CaloEmCand.h.

Constructor & Destructor Documentation

L1CaloEmCand::L1CaloEmCand

(

)

default constructor (for vector initialisation etc.)

Definition at line 11 of file L1CaloEmCand.cc.

                           :
  m_data(0),
  m_rctCrate(0),
  m_iso(false),
  m_index(0),
  m_bx(0)
{ 

}

L1CaloEmCand::L1CaloEmCand	(	uint16_t	data,
		unsigned	crate,
		bool	iso
	)

construct from raw data, no source - used by TextToDigi

Definition at line 23 of file L1CaloEmCand.cc.

                                                                  :
   m_data(data),
   m_rctCrate(crate),
   m_iso(iso),
   m_index(0),
   m_bx(0)
 {
 }

L1CaloEmCand::L1CaloEmCand	(	uint16_t	data,
		unsigned	crate,
		bool	iso,
		uint16_t	index,
		int16_t	bx,
		bool	dummy
	)

construct from raw data with source - used by GCT unpacker last bool argument is a hack to distinguish this constructor from the next one!

Definition at line 34 of file L1CaloEmCand.cc.

                                                                                                           :
   m_data(data),
   m_rctCrate(crate),
   m_iso(iso),
   m_index(index),
   m_bx(bx)
 {
 }

L1CaloEmCand::L1CaloEmCand	(	unsigned	rank,
		unsigned	region,
		unsigned	card,
		unsigned	crate,
		bool	iso
	)

construct from components for emulation

Definition at line 44 of file L1CaloEmCand.cc.

References m_data.

                                                                                                  : 
  m_data(0), // over-ridden below
  m_rctCrate(crate),
  m_iso(iso),
  m_index(0),
  m_bx(0)

{
  m_data = (rank & 0x3f) + ((region & 0x1)<<6) + ((card & 0x7)<<7); 
}

L1CaloEmCand::L1CaloEmCand	(	unsigned	rank,
		unsigned	region,
		unsigned	card,
		unsigned	crate,
		bool	iso,
		uint16_t	index,
		int16_t	bx
	)

construct from components for emulation (including index)

Definition at line 56 of file L1CaloEmCand.cc.

References m_data.

                                                                                                                              : 
  m_data(0), // over-ridden below
  m_rctCrate(crate),
  m_iso(iso),
  m_index(index),
  m_bx(bx)
{
  m_data = (rank & 0x3f) + ((region & 0x1)<<6) + ((card & 0x7)<<7); 
}

L1CaloEmCand::~L1CaloEmCand

(

)

destructor

Definition at line 67 of file L1CaloEmCand.cc.

{ } 

Member Function Documentation

int16_t L1CaloEmCand::bx ( ) const

inline

get bunch-crossing index

Definition at line 62 of file L1CaloEmCand.h.

References m_bx.

Referenced by operator<<(), setBx(), and GctFormatTranslateMCLegacy::writeRctEmCandBlocks().

{ return m_bx; }

bool L1CaloEmCand::empty ( ) const

inline

is there any information in the candidate

Definition at line 77 of file L1CaloEmCand.h.

References rank().

Referenced by operator==(), Vispa.Gui.VispaWidget.TextField::setAutosizeFont(), and Vispa.Gui.VispaWidget.TextField::setAutotruncate().

{ return (rank() == 0); }

unsigned L1CaloEmCand::index ( ) const

inline

get index on cable

Definition at line 59 of file L1CaloEmCand.h.

References m_index.

Referenced by BeautifulSoup.PageElement::_invert(), operator<<(), L1GctElectronSorter::setInputEmCand(), and GctFormatTranslateMCLegacy::writeRctEmCandBlocks().

{ return m_index; }

bool L1CaloEmCand::isolated ( ) const

inline

which stream did this come from

Definition at line 56 of file L1CaloEmCand.h.

References m_iso.

Referenced by operator<<(), operator==(), l1t::stage1::RCTEmUnpacker::unpack(), and GctFormatTranslateMCLegacy::writeRctEmCandBlocks().

{ return m_iso; }

int L1CaloEmCand::operator!= ( const L1CaloEmCand &  c ) const

inline

inequality operator

Definition at line 74 of file L1CaloEmCand.h.

References EnergyCorrector::c.

{ return !(*this == c); }

int L1CaloEmCand::operator== ( const L1CaloEmCand &  c ) const

inline

equality operator, including rank, isolation, position

Definition at line 71 of file L1CaloEmCand.h.

References empty(), isolated(), m_data, m_iso, m_rctCrate, raw(), rctCrate(), and regionId().

{ return ((m_data==c.raw() && m_iso==c.isolated() && m_rctCrate==c.rctCrate() && this->regionId()==c.regionId()) || (this->empty() && c.empty())); }

unsigned L1CaloEmCand::rank ( ) const

inline

get rank bits

Definition at line 44 of file L1CaloEmCand.h.

References m_data.

Referenced by L1RCTTestAnalyzer::compareEmCands(), empty(), L1GctEmCand::L1GctEmCand(), operator<<(), l1t::stage1::RCTEmUnpacker::unpack(), and GctFormatTranslateMCLegacy::writeRctEmCandBlocks().

{ return m_data & 0x3f; }

uint16_t L1CaloEmCand::raw ( ) const

inline

get the raw data

Definition at line 41 of file L1CaloEmCand.h.

References m_data.

Referenced by operator==().

{ return m_data; }

unsigned L1CaloEmCand::rctCard ( ) const

inline

get RCT receiver card

Definition at line 47 of file L1CaloEmCand.h.

References m_data.

Referenced by operator<<(), regionId(), and GctFormatTranslateMCLegacy::writeRctEmCandBlocks().

{ return (m_data>>7) & 0x7; }

unsigned L1CaloEmCand::rctCrate ( ) const

inline

get RCT crate

Definition at line 53 of file L1CaloEmCand.h.

References m_rctCrate.

Referenced by operator<<(), operator==(), regionId(), L1GctElectronSorter::setInputEmCand(), L1GlobalCaloTrigger::setIsoEm(), L1GlobalCaloTrigger::setNonIsoEm(), L1GlobalCaloTrigger::sorterNo(), and GctFormatTranslateMCLegacy::writeRctEmCandBlocks().

{ return m_rctCrate; }

unsigned L1CaloEmCand::rctRegion ( ) const

inline

get RCT region ID

Definition at line 50 of file L1CaloEmCand.h.

References m_data.

Referenced by operator<<(), regionId(), and GctFormatTranslateMCLegacy::writeRctEmCandBlocks().

{ return (m_data>>6) & 0x1; }

L1CaloRegionDetId L1CaloEmCand::regionId ( ) const

inline

get DetID object

Definition at line 65 of file L1CaloEmCand.h.

References rctCard(), rctCrate(), and rctRegion().

Referenced by L1GctEmCand::L1GctEmCand(), operator==(), and l1t::stage1::RCTEmUnpacker::unpack().

{ return L1CaloRegionDetId(rctCrate(),rctCard(),rctRegion()); }

void L1CaloEmCand::setBx

(

int16_t

bx

)

set BX

Definition at line 69 of file L1CaloEmCand.cc.

References bx(), and m_bx.

Referenced by L1GctElectronSorter::setupObjects().

                                   {
  m_bx = bx;
}

Member Data Documentation

int16_t L1CaloEmCand::m_bx

private

Definition at line 90 of file L1CaloEmCand.h.

Referenced by bx(), and setBx().

uint16_t L1CaloEmCand::m_data

private

Definition at line 83 of file L1CaloEmCand.h.

Referenced by L1CaloEmCand(), operator==(), rank(), raw(), rctCard(), and rctRegion().

uint16_t L1CaloEmCand::m_index

private

Definition at line 89 of file L1CaloEmCand.h.

Referenced by index().

bool L1CaloEmCand::m_iso

private

Definition at line 88 of file L1CaloEmCand.h.

Referenced by isolated(), and operator==().

uint16_t L1CaloEmCand::m_rctCrate

private

Definition at line 87 of file L1CaloEmCand.h.

Referenced by operator==(), and rctCrate().