LVL1::JEPRoIDecoder Class Reference

A level 1 calorimeter trigger conversion service: returns the Coordinate represented by a RoI word. More...

#include <JEPRoIDecoder.h>

Inheritance diagram for LVL1::JEPRoIDecoder:

Collaboration diagram for LVL1::JEPRoIDecoder:

Public Member Functions
	JEPRoIDecoder ()
virtual	~JEPRoIDecoder ()
TrigT1CaloDefs::RoIType	roiType (unsigned int word) const
	Override base method - allows us to handle both Run 1 & Run 2 data for JEP (up to a point) More...
unsigned int	jetRoIVersion (unsigned int word) const
	Identify Jet RoI Version. More...
virtual CoordinateRange	coordinate (const unsigned int roiWord) const override
	Return eta/phi coordinate object. More...
unsigned int	crate (const unsigned int word) const
	Return hardware coordinates. More...
unsigned int	module (const unsigned int word) const
	Extract module number from Jet RoI word. More...
unsigned int	row (const unsigned int word) const
	Extract RoI row number within module from Jet RoI word. More...
unsigned int	column (const unsigned int word) const
	Extract RoI column number within module from Jet RoI word. More...
const std::vector< unsigned int >	thresholdsPassed (const unsigned int word) const
	returns a vector containing the numbers of threshold passed i.e. More...
const std::vector< unsigned int >	fwdThresholdsPassed (const unsigned int word) const
	returns a vector containing the numbers of threshold passed i.e. More...
unsigned int	etLarge (const unsigned int word) const
	Return ET values from Run 2 Jet RoIs. More...
unsigned int	etSmall (const unsigned int word) const
	Extract smaller cluster ET value from Jet RoI word. More...
int	energyX (unsigned int energyRoIWord0) const
	returns the (signed) Ex energy projection. More...
int	energyY (unsigned int energyRoIWord1) const
	returns the (signed) Ex energy projection. More...
int	energyT (unsigned int energyRoIWord2) const
	returns the (signed) Ex energy projection. More...
bool	energyOverflow (unsigned int energyRoIWord) const
	returns overflow flag energy RoIWord More...
std::vector< unsigned int >	mEtSigThresholdsPassed (const unsigned int energyRoIWord0) const
	returns a vector containing the numbers of threshold passed i.e. More...
std::vector< unsigned int >	etSumThresholdsPassed (const unsigned int energyRoIWord1) const
	returns a vector containing the numbers of threshold passed i.e. More...
std::vector< unsigned int >	etMissThresholdsPassed (const unsigned int energyRoIWord2) const
	returns a vector containing the numbers of threshold passed i.e. More...
bool	mEtSigThresholdPassed (const unsigned int energyRoIWord0, const unsigned int thresh) const
	returns true if thresh is passed More...
bool	sumEtThresholdPassed (const unsigned int energyRoIWord1, const unsigned int thresh) const
	returns true if thresh is passed More...
bool	etMissThresholdPassed (const unsigned int energyRoIWord2, const unsigned int thresh) const
	returns true if thresh is passed More...

Protected Member Functions
unsigned int	extractBits (unsigned int word, const unsigned int start, const unsigned int length) const
	returns the value of bits in word between bit "start" and bit "start" + "length" More...

Protected Attributes
bool	m_DEBUG

Private Member Functions
unsigned int	mEtSigThresholdsFlags (const unsigned int energyRoIWord0) const
unsigned int	sumEtThresholdsFlags (const unsigned int energyRoIWord1) const
unsigned int	missEtThresholdsFlags (const unsigned int energyRoIWord1) const
int	decodeEnergyComponent (const unsigned int energyRoIWord) const
	No descriptions. More...
CoordinateRange	midJEMCoordinate (const unsigned int jem, const unsigned int roiWord) const
	return a CoordinateRange for the JEMs coving -2.4<eta<2.4 More...
CoordinateRange	leftEndJEMCoordinate (const unsigned int jem, const unsigned int roiWord) const
	returns a CoordinateRange for the end JEMs, i.e. More...
CoordinateRange	rightEndJEMCoordinate (const unsigned int jem, const unsigned int roiWord) const
	returns a CoordinateRange for the end JEMs, i.e. More...
void	setPhiCoords (const unsigned int jem, const unsigned int roiWord, double &phiMin, double &phiMax) const
	set phi coords for Jet RoI More...

Detailed Description

A level 1 calorimeter trigger conversion service: returns the Coordinate represented by a RoI word.

Author

E.Moyse

Todo:

this should probably be a static class.

Definition at line 33 of file JEPRoIDecoder.h.

Constructor & Destructor Documentation

JEPRoIDecoder()

LVL1::JEPRoIDecoder::JEPRoIDecoder

(

)

Definition at line 23 of file JEPRoIDecoder.cxx.

  {
  }

~JEPRoIDecoder()

LVL1::JEPRoIDecoder::~JEPRoIDecoder ( )

virtual

Definition at line 27 of file JEPRoIDecoder.cxx.

                                {
 
  }

Member Function Documentation

column()

unsigned int LVL1::JEPRoIDecoder::column

(

const unsigned int

word

)

const

Extract RoI column number within module from Jet RoI word.

Definition at line 96 of file JEPRoIDecoder.cxx.

                                                                       {
    unsigned int rl = extractBits( roiWord, 20, 2 );
    unsigned int frame = extractBits( roiWord, 22, 3 );
    return ( frame >> 2 ) * 2 + ( rl & 1 );
  }

coordinate()

CoordinateRange LVL1::JEPRoIDecoder::coordinate ( const unsigned int  roiWord ) const

overridevirtual

Return eta/phi coordinate object.

Implements LVL1::RoIDecoder.

Definition at line 66 of file JEPRoIDecoder.cxx.

                                                                              {
 
    const unsigned int jem = this->module (roiWord);
    unsigned int temp = jem % 8;
    if ( temp == 0 ){
        return leftEndJEMCoordinate(jem, roiWord);
    } else if( temp == 7 ){
        return rightEndJEMCoordinate(jem, roiWord);
    } else return midJEMCoordinate(jem, roiWord);
 
  }

crate()

unsigned int LVL1::JEPRoIDecoder::crate

(

const unsigned int

word

)

const

Return hardware coordinates.

Extract crate number from Jet RoI word.

Definition at line 79 of file JEPRoIDecoder.cxx.

                                                                      {
    return extractBits( roiWord, 29, 1 );
  }

decodeEnergyComponent()

int LVL1::JEPRoIDecoder::decodeEnergyComponent ( const unsigned int  energyRoIWord ) const

private

No descriptions.

Ex, Ey values are stored in 15 bit twos complement format

Convert negative 15-bit complement values to ints

Definition at line 358 of file JEPRoIDecoder.cxx.

                                                                                   {
 
    int value = extractBits( energyRoIWord, 1, 15 );
    int negative = extractBits( energyRoIWord, 15, 1 );
 
    if ( negative != 0 ) {
      int complement = ~value;
      value = -( (complement+1)&0x7FFF) ;
    }
    
    return value;
  }

energyOverflow()

bool LVL1::JEPRoIDecoder::energyOverflow

(

unsigned int

energyRoIWord

)

const

returns overflow flag energy RoIWord

returns the overflow flag for an Energy RoIWord

Definition at line 271 of file JEPRoIDecoder.cxx.

                                                                       {
 
    if ( extractBits( energyRoIWord, 16, 1 ) != 0 ) {
      return true;
    } else {
      return false;
    }
  }

energyT()

int LVL1::JEPRoIDecoder::energyT

(

unsigned int

energyRoIWord2

)

const

returns the (signed) Ex energy projection.

returns the ETSum value.

If the RoIWord looks invalid, then zero will be returned.

Definition at line 264 of file JEPRoIDecoder.cxx.

                                                                {
 
    if ( roiType( energyRoIWord2 ) != TrigT1CaloDefs::EnergyRoIWordType2 ) return 0; // wrong type of word
    return extractBits( energyRoIWord2, 1, 15 );
  }

energyX()

int LVL1::JEPRoIDecoder::energyX

(

unsigned int

energyRoIWord0

)

const

returns the (signed) Ex energy projection.

If the RoIWord looks invalid, then zero will be returned.

Definition at line 250 of file JEPRoIDecoder.cxx.

                                                                {
 
    if ( roiType( energyRoIWord0 ) != TrigT1CaloDefs::EnergyRoIWordType0 ) return 0; // wrong type of word
    return decodeEnergyComponent( energyRoIWord0 );
  }

energyY()

int LVL1::JEPRoIDecoder::energyY

(

unsigned int

energyRoIWord1

)

const

returns the (signed) Ex energy projection.

returns the (signed) Ey energy projection.

If the RoIWord looks invalid, then zero will be returned.

Definition at line 257 of file JEPRoIDecoder.cxx.

                                                                {
 
    if ( roiType( energyRoIWord1 ) != TrigT1CaloDefs::EnergyRoIWordType1 ) return 0; // wrong type of word
    return decodeEnergyComponent( energyRoIWord1 );
  }

etLarge()

unsigned int LVL1::JEPRoIDecoder::etLarge

(

const unsigned int

word

)

const

Return ET values from Run 2 Jet RoIs.

Extract larger cluster ET value from Jet RoI word.

Definition at line 141 of file JEPRoIDecoder.cxx.

                                                                     {
    if (jetRoIVersion(word) == 1) return 0;
    return extractBits( word, 1, 10 );
  }

etMissThresholdPassed()

bool LVL1::JEPRoIDecoder::etMissThresholdPassed	(	const unsigned int	energyRoIWord2,
		const unsigned int	thresh
	)		const

returns true if thresh is passed

Definition at line 338 of file JEPRoIDecoder.cxx.

                                                                                                                {
 
    return ( ( 1 << thresh ) & missEtThresholdsFlags( energyRoIWord2 ) );
  }

etMissThresholdsPassed()

std::vector< unsigned int > LVL1::JEPRoIDecoder::etMissThresholdsPassed

(

const unsigned int

energyRoIWord2

)

const

returns a vector containing the numbers of threshold passed i.e.

if the vector contains 1,3,5 it means that this RoI passed thresholds 1,3 and 5.

Definition at line 312 of file JEPRoIDecoder.cxx.

                                                                                                         {
 
    std::vector<unsigned int> missEtThreshPassedVec;
    unsigned int passed = missEtThresholdsFlags( energyRoIWord2 );
    for ( unsigned int thresh = 0; thresh < TrigT1CaloDefs::numOfMissingEtThresholds; thresh++ ) {
      if ( passed & (1<<thresh)) {
        missEtThreshPassedVec.push_back( thresh + 1 );
      }
    } //endfor
 
    return missEtThreshPassedVec;
  }

etSmall()

unsigned int LVL1::JEPRoIDecoder::etSmall

(

const unsigned int

word

)

const

Extract smaller cluster ET value from Jet RoI word.

Definition at line 147 of file JEPRoIDecoder.cxx.

                                                                     {
    if (jetRoIVersion(word) == 1) return 0;
    return extractBits( word, 11, 9 );
  }

etSumThresholdsPassed()

std::vector< unsigned int > LVL1::JEPRoIDecoder::etSumThresholdsPassed

(

const unsigned int

energyRoIWord1

)

const

returns a vector containing the numbers of threshold passed i.e.

if the vector contains 1,3,5 it means that this RoI passed thresholds 1,3 and 5.

Definition at line 297 of file JEPRoIDecoder.cxx.

                                                                                                        {
 
    std::vector<unsigned int> sumEtThreshPassedVec;
    unsigned int passed = sumEtThresholdsFlags( energyRoIWord1 );
for ( unsigned int thresh = 0; thresh < TrigT1CaloDefs::numOfSumEtThresholds; thresh++ ) {
      if ( passed & (1<<thresh)) {
        sumEtThreshPassedVec.push_back( thresh + 1 );
      }
    } //endfor
 
    return sumEtThreshPassedVec;
  }

extractBits()

unsigned int LVL1::RoIDecoder::extractBits ( unsigned int  word, const unsigned int  start, const unsigned int  length  ) const

protectedinherited

returns the value of bits in word between bit "start" and bit "start" + "length"

Definition at line 34 of file RoIDecoder.cxx.

                                                                              {
 
   // this works as follows. Imagine start=3, bits=4 and word=11011100
   // so this routine should return 0111
   // now:
   // word>>(first-1)  = 110111
   // (1<<length)      = 010000
   // (1<<length)-1    = 001111
   word = ( word >> ( start - 1 ) );
 
   unsigned int bitmask = ( 1 << length ) - 1;
   // and finally:
   // 110111&001111    = 0111
   return ( word & bitmask ); // return only bits in bitmask
}

fwdThresholdsPassed()

const std::vector< unsigned int > LVL1::JEPRoIDecoder::fwdThresholdsPassed

(

const unsigned int

word

)

const

returns a vector containing the numbers of threshold passed i.e.

if the vector contains 1,3,5 it means that this RoI passed thresholds 1,3 and 5.

Definition at line 122 of file JEPRoIDecoder.cxx.

                                                                                                  {
 
    std::vector<unsigned int> fwdThreshPassedVec;
    
    if (jetRoIVersion(word) == 1) {
      unsigned int fwdThresholdsPassed = extractBits( word, 9, 4 );
      for ( unsigned int thresh = 0; thresh < 4;thresh++ ) {
        if ( ( 1 << thresh ) & fwdThresholdsPassed ) {
          fwdThreshPassedVec.push_back( thresh + 1 );
        }
      } //endfor
    }
    
    return fwdThreshPassedVec;
 
  }

jetRoIVersion()

unsigned int LVL1::JEPRoIDecoder::jetRoIVersion

(

unsigned int

word

)

const

Identify Jet RoI Version.

Definition at line 59 of file JEPRoIDecoder.cxx.

                                                                       {
   unsigned int temp=extractBits(word, 30, 3);
   if (temp == TrigT1CaloDefs::Run1JetType)      return 1;
   else if (temp == TrigT1CaloDefs::Run2JetType) return 2;
   else                                          return 999;
}

leftEndJEMCoordinate()

CoordinateRange LVL1::JEPRoIDecoder::leftEndJEMCoordinate ( const unsigned int  jem, const unsigned int  roiWord  ) const

private

returns a CoordinateRange for the end JEMs, i.e.

2.4<eta<4.9

Definition at line 179 of file JEPRoIDecoder.cxx.

                                                                                        {
 
    double phiMin = 0.0;
    double phiMax = 0.0;
    setPhiCoords( jem, roiWord, phiMin, phiMax );
 
    double etaMin = 0.0; double etaMax = 0.0;
    switch ( this->column (roiWord) ) {
    case 0:
      etaMin = -4.9; etaMax = -2.9;
      break;
    case 1:
      etaMin = -3.2; etaMax = -2.7;
      break;
    case 2:
      etaMin = -2.9; etaMax = -2.4;
      break;
    case 3:
      etaMin = -2.7; etaMax = -2.2;
      break;
    }
 
    CoordinateRange coord( phiMin, phiMax, etaMin, etaMax );
    return coord;
  }

mEtSigThresholdPassed()

bool LVL1::JEPRoIDecoder::mEtSigThresholdPassed	(	const unsigned int	energyRoIWord0,
		const unsigned int	thresh
	)		const

returns true if thresh is passed

Definition at line 326 of file JEPRoIDecoder.cxx.

                                                                                                                {
 
    return ( ( 1 << thresh ) & mEtSigThresholdsFlags( energyRoIWord0 ) );
  }

mEtSigThresholdsFlags()

unsigned int LVL1::JEPRoIDecoder::mEtSigThresholdsFlags ( const unsigned int  energyRoIWord0 ) const

private

Definition at line 343 of file JEPRoIDecoder.cxx.

                                                                                             {
 
    return extractBits( energyRoIWord0, 17, TrigT1CaloDefs::numOfMEtSigThresholds );
  }

mEtSigThresholdsPassed()

std::vector< unsigned int > LVL1::JEPRoIDecoder::mEtSigThresholdsPassed

(

const unsigned int

energyRoIWord0

)

const

returns a vector containing the numbers of threshold passed i.e.

if the vector contains 1,3,5 it means that this RoI passed thresholds 1,3 and 5.

Definition at line 282 of file JEPRoIDecoder.cxx.

                                                                                                         {
 
    std::vector<unsigned int> mEtSigThreshPassedVec;
    unsigned int passed = mEtSigThresholdsFlags( energyRoIWord0 );
    for ( unsigned int thresh = 0; thresh < TrigT1CaloDefs::numOfMEtSigThresholds; thresh++ ) {
      if ( passed & (1<<thresh)) {
        mEtSigThreshPassedVec.push_back( thresh + 1 );
      }
    } //endfor
 
    return mEtSigThreshPassedVec;
  }

midJEMCoordinate()

CoordinateRange LVL1::JEPRoIDecoder::midJEMCoordinate ( const unsigned int  jem, const unsigned int  roiWord  ) const

private

return a CoordinateRange for the JEMs coving -2.4<eta<2.4

Definition at line 154 of file JEPRoIDecoder.cxx.

                                                                                    {
 
    double phiMin = 0.0;
    double phiMax = 0.0;
    setPhiCoords( jem, roiWord, phiMin, phiMax );
 
    //eta
    const double JEMEtaSize = 0.8;
    const double jeEtaSize = 0.2;
 
    const unsigned int col = this->column (roiWord);
    int etaBin = ( jem % 8 ) - 4; //bins range from -4 to +3
    double etaMin = ( etaBin * JEMEtaSize ) + ( jeEtaSize * col );
    double etaMax = etaMin + 2. * jeEtaSize;
 
    // there is one nasty "special case" as well
    if ( etaMax > 2.5 && etaMax < 2.7 ) etaMax = 2.7;
 
    CoordinateRange coord;
    coord.setRanges( phiMin, phiMax, etaMin, etaMax );
    return coord;
  }

missEtThresholdsFlags()

unsigned int LVL1::JEPRoIDecoder::missEtThresholdsFlags ( const unsigned int  energyRoIWord1 ) const

private

Definition at line 353 of file JEPRoIDecoder.cxx.

                                                                                             {
 
    return extractBits( energyRoIWord2, 17, TrigT1CaloDefs::numOfMissingEtThresholds );
  }

module()

unsigned int LVL1::JEPRoIDecoder::module

(

const unsigned int

word

)

const

Extract module number from Jet RoI word.

Definition at line 84 of file JEPRoIDecoder.cxx.

                                                                       {
    return extractBits( roiWord, 25, 4 );
  }

rightEndJEMCoordinate()

CoordinateRange LVL1::JEPRoIDecoder::rightEndJEMCoordinate ( const unsigned int  jem, const unsigned int  roiWord  ) const

private

returns a CoordinateRange for the end JEMs, i.e.

2.4<eta<4.9

Definition at line 207 of file JEPRoIDecoder.cxx.

                                                                                         {
 
    double phiMin = 0.0;
    double phiMax = 0.0;
    setPhiCoords( jem, roiWord, phiMin, phiMax );
    double etaMin = 0.0; double etaMax = 0.0;
    switch ( this->column (roiWord) ) {
    case 0:
      etaMin = 2.4; etaMax = 2.9;
      break;
    case 1:
      etaMin = 2.7; etaMax = 3.2;
      break;
    case 2:
      etaMin = 2.9; etaMax = 4.9;  // to put centre at HEC-FCAL boundary
      break;
    case 3:
      etaMin = 2.9; etaMax = 4.9;  // distinction between these 2 not useful to L2
      break;
    }
 
    CoordinateRange coord( phiMin, phiMax, etaMin, etaMax );
    return coord;
  }

roiType()

LVL1::TrigT1CaloDefs::RoIType LVL1::JEPRoIDecoder::roiType

(

unsigned int

word

)

const

Override base method - allows us to handle both Run 1 & Run 2 data for JEP (up to a point)

Definition at line 33 of file JEPRoIDecoder.cxx.

                                                                             {
   unsigned int temp=extractBits(word, 30, 3);
   if (temp == TrigT1CaloDefs::Run1JetType) {
      return TrigT1CaloDefs::JetRoIWordType;
   }
   else if (temp == TrigT1CaloDefs::Run2JetType) {
      return TrigT1CaloDefs::JetRoIWordType;
   }
   else if (temp == TrigT1CaloDefs::JetEtType) {
      return TrigT1CaloDefs::JetEtRoIWordType;
   }
   else {
      unsigned int temp2 = extractBits(word, 29, 4);
      if (temp2 == TrigT1CaloDefs::energyRoIWord0) {
         return TrigT1CaloDefs::EnergyRoIWordType0;
      }
      else if (temp2 == TrigT1CaloDefs::energyRoIWord1) {
         return TrigT1CaloDefs::EnergyRoIWordType1;
      }
      else if (temp2 == TrigT1CaloDefs::energyRoIWord2) {
         return TrigT1CaloDefs::EnergyRoIWordType2;
      }
   }
   return TrigT1CaloDefs::RoIWordTypeError;
}

row()

unsigned int LVL1::JEPRoIDecoder::row

(

const unsigned int

word

)

const

Extract RoI row number within module from Jet RoI word.

Definition at line 89 of file JEPRoIDecoder.cxx.

                                                                    {
    unsigned int rl = extractBits( roiWord, 20, 2 );
    unsigned int frame = extractBits( roiWord, 22, 3 );
    return ( frame & 3 ) * 2 + ( rl >> 1 );
  }

setPhiCoords()

void LVL1::JEPRoIDecoder::setPhiCoords ( const unsigned int  jem, const unsigned int  roiWord, double &  phiMin, double &  phiMax  ) const

private

set phi coords for Jet RoI

Definition at line 234 of file JEPRoIDecoder.cxx.

                                                                           {
 
    const unsigned int row = this->row (roiWord);
    const unsigned int crate = this->crate (roiWord);
 
    const double jemPhiSize = M_PI / 2;
    const double jePhiSize = M_PI / 16;
    int crateModifier = ( jem / 8 ) * 2; //=0 or 2
    phiMin = ( crate + crateModifier ) * jemPhiSize + ( jePhiSize * row );
    phiMax = phiMin + 2. * jePhiSize;
 
    return;
  }

sumEtThresholdPassed()

bool LVL1::JEPRoIDecoder::sumEtThresholdPassed	(	const unsigned int	energyRoIWord1,
		const unsigned int	thresh
	)		const

returns true if thresh is passed

Definition at line 332 of file JEPRoIDecoder.cxx.

                                                                                                               {
 
    return ( ( 1 << thresh ) & sumEtThresholdsFlags( energyRoIWord1) );
  }

sumEtThresholdsFlags()

unsigned int LVL1::JEPRoIDecoder::sumEtThresholdsFlags ( const unsigned int  energyRoIWord1 ) const

private

Definition at line 348 of file JEPRoIDecoder.cxx.

                                                                                            {
 
    return extractBits( energyRoIWord1, 17, TrigT1CaloDefs::numOfSumEtThresholds );
  }

thresholdsPassed()

const std::vector< unsigned int > LVL1::JEPRoIDecoder::thresholdsPassed

(

const unsigned int

word

)

const

returns a vector containing the numbers of threshold passed i.e.

Check on Run 1/Run 2.

if the vector contains 1,3,5 it means that this RoI passed thresholds 1,3 and 5.

Definition at line 103 of file JEPRoIDecoder.cxx.

                                                                                               {
 
    std::vector<unsigned int> threshPassedVec;
    
    if (jetRoIVersion(word) == 1) {
      unsigned int thresholdsPassed = extractBits( word, 1, 8 );
      for ( unsigned int thresh = 0; thresh < 16; ++thresh ) {
        if ( ( 1 << thresh ) & thresholdsPassed ) {
           threshPassedVec.push_back( thresh + 1 );
        }
      }
    }
    
   return threshPassedVec;
 
  }

Member Data Documentation

m_DEBUG

bool LVL1::RoIDecoder::m_DEBUG

protectedinherited

Definition at line 63 of file RoIDecoder.h.

---

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

• JEPRoIDecoder.h
• JEPRoIDecoder.cxx