L1CaloRdoEfexTob Class Reference

L1CaloRdoFexTob subclass for eFEX EM/Tau TOBs or XTOBs. More...

#include <L1CaloRdoEfexTob.h>

Inheritance diagram for L1CaloRdoEfexTob:

Collaboration diagram for L1CaloRdoEfexTob:

Public Types
enum	TobType {   Invalid , EM , Tau , LargeJet ,   SmallJet , Energy , Muon }
enum	TobSource {   EfexTob , EfexXtob , JfexTob , JfexXtob ,   GfexTob , GfexXtob , Ph1Topo }

Public Member Functions
	L1CaloRdoEfexTob (int crate, int module, int eta, int phi, int numSlices, TobType tobType, TobSource source, int id=0, int fibre=0, int tobSeq=0)
virtual void	infoSpecific () const override
int	getClusterEt (size_t slice) const
	Return 12 bit (TOB) or 16 bit (XTOB) cluster Et (from the RDO value).
int	getClusterEt () const
int	getIsol (size_t slice) const
	Return three 2 bit isolation hits (packed into bits 18-23 of the RDO flag).
int	getIsol () const
bool	sameDatum (const L1CaloRdoFexTob &rhs) const
bool	sameDatum (const L1CaloRdo &rhs) const
virtual std::string	getType () const override
TobType	getTobType () const
std::string	getTobTypeString () const
int	getTobID () const
bool	getIsEM () const
bool	getIsTau () const
bool	getIsJet () const
bool	getIsLargeJet () const
bool	getIsSmallJet () const
bool	getIsEnergy () const
bool	getIsMuon () const
TobSource	getTobSource () const
std::string	getTobSourceString () const
bool	getIsTob () const
bool	getIsXtob () const
bool	getIsEfex () const
bool	getIsJfex () const
bool	getIsGfex () const
bool	getIsTopo () const
int	getFibre () const
int	getTobSeq () const
int	getCrate () const
int	getModule () const
int	getEta () const
int	getPhi () const
int	getLayer () const
int	getValue (size_t slice) const
int	getValue () const
int	getFlag (size_t slice) const
int	getFlag () const
int	getL1aPos () const
L1CaloDetectorRegion	getRegion () const
const std::list< L1CaloRdoRodInfo >::const_iterator &	getRodInfo () const
int	getModuleStatus () const
bool	getModuleErrorGlinkParity () const
bool	getModuleErrorGlinkProtocol () const
bool	getModuleErrorBcnMismatch () const
bool	getModuleErrorFifoOverflow () const
bool	getModuleErrorSpecific () const
bool	getModuleErrorUnused () const
bool	getModuleErrorGlinkTimeout () const
bool	getModuleErrorGlinkDown () const
size_t	numSlices () const
void	setValue (int val, size_t slice)
void	setValue (int val)
void	setFlag (int flag, size_t slice)
void	setFlag (int flag)
void	setRodInfo (std::list< L1CaloRdoRodInfo >::const_iterator &rodInfo)
void	info () const

Protected Member Functions
void	setRegion (const L1CaloDetectorRegion &region)

Private Attributes
TobType	m_tobType
TobSource	m_source
int	m_id
int	m_fibre
int	m_tobSeq
int	m_crate
int	m_module
int	m_eta
int	m_phi
int	m_layer
std::vector< int >	m_vals
std::vector< int >	m_flags
int	m_l1aPos
L1CaloDetectorRegion	m_region
std::list< L1CaloRdoRodInfo >::const_iterator	m_rodInfo

Detailed Description

L1CaloRdoFexTob subclass for eFEX EM/Tau TOBs or XTOBs.

These may come from eFEX or Ph1Topo inputs. The available flags are different in these two cases. The RDO object has two 32 bit words: value and flag. The TOBs and XTOBs differ mainly in the number of bits used for the Et value (12 vs 16). We store the Et in the value word and everything else in the flag keeping all the fields in their location in the hardware format.

The id, fibre and tobSeq values were used in Run 2 for topo and for distinguishing different sources of the same TOB (eg here from FEX readout vs Ph1Topo readout perhaps).

Definition at line 9 of file L1CaloRdoEfexTob.h.

Member Enumeration Documentation

TobSource

enum L1CaloRdoFexTob::TobSource

inherited

Enumerator
EfexTob
EfexXtob
JfexTob
JfexXtob
GfexTob
GfexXtob
Ph1Topo

Definition at line 15 of file L1CaloRdoFexTob.h.

{ EfexTob, EfexXtob, JfexTob, JfexXtob, GfexTob, GfexXtob, Ph1Topo };

TobType

enum L1CaloRdoFexTob::TobType

inherited

Enumerator
Invalid
EM
Tau
LargeJet
SmallJet
Energy
Muon

Definition at line 14 of file L1CaloRdoFexTob.h.

{ Invalid, EM, Tau, LargeJet, SmallJet, Energy, Muon };

Constructor & Destructor Documentation

L1CaloRdoEfexTob()

L1CaloRdoEfexTob::L1CaloRdoEfexTob	(	int	crate,
		int	module,
		int	eta,
		int	phi,
		int	numSlices,
		TobType	tobType,
		TobSource	source,
		int	id = 0,
		int	fibre = 0,
		int	tobSeq = 0 )

Definition at line 30 of file L1CaloRdoEfexTob.cxx.

: L1CaloRdoFexTob( crate, module, eta, phi, numSlices, tobType, source, id, fibre, tobSeq )
{
   int fpga = (eta-1)/4;
   if ( fpga < 0 ) 
      fpga = 0;
   if ( fpga > 3 )
      fpga = 3;
   int localeta = eta-4*fpga;
   EfexCellMapping::roiType roi = EfexCellMapping::Roi;
   EfexCellMapping map( roi, crate, module, fpga, localeta, phi );
   setRegion( map.getDetectorRegion() );
}

Member Function Documentation

getClusterEt() [1/2]

int L1CaloRdoEfexTob::getClusterEt

(

)

const

Definition at line 80 of file L1CaloRdoEfexTob.cxx.

{
   return getClusterEt( getL1aPos() );
}

getClusterEt() [2/2]

int L1CaloRdoEfexTob::getClusterEt

(

size_t

slice

)

const

Return 12 bit (TOB) or 16 bit (XTOB) cluster Et (from the RDO value).

Definition at line 74 of file L1CaloRdoEfexTob.cxx.

{
   return ( getValue( slice ) & 0xffff );
}

getCrate()

int L1CaloRdo::getCrate ( ) const

inherited

Definition at line 73 of file L1CaloRdo.cxx.

{
   return m_crate;
}

getEta()

int L1CaloRdo::getEta ( ) const

inherited

Definition at line 85 of file L1CaloRdo.cxx.

{
   return m_eta;
}

getFibre()

int L1CaloRdoFexTob::getFibre ( ) const

inherited

Definition at line 173 of file L1CaloRdoFexTob.cxx.

{
   return m_fibre;
}

getFlag() [1/2]

int L1CaloRdo::getFlag ( ) const

inherited

Definition at line 125 of file L1CaloRdo.cxx.

{
   return getFlag( getL1aPos() );
}

getFlag() [2/2]

int L1CaloRdo::getFlag ( size_t slice ) const

inherited

Definition at line 117 of file L1CaloRdo.cxx.

{
   if ( slice < m_flags.size() )
      return m_flags[slice];
   return 0;
}

getIsEfex()

bool L1CaloRdoFexTob::getIsEfex ( ) const

inherited

Definition at line 146 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobSource() == TobSource::EfexTob ||
            getTobSource() == TobSource::EfexXtob );
}

getIsEM()

bool L1CaloRdoFexTob::getIsEM ( ) const

inherited

Definition at line 71 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobType() == TobType::EM );
}

getIsEnergy()

bool L1CaloRdoFexTob::getIsEnergy ( ) const

inherited

Definition at line 102 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobType() == TobType::Energy );
}

getIsGfex()

bool L1CaloRdoFexTob::getIsGfex ( ) const

inherited

Definition at line 160 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobSource() == TobSource::GfexTob ||
            getTobSource() == TobSource::GfexXtob );
}

getIsJet()

bool L1CaloRdoFexTob::getIsJet ( ) const

inherited

Definition at line 83 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobType() == TobType::LargeJet ||
            getTobType() == TobType::SmallJet );
}

getIsJfex()

bool L1CaloRdoFexTob::getIsJfex ( ) const

inherited

Definition at line 153 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobSource() == TobSource::JfexTob ||
            getTobSource() == TobSource::JfexXtob );
}

getIsLargeJet()

bool L1CaloRdoFexTob::getIsLargeJet ( ) const

inherited

Definition at line 90 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobType() == TobType::LargeJet );
}

getIsMuon()

bool L1CaloRdoFexTob::getIsMuon ( ) const

inherited

Definition at line 108 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobType() == TobType::Muon );
}

getIsol() [1/2]

int L1CaloRdoEfexTob::getIsol

(

)

const

Definition at line 95 of file L1CaloRdoEfexTob.cxx.

{
   return getIsol( getL1aPos() );
}

getIsol() [2/2]

int L1CaloRdoEfexTob::getIsol

(

size_t

slice

)

const

Return three 2 bit isolation hits (packed into bits 18-23 of the RDO flag).

Definition at line 89 of file L1CaloRdoEfexTob.cxx.

{
   return ( ( getFlag( slice ) >> 18 ) & 0x3f );
}

getIsSmallJet()

bool L1CaloRdoFexTob::getIsSmallJet ( ) const

inherited

Definition at line 96 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobType() == TobType::SmallJet );
}

getIsTau()

bool L1CaloRdoFexTob::getIsTau ( ) const

inherited

Definition at line 77 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobType() == TobType::Tau );
}

getIsTob()

bool L1CaloRdoFexTob::getIsTob ( ) const

inherited

Definition at line 129 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobSource() == TobSource::EfexTob ||
            getTobSource() == TobSource::JfexTob ||
            getTobSource() == TobSource::GfexTob ||
            getTobSource() == TobSource::Ph1Topo );
}

getIsTopo()

bool L1CaloRdoFexTob::getIsTopo ( ) const

inherited

Definition at line 167 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobSource() == TobSource::Ph1Topo );
}

getIsXtob()

bool L1CaloRdoFexTob::getIsXtob ( ) const

inherited

Definition at line 138 of file L1CaloRdoFexTob.cxx.

{
   return ( getTobSource() == TobSource::EfexXtob ||
            getTobSource() == TobSource::JfexXtob ||
            getTobSource() == TobSource::GfexXtob );
}

getL1aPos()

int L1CaloRdo::getL1aPos ( ) const

inherited

Definition at line 131 of file L1CaloRdo.cxx.

{
   return m_l1aPos;
}

getLayer()

int L1CaloRdo::getLayer ( ) const

inherited

Definition at line 97 of file L1CaloRdo.cxx.

{
   return m_layer;
}

getModule()

int L1CaloRdo::getModule ( ) const

inherited

Definition at line 79 of file L1CaloRdo.cxx.

{
   return m_module;
}

getModuleErrorBcnMismatch()

bool L1CaloRdo::getModuleErrorBcnMismatch ( ) const

inherited

Definition at line 168 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x04 ;
}

getModuleErrorFifoOverflow()

bool L1CaloRdo::getModuleErrorFifoOverflow ( ) const

inherited

Definition at line 174 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x08 ;
}

getModuleErrorGlinkDown()

bool L1CaloRdo::getModuleErrorGlinkDown ( ) const

inherited

Definition at line 198 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x80 ;
}

getModuleErrorGlinkParity()

bool L1CaloRdo::getModuleErrorGlinkParity ( ) const

inherited

Definition at line 156 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x01 ;
}

getModuleErrorGlinkProtocol()

bool L1CaloRdo::getModuleErrorGlinkProtocol ( ) const

inherited

Definition at line 162 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x02 ;
}

getModuleErrorGlinkTimeout()

bool L1CaloRdo::getModuleErrorGlinkTimeout ( ) const

inherited

Definition at line 192 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x40 ;
}

getModuleErrorSpecific()

bool L1CaloRdo::getModuleErrorSpecific ( ) const

inherited

Definition at line 180 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x10 ;
}

getModuleErrorUnused()

bool L1CaloRdo::getModuleErrorUnused ( ) const

inherited

Definition at line 186 of file L1CaloRdo.cxx.

{
   return getModuleStatus( ) & 0x20 ;
}

getModuleStatus()

int L1CaloRdo::getModuleStatus ( ) const

inherited

Definition at line 150 of file L1CaloRdo.cxx.

{
   return m_rodInfo->getModuleStatus( getModule() );
}

getPhi()

int L1CaloRdo::getPhi ( ) const

inherited

Definition at line 91 of file L1CaloRdo.cxx.

{
   return m_phi;
}

getRegion()

L1CaloDetectorRegion L1CaloRdo::getRegion ( ) const

inherited

Definition at line 137 of file L1CaloRdo.cxx.

{
   return m_region;
}

getRodInfo()

const std::list< L1CaloRdoRodInfo >::const_iterator & L1CaloRdo::getRodInfo ( ) const

inherited

Definition at line 144 of file L1CaloRdo.cxx.

{
   return m_rodInfo;
}

getTobID()

int L1CaloRdoFexTob::getTobID ( ) const

inherited

Definition at line 65 of file L1CaloRdoFexTob.cxx.

{
   return m_id;
}

getTobSeq()

int L1CaloRdoFexTob::getTobSeq ( ) const

inherited

Definition at line 179 of file L1CaloRdoFexTob.cxx.

{
   return m_tobSeq;
}

getTobSource()

L1CaloRdoFexTob::TobSource L1CaloRdoFexTob::getTobSource ( ) const

inherited

Definition at line 114 of file L1CaloRdoFexTob.cxx.

{
   return m_source;
}

getTobSourceString()

std::string L1CaloRdoFexTob::getTobSourceString ( ) const

inherited

Definition at line 120 of file L1CaloRdoFexTob.cxx.

{
   if      ( getIsTob() )       { return "Tob"; }
   else if ( getIsXtob() )      { return "Xtob"; }
   else if ( getIsTopo() )      { std::ostringstream s; s << "Topo" << m_id; return s.str(); }
   else                         { return ""; }
}

getTobType()

L1CaloRdoFexTob::TobType L1CaloRdoFexTob::getTobType ( ) const

inherited

Definition at line 47 of file L1CaloRdoFexTob.cxx.

{
   return m_tobType;
}

getTobTypeString()

std::string L1CaloRdoFexTob::getTobTypeString ( ) const

inherited

Definition at line 53 of file L1CaloRdoFexTob.cxx.

{
   if      ( getIsEM() )       { return "EM"; }
   else if ( getIsTau() )      { return "Tau"; }
   else if ( getIsLargeJet() ) { return "LJet"; }
   else if ( getIsSmallJet() ) { return "SJet"; }
   else if ( getIsEnergy() )   { return "Energy"; }
   else if ( getIsMuon() )     { return "Muon"; }
   else                        { return ""; }
}

getType()

std::string L1CaloRdoFexTob::getType ( ) const

overridevirtualinherited

Implements L1CaloRdo.

Definition at line 29 of file L1CaloRdoFexTob.cxx.

{
   return getTobTypeString() + std::string( "Tob:" ) + getTobSourceString();
}

getValue() [1/2]

int L1CaloRdo::getValue ( ) const

inherited

Definition at line 111 of file L1CaloRdo.cxx.

{
   return getValue( getL1aPos() );
}

getValue() [2/2]

int L1CaloRdo::getValue ( size_t slice ) const

inherited

Definition at line 103 of file L1CaloRdo.cxx.

{
   if ( slice < m_vals.size() )
      return m_vals[slice];
   return 0;
}

info()

void L1CaloRdo::info ( ) const

inherited

Definition at line 258 of file L1CaloRdo.cxx.

{
   std::cout << "RDO Object Type: " << getType()
             << "  Crate: " << getCrate()
             << "  Module: " << getModule()
         << "  Eta: " << getEta()
         << "  Phi: " << getPhi()
         << "  Layer: " << getLayer() << std::endl;
   std::cout << "      Values:  " << std::hex;
   for ( size_t i = 0 ; i < m_vals.size() ; ++i )
      std::cout << getValue(i) << " ";
   std::cout << "      Flags:  ";
   for ( size_t i = 0 ; i < m_flags.size() ; ++i )
      std::cout << getFlag(i) << " ";
   std::cout << std::endl << std::dec;
   infoSpecific();
}

infoSpecific()

void L1CaloRdoEfexTob::infoSpecific ( ) const

overridevirtual

Reimplemented from L1CaloRdo.

Definition at line 46 of file L1CaloRdoEfexTob.cxx.

{
   std::cout << "      Isolation:  " << std::hex;
   for ( size_t s = 0 ; s < numSlices() ; ++s )
   {
      std::cout << std::setw(2) << getIsol( s ) << " ";
   }
   std::cout << std::dec << std::endl;
}

numSlices()

size_t L1CaloRdo::numSlices ( ) const

inherited

Definition at line 204 of file L1CaloRdo.cxx.

{
   return m_vals.size();
}

sameDatum() [1/2]

bool L1CaloRdo::sameDatum ( const L1CaloRdo & rhs ) const

inherited

Definition at line 210 of file L1CaloRdo.cxx.

{
   if ( m_crate != rhs.m_crate )
      return false;
   if ( m_module != rhs.m_module )
      return false;
   if ( m_eta != rhs.m_eta )
      return false;
   if ( m_phi != rhs.m_phi )
      return false;
   if ( m_layer != rhs.m_layer )
      return false;
   return true;
}

sameDatum() [2/2]

bool L1CaloRdoFexTob::sameDatum ( const L1CaloRdoFexTob & rhs ) const

inherited

Definition at line 35 of file L1CaloRdoFexTob.cxx.

{
   if ( m_tobType != rhs.m_tobType )
      return false;
   if ( m_source != rhs.m_source )
      return false;
   if ( m_id != rhs.m_id )
      return false;
   return L1CaloRdo::sameDatum( rhs );
}

setFlag() [1/2]

void L1CaloRdo::setFlag ( int flag )

inherited

Definition at line 246 of file L1CaloRdo.cxx.

{
   setFlag( flag, getL1aPos() );
}

setFlag() [2/2]

void L1CaloRdo::setFlag ( int flag, size_t slice )

inherited

Definition at line 239 of file L1CaloRdo.cxx.

{
   if ( slice < m_flags.size() )
      m_flags[slice] = flag;
}

setRegion()

void L1CaloRdo::setRegion ( const L1CaloDetectorRegion & region )

protectedinherited

Definition at line 283 of file L1CaloRdo.cxx.

{
   m_region = region;
}

setRodInfo()

void L1CaloRdo::setRodInfo ( std::list< L1CaloRdoRodInfo >::const_iterator & rodInfo )

inherited

Definition at line 252 of file L1CaloRdo.cxx.

{
   m_rodInfo = rodInfo;
}

setValue() [1/2]

void L1CaloRdo::setValue ( int val )

inherited

Definition at line 233 of file L1CaloRdo.cxx.

{
   setValue( val, getL1aPos() );
}

setValue() [2/2]

void L1CaloRdo::setValue ( int val, size_t slice )

inherited

Definition at line 226 of file L1CaloRdo.cxx.

{
   if ( slice < m_vals.size() )
      m_vals[slice] = val;
}

Member Data Documentation

m_crate

int L1CaloRdo::m_crate

privateinherited

Definition at line 73 of file L1CaloRdo.h.

m_eta

int L1CaloRdo::m_eta

privateinherited

Definition at line 75 of file L1CaloRdo.h.

m_fibre

int L1CaloRdoFexTob::m_fibre

privateinherited

Definition at line 50 of file L1CaloRdoFexTob.h.

m_flags

std::vector<int> L1CaloRdo::m_flags

privateinherited

Definition at line 79 of file L1CaloRdo.h.

m_id

int L1CaloRdoFexTob::m_id

privateinherited

Definition at line 49 of file L1CaloRdoFexTob.h.

m_l1aPos

int L1CaloRdo::m_l1aPos

privateinherited

Definition at line 80 of file L1CaloRdo.h.

m_layer

int L1CaloRdo::m_layer

privateinherited

Definition at line 77 of file L1CaloRdo.h.

m_module

int L1CaloRdo::m_module

privateinherited

Definition at line 74 of file L1CaloRdo.h.

m_phi

int L1CaloRdo::m_phi

privateinherited

Definition at line 76 of file L1CaloRdo.h.

m_region

L1CaloDetectorRegion L1CaloRdo::m_region

privateinherited

Definition at line 82 of file L1CaloRdo.h.

m_rodInfo

std::list<L1CaloRdoRodInfo>::const_iterator L1CaloRdo::m_rodInfo

privateinherited

Definition at line 86 of file L1CaloRdo.h.

m_source

TobSource L1CaloRdoFexTob::m_source

privateinherited

Definition at line 48 of file L1CaloRdoFexTob.h.

m_tobSeq

int L1CaloRdoFexTob::m_tobSeq

privateinherited

Definition at line 51 of file L1CaloRdoFexTob.h.

m_tobType

TobType L1CaloRdoFexTob::m_tobType

privateinherited

Definition at line 47 of file L1CaloRdoFexTob.h.

m_vals

std::vector<int> L1CaloRdo::m_vals

privateinherited

Definition at line 78 of file L1CaloRdo.h.

---

The documentation for this class was generated from the following files:

• L1CaloRdoEfexTob.h
• L1CaloRdoEfexTob.cxx