This class defines the em/tau hadron ROI which are generated by the LVL1 Calo Trigger. More...

#include <EmTauROI.h>

Collaboration diagram for LVL1::EmTauROI:

Public Member Functions
	EmTauROI (double phi, double eta, int energy, unsigned long int roiWord, const std::vector< unsigned int > &algorithmType, unsigned int hadCoreEnergy, unsigned int hadRingIsolationEnergy, unsigned int emRingIsolationEnergy, unsigned int emClusterEnergy, unsigned int tauClusterEnergy)
	~EmTauROI ()
unsigned int	roiWord () const
	returns the 32bit ROI word.
bool	saturated () const
	returns TRUE if ROI constructed from a trigger tower that was saturated - in other words this ROI is signalling that it does not know its correct energy.
double	phi () const
	returns phi coord of ROI
double	eta () const
	returns eta coord of ROI
int	energy () const
	returns the energy of the ROI core, i.e.
bool	thresholdPassed (int thresh) const
	returns TRUE if threshold number threshold_number has been passed by this ROI.
TrigT1CaloDefs::ClusterAlgorithm	thresholdType (int thresh) const
	returns type of thresholds number threshold_number Thresholds numbered from 1 to TrigT1CaloDefs::numOfCPThresholds
unsigned int	emRingIsolationEnergy () const
	return energy
unsigned int	hadRingIsolationEnergy () const
	return energy
unsigned int	hadCoreEnergy () const
	return energy
unsigned int	clusterEnergy () const
	return energy
unsigned int	tauClusterEnergy () const

Private Member Functions
void	checkValidThreshNum (unsigned int thresh) const
	checks that the passed threshold is a valid number

Private Attributes
double	m_phi
	phi coord of ROI
double	m_eta
	eta coord of ROI
int	m_energy
	Energy of ROI core, i.e.
unsigned long int	m_roiWord
	this is the actual format of the data sent from the LVL1 hardware.
std::vector< unsigned int >	m_algorithmType
	Contains the algo type of thresh sets.
unsigned int	m_emRingIsolationEnergy
	Used for debugging only!
unsigned int	m_hadRingIsolationEnergy
	Used for debugging only!
unsigned int	m_hadCoreEnergy
	Used for debugging only!
unsigned int	m_emClusterEnergy
	Used for debugging only!
unsigned int	m_tauClusterEnergy

Detailed Description

This class defines the em/tau hadron ROI which are generated by the LVL1 Calo Trigger.

It isn't the final RoI produced and passed to L2 - that happens in the ROD simulation, so this class has some extra methods used for debugging

Author: moyse

Definition at line 35 of file EmTauROI.h.

Constructor & Destructor Documentation

◆ EmTauROI()

LVL1::EmTauROI::EmTauROI	(	double	phi,
		double	eta,
		int	energy,
		unsigned long int	roiWord,
		const std::vector< unsigned int > &	algorithmType,
		unsigned int	hadCoreEnergy,
		unsigned int	hadRingIsolationEnergy,
		unsigned int	emRingIsolationEnergy,
		unsigned int	emClusterEnergy,
		unsigned int	tauClusterEnergy )

Definition at line 16 of file EmTauROI.cxx.

                                                              :
  m_phi(phi),
  m_eta(eta),
  m_energy(energy),
  m_roiWord(roiWord),
  m_algorithmType(algorithmType),
  m_emRingIsolationEnergy(emRingIsolationEnergy),
  m_hadRingIsolationEnergy(hadRingIsolationEnergy),
  m_hadCoreEnergy(hadCoreEnergy),
  m_emClusterEnergy(emClusterEnergy),
  m_tauClusterEnergy(tauClusterEnergy)
{
}

◆ ~EmTauROI()

LVL1::EmTauROI::~EmTauROI ( )

Definition at line 32 of file EmTauROI.cxx.

32 {

33}

Member Function Documentation

◆ checkValidThreshNum()

void LVL1::EmTauROI::checkValidThreshNum ( unsigned int thresh ) const

inlineprivate

checks that the passed threshold is a valid number

Definition at line 118 of file EmTauROI.h.

118{if ( (thresh<1)||(thresh>TrigT1CaloDefs::numOfCPThresholds) ) std::cout <<"EmTauROI:: Threshold "<<thresh<<" outside range"<<std::endl;};

LVL1::TrigT1CaloDefs::numOfCPThresholds

static const unsigned int numOfCPThresholds

Definition TrigT1CaloDefs.h:125

physval_make_web_display.thresh

thresh

Definition physval_make_web_display.py:35

◆ clusterEnergy()

unsigned int LVL1::EmTauROI::clusterEnergy ( ) const

inline

return energy

Definition at line 84 of file EmTauROI.h.

84{return m_emClusterEnergy;};

◆ emRingIsolationEnergy()

unsigned int LVL1::EmTauROI::emRingIsolationEnergy ( ) const

inline

return energy

Definition at line 78 of file EmTauROI.h.

78{return m_emRingIsolationEnergy;};

◆ energy()

int LVL1::EmTauROI::energy ( ) const

returns the energy of the ROI core, i.e.

returns energy of ROI core

the summed (in both layers) energy of the central 4 TriggerTowers

Definition at line 88 of file EmTauROI.cxx.

                               {
    return m_energy;
}

◆ eta()

double LVL1::EmTauROI::eta ( ) const

returns eta coord of ROI

Definition at line 77 of file EmTauROI.cxx.

                               {
  return m_eta;
}

◆ hadCoreEnergy()

unsigned int LVL1::EmTauROI::hadCoreEnergy ( ) const

inline

return energy

Definition at line 82 of file EmTauROI.h.

82{return m_hadCoreEnergy;};

◆ hadRingIsolationEnergy()

unsigned int LVL1::EmTauROI::hadRingIsolationEnergy ( ) const

inline

return energy

Definition at line 80 of file EmTauROI.h.

80{return m_hadRingIsolationEnergy;} ;

◆ phi()

double LVL1::EmTauROI::phi ( ) const

returns phi coord of ROI

Definition at line 82 of file EmTauROI.cxx.

                               {
  return m_phi;
}

◆ roiWord()

unsigned int LVL1::EmTauROI::roiWord ( ) const

returns the 32bit ROI word.

This is defined in the ATLAS note daq-98-089.

Definition at line 37 of file EmTauROI.cxx.

                                        {
  return m_roiWord;
}

◆ saturated()

bool LVL1::EmTauROI::saturated ( ) const

returns TRUE if ROI constructed from a trigger tower that was saturated - in other words this ROI is signalling that it does not know its correct energy.

Definition at line 97 of file EmTauROI.cxx.

                                   {
  // Saturation flag is bit 16 of RoIWord
  bool sat = (m_roiWord >> 16)&0x1;
  return sat;
}

◆ tauClusterEnergy()

unsigned int LVL1::EmTauROI::tauClusterEnergy ( ) const

inline

Definition at line 85 of file EmTauROI.h.

85{return m_tauClusterEnergy;};

◆ thresholdPassed()

bool LVL1::EmTauROI::thresholdPassed ( int thresh ) const

returns TRUE if threshold number threshold_number has been passed by this ROI.

returns TRUE if threshold number threshold_number has been passed by this ROI.

Thresholds numbered from 1 to TrigT1CaloDefs::numOfCPThresholds

Definition at line 44 of file EmTauROI.cxx.

                                                   {
 
    if (m_roiWord & (1<<(thresh-1)) ){
        return true;
    }else{
        return false;
    }
}

◆ thresholdType()

TrigT1CaloDefs::ClusterAlgorithm LVL1::EmTauROI::thresholdType ( int thresh ) const

returns type of thresholds number threshold_number Thresholds numbered from 1 to TrigT1CaloDefs::numOfCPThresholds

returns type of thresholds number threshold_number.

Definition at line 54 of file EmTauROI.cxx.

                                                                          {
    // This information is currently stored as a vector 
    // within all EmTauROIs. This is not ideal - I
    // would rather it was looked up from a database.
  // maybe I should just look it up from CTPCaloConfig?
    if (thresh<1 || thresh > int(TrigT1CaloDefs::numOfCPThresholds)){
        // outside allowed values.
        return TrigT1CaloDefs::ClustAlgError;
    }
    switch ( m_algorithmType[thresh-1] ){
    case 0 : return TrigT1CaloDefs::EMAlg;
             break;
    case 1 : return TrigT1CaloDefs::TauAlg;
             break;
    default : return TrigT1CaloDefs::ClustAlgError;
  }//end switch
        
    // shouldn't ever be reached.
    return TrigT1CaloDefs::ClustAlgError;
}

Member Data Documentation

◆ m_algorithmType

std::vector<unsigned int> LVL1::EmTauROI::m_algorithmType

private

Contains the algo type of thresh sets.

This should really be in a database.

Definition at line 105 of file EmTauROI.h.

◆ m_emClusterEnergy

unsigned int LVL1::EmTauROI::m_emClusterEnergy

private

Used for debugging only!

Not present to higher triggers in hardware

Definition at line 114 of file EmTauROI.h.

◆ m_emRingIsolationEnergy

unsigned int LVL1::EmTauROI::m_emRingIsolationEnergy

private

Used for debugging only!

Not present to higher triggers in hardware

Definition at line 108 of file EmTauROI.h.

◆ m_energy

int LVL1::EmTauROI::m_energy

private

Energy of ROI core, i.e.

the summed (both layers) energy of the central 4 TriggerTowers

Definition at line 97 of file EmTauROI.h.

◆ m_eta

double LVL1::EmTauROI::m_eta

private

eta coord of ROI

Definition at line 93 of file EmTauROI.h.

◆ m_hadCoreEnergy

unsigned int LVL1::EmTauROI::m_hadCoreEnergy

private

Used for debugging only!

Not present to higher triggers in hardware

Definition at line 112 of file EmTauROI.h.

◆ m_hadRingIsolationEnergy

unsigned int LVL1::EmTauROI::m_hadRingIsolationEnergy

private

Used for debugging only!

Not present to higher triggers in hardware

Definition at line 110 of file EmTauROI.h.

◆ m_phi

double LVL1::EmTauROI::m_phi

private

phi coord of ROI

Definition at line 90 of file EmTauROI.h.

◆ m_roiWord

unsigned long int LVL1::EmTauROI::m_roiWord

private

this is the actual format of the data sent from the LVL1 hardware.

See ATL-DAQ-99-015 for further explanation.

Definition at line 102 of file EmTauROI.h.

◆ m_tauClusterEnergy

unsigned int LVL1::EmTauROI::m_tauClusterEnergy

private

Definition at line 115 of file EmTauROI.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ EmTauROI()

◆ ~EmTauROI()

Member Function Documentation

◆ checkValidThreshNum()

◆ clusterEnergy()

◆ emRingIsolationEnergy()

◆ energy()

◆ eta()

◆ hadCoreEnergy()

◆ hadRingIsolationEnergy()

◆ phi()

◆ roiWord()

◆ saturated()

◆ tauClusterEnergy()

◆ thresholdPassed()

◆ thresholdType()

Member Data Documentation

◆ m_algorithmType

◆ m_emClusterEnergy

◆ m_emRingIsolationEnergy

◆ m_energy

◆ m_eta

◆ m_hadCoreEnergy

◆ m_hadRingIsolationEnergy

◆ m_phi

◆ m_roiWord

◆ m_tauClusterEnergy