LVL1::ModuleEnergy Class Reference

This is an internal class, used in the Energy trigger. More...

#include <ModuleEnergy.h>

Collaboration diagram for LVL1::ModuleEnergy:

Public Member Functions
	ModuleEnergy (const xAOD::JetElementMap_t *JEContainer, unsigned int crate, unsigned int module, int JEThresholdEtSum, int JEThresholdEtMiss, const std::map< int, int > *TEMasks=0, int slice=-1)
	ModuleEnergy (unsigned int crate, unsigned int module, unsigned int et, unsigned int ex, unsigned int ey)
	~ModuleEnergy ()
unsigned int	crate () const
	which module is this?
unsigned int	module () const
	return module number
unsigned int	et () const
	return the scalar & vector sums of all JE ETs (i.e sums the energies of up to 32 contained JEs)
unsigned int	ex () const
unsigned int	ey () const
int	signX () const
	return signs of Ex and Ey for this module
int	signY () const

Private Member Functions
void	getSinCos (double eta, double phi, int &cosPhi, int &sinPhi)
	return cos, sin coefficients for a given JetElement

Private Attributes
int	m_jetElementThresholdEtSum
int	m_jetElementThresholdEtMiss
unsigned int	m_Et
unsigned int	m_Ex
unsigned int	m_Ey
int	m_signX
int	m_signY
unsigned int	m_crate
unsigned int	m_module
bool	m_debug

Static Private Attributes
static const unsigned int	m_EtBits = 14

Detailed Description

This is an internal class, used in the Energy trigger.

The ModuleEnergy:

• identifies JetElements belonging to this particular module and uses them to form ET sums
  
• applies thresholds to JetElements on input to ETmiss and ETsum chains
  
• converts JetElements to Ex, Ey using coefficients from TrigConfigSvc
  
• Ex, Ey, Et all stored with values we would obtain after quad-linear encoding
  

Definition at line 40 of file ModuleEnergy.h.

Constructor & Destructor Documentation

ModuleEnergy() [1/2]

LVL1::ModuleEnergy::ModuleEnergy	(	const xAOD::JetElementMap_t *	JEContainer,
		unsigned int	crate,
		unsigned int	module,
		int	JEThresholdEtSum,
		int	JEThresholdEtMiss,
		const std::map< int, int > *	TEMasks = 0,
		int	slice = -1 )

Set up Ex, Ey signs for this module

Look for the JetElements associated with this module

Check JE not masked in TE trigger

Use jet element if it is not in the masked list

Test for saturation

Get ET for requested time slice

Test against ETmiss algorithm threshold

Get sin, cos factors for this JetElement

Convert to Ex, Ey and sum. Replicate integer arithmetic used in hardware

Test against ETsum algorithm threshold & add if passes

Convert Ex, Ey back to 1 GeV/count integers

Check for overflows. Set ET to full scale if these occur

Definition at line 19 of file ModuleEnergy.cxx.

                                                                                                                                        :
  m_jetElementThresholdEtSum(JEThresholdEtSum),
  m_jetElementThresholdEtMiss(JEThresholdEtMiss),
  m_Et(0),
  m_Ex(0),
  m_Ey(0),
  m_signX(1),
  m_signY(1),
  m_crate(crate),
  m_module(module),
  m_debug(false)
{
  // Only fill ModuleEnergys where crate, module numbers valid
  if (m_debug) std::cout << "Create ModuleEnergy for crate "
                         << crate << " module " << module << std::endl;
  if (m_crate <= 1 && m_module <= 15) {
    m_signY = ( (module < 8) ? 1 : -1 );
    m_signX = ( (crate == 0) ? m_signY : -m_signY );
    bool saturated = false;
    JetEnergyModuleKey get;
    std::vector<unsigned int> keys = get.jeKeys(crate, module);
    for (unsigned int k : keys) {
      xAOD::JetElementMap_t::const_iterator test=JEContainer->find(k);
      if (test != JEContainer->end()) {
    double eta = test->second->eta();
    int ieta = int((eta + (eta>0 ? 0.005 : -0.005))/0.1);
    if (TEMasks == 0 || TEMasks->find(ieta) == TEMasks->end()) {
          if (test->second->isSaturated()) {
        saturated = true;
          }
          else {
            int jetElementET;
            if (slice < 0) jetElementET = test->second->et();
            else           jetElementET = test->second->sliceET(slice);
            if (jetElementET > m_jetElementThresholdEtMiss) {
              double phi = test->second->phi();
              int cosPhi = 0;
              int sinPhi = 0;
              getSinCos(eta,phi,cosPhi,sinPhi);
              unsigned int EnergyX = ((jetElementET*cosPhi) & 0x7ffffc00);
              unsigned int EnergyY = ((jetElementET*sinPhi) & 0x7ffffc00);
              m_Ex += EnergyX;
              m_Ey += EnergyY;
              if (m_debug) std::cout << "JE phi = " << phi << ", ET = " << jetElementET
                                   << ", Ex = " << (EnergyX>>10) << ", Ey = " << (EnergyY>>10) << std::endl;
            }
            if ( jetElementET > m_jetElementThresholdEtSum )
               m_Et += jetElementET;
          } // End of processing of unsaturated jetElement
        } // End processing of unvetoed element
      } // End check for end of container
    } // End loop through keys

    m_Ex = m_Ex>>12;
    m_Ey = m_Ey>>12;
    
    if (saturated || (m_Ex > (1<<m_EtBits)-1)) m_Ex = (1<<m_EtBits)-1;
    if (saturated || (m_Ey > (1<<m_EtBits)-1)) m_Ey = (1<<m_EtBits)-1;
    if (saturated || (m_Et > (1<<m_EtBits)-1)) m_Et = (1<<m_EtBits)-1;
 
    if (m_debug) {
      std::cout << "Crate " << crate << " Module " << module <<
                   " sums: " << std::endl;
      std::cout << "  Ex = " << static_cast<int>(m_Ex)*m_signX << std::endl; 
      std::cout << "  Ey = " << static_cast<int>(m_Ey)*m_signY << std::endl;
      std::cout << "  Et = " << m_Et << std::endl;
    }
  }
}

ModuleEnergy() [2/2]

LVL1::ModuleEnergy::ModuleEnergy	(	unsigned int	crate,
		unsigned int	module,
		unsigned int	et,
		unsigned int	ex,
		unsigned int	ey )

Set up Ex, Ey signs for this module

Check for overflows. Set ET to full scale if these occur

Definition at line 102 of file ModuleEnergy.cxx.

                                :
  m_jetElementThresholdEtSum(0),
  m_jetElementThresholdEtMiss(0),
  m_Et(et),
  m_Ex(ex),
  m_Ey(ey),
  m_signX(1),
  m_signY(1),
  m_crate(crate),
  m_module(module),
  m_debug(false)
{
  // Only fill ModuleEnergys where crate, module numbers valid
  if (m_debug) std::cout << "Create ModuleEnergy for crate "
                         << crate << " module " << module << std::endl;
  if (m_crate <= 1 && m_module <= 15) {
    m_signY = ( (module < 8) ? 1 : -1 );
    m_signX = ( (crate == 0) ? m_signY : -m_signY );
    
    if (m_Ex > (1<<m_EtBits)-1) m_Ex = (1<<m_EtBits)-1;
    if (m_Ey > (1<<m_EtBits)-1) m_Ey = (1<<m_EtBits)-1;
    if (m_Et > (1<<m_EtBits)-1) m_Et = (1<<m_EtBits)-1;
    
    if (m_debug) {
      std::cout << "Crate " << crate << " Module " << module <<
                   " sums: " << std::endl;
      std::cout << "  Ex = " << static_cast<int>(m_Ex)*m_signX << std::endl; 
      std::cout << "  Ey = " << static_cast<int>(m_Ey)*m_signY << std::endl;
      std::cout << "  Et = " << m_Et << std::endl;
    }
  }
}

~ModuleEnergy()

LVL1::ModuleEnergy::~ModuleEnergy

(

)

Definition at line 140 of file ModuleEnergy.cxx.

                           {
}

Member Function Documentation

crate()

unsigned int LVL1::ModuleEnergy::crate

(

)

const

which module is this?

return crate number

Definition at line 144 of file ModuleEnergy.cxx.

                                       {
  return m_crate;
}

et()

unsigned int LVL1::ModuleEnergy::et

(

)

const

return the scalar & vector sums of all JE ETs (i.e sums the energies of up to 32 contained JEs)

return Et, Ex, Ey sums of contained JEs (up to 32 JEs)

module sums are unsigned. As a convenience, add methods to return signs for this module

Definition at line 153 of file ModuleEnergy.cxx.

                                    {
  return m_Et;
}

ex()

unsigned int LVL1::ModuleEnergy::ex

(

)

const

Definition at line 156 of file ModuleEnergy.cxx.

                                    {
  return m_Ex;
}

ey()

unsigned int LVL1::ModuleEnergy::ey

(

)

const

Definition at line 159 of file ModuleEnergy.cxx.

                                    {
  return m_Ey;
}

getSinCos()

void LVL1::ModuleEnergy::getSinCos ( double eta, double phi, int & cosPhi, int & sinPhi )

private

return cos, sin coefficients for a given JetElement

Different phi granularities in central and forward calorimeters

Each module spans 1 quadrant in phi. Hence want phi position relative to module edge

Barrel and endcap calorimeters

Even quadrants, modPhi measured from horizontal

Odd quadrants, modPhi measured from vertical

Forward calorimeters

Definition at line 172 of file ModuleEnergy.cxx.

                                                                             {
    
  unsigned int SinCos[8]    = {401,1187,1928,2594,3161,3607,3913,4070};
  unsigned int fwdSinCos[4] = {794,2261,3384,3992};

  float modPhi = fmod(phi, M_PI/2.);

  if (fabs(eta) < 3.2) {
    int phiBin = (int)(modPhi*16/M_PI);
    if (m_crate > 0) {                  
       cosPhi = SinCos[phiBin];
       sinPhi = SinCos[7-phiBin];
    }
    else {                              
       cosPhi = SinCos[7-phiBin];
       sinPhi = SinCos[phiBin];
    }
  }
  else {
    int phiBin = (int)(modPhi*8/M_PI);
    if (m_crate > 0) {
       cosPhi = fwdSinCos[phiBin];
       sinPhi = fwdSinCos[3-phiBin];
    }
    else {
       cosPhi = fwdSinCos[3-phiBin];
       sinPhi = fwdSinCos[phiBin];
    }
  }
 
} // end of getSinCos

module()

unsigned int LVL1::ModuleEnergy::module

(

)

const

return module number

Definition at line 148 of file ModuleEnergy.cxx.

                                        {
  return m_module;
}

signX()

int LVL1::ModuleEnergy::signX

(

)

const

return signs of Ex and Ey for this module

Definition at line 164 of file ModuleEnergy.cxx.

                              {
  return m_signX;
}

signY()

int LVL1::ModuleEnergy::signY

(

)

const

Definition at line 167 of file ModuleEnergy.cxx.

                              {
  return m_signY;
}

Member Data Documentation

m_crate

unsigned int LVL1::ModuleEnergy::m_crate

private

Definition at line 70 of file ModuleEnergy.h.

m_debug

bool LVL1::ModuleEnergy::m_debug

private

Definition at line 72 of file ModuleEnergy.h.

m_Et

unsigned int LVL1::ModuleEnergy::m_Et

private

Definition at line 65 of file ModuleEnergy.h.

m_EtBits

const unsigned int LVL1::ModuleEnergy::m_EtBits = 14

staticprivate

Definition at line 73 of file ModuleEnergy.h.

m_Ex

unsigned int LVL1::ModuleEnergy::m_Ex

private

Definition at line 66 of file ModuleEnergy.h.

m_Ey

unsigned int LVL1::ModuleEnergy::m_Ey

private

Definition at line 67 of file ModuleEnergy.h.

m_jetElementThresholdEtMiss

int LVL1::ModuleEnergy::m_jetElementThresholdEtMiss

private

Definition at line 64 of file ModuleEnergy.h.

m_jetElementThresholdEtSum

int LVL1::ModuleEnergy::m_jetElementThresholdEtSum

private

Definition at line 63 of file ModuleEnergy.h.

m_module

unsigned int LVL1::ModuleEnergy::m_module

private

Definition at line 71 of file ModuleEnergy.h.

m_signX

int LVL1::ModuleEnergy::m_signX

private

Definition at line 68 of file ModuleEnergy.h.

m_signY

int LVL1::ModuleEnergy::m_signY

private

Definition at line 69 of file ModuleEnergy.h.

---

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

• ModuleEnergy.h
• ModuleEnergy.cxx