ATLAS Offline Software
Public Member Functions | Private Attributes | List of all members
LVL1::JetROI Class Reference

This class defines the Jet ROIs which are generated by the LVL1 Calo Trigger. More...

#include <JetROI.h>

Collaboration diagram for LVL1::JetROI:

Public Member Functions

 JetROI (double phi, double eta, int energy, unsigned long int roiWord, unsigned int m_cluster4, unsigned int m_cluster6, unsigned int m_cluster8, bool saturated)
 
 ~JetROI ()
 
unsigned int roiWord () const
 returns the 32bit ROI word. More...
 
bool saturated () const
 returns TRUE if ROI constructed from a Jet Element that was saturated - in other words this ROI is signalling that it does not know it's correct energy. More...
 
double phi () const
 returns phi coord of ROI More...
 
double eta () const
 returns eta coord of ROI More...
 
int energy () const
 returns the energy More...
 
bool thresholdPassed (int threshold_number) const
 returns TRUE if threshold number threshold_number has been passed by this ROI. More...
 
bool fwdThresholdPassed (int threshold_number) const
 returns TRUE if threshold number threshold_number has been passed by this ROI. More...
 
bool isForward () const
 returns true if the RoI is a forward jet More...
 
TrigT1CaloDefs::JetWindowSize thresholdType (int threshold_number) const
 returns type of thresholds number threshold_number More...
 
unsigned int clusterEnergy4 () const
 returns the most energetic cluster from window size 4 More...
 
unsigned int clusterEnergy6 () const
 returns the most energetic cluster from window size 6 More...
 
unsigned int clusterEnergy8 () const
 returns the most energetic cluster from window size 8 More...
 

Private Attributes

double m_phi
 phi coord of ROI More...
 
double m_eta
 eta coord of ROI More...
 
int m_energy
 Energy of ROI core,. More...
 
int m_cluster4
 Energy of most energetic cluster. More...
 
int m_cluster6
 Energy of most energetic cluster. More...
 
int m_cluster8
 Energy of most energetic cluster. More...
 
unsigned long int m_roiWord
 this is the actual format of the data sent from the LVL1 hardware. More...
 
bool m_isSaturated
 saturation flag More...
 
std::vector< unsigned int > m_algorithmType
 Contains the algo type of thresh sets. More...
 

Detailed Description

This class defines the Jet ROIs which are generated by the LVL1 Calo Trigger.

These are not the persistent objects - you should use Jet_ROI (from RoIB) for analysis, and JEMRoI for bytestream decoding and monitoring.

Author
moyse

Definition at line 35 of file JetROI.h.

Constructor & Destructor Documentation

◆ JetROI()

LVL1::JetROI::JetROI ( double  phi,
double  eta,
int  energy,
unsigned long int  roiWord,
unsigned int  m_cluster4,
unsigned int  m_cluster6,
unsigned int  m_cluster8,
bool  saturated 
)

Definition at line 20 of file JetROI.cxx.

26 {
27 }
28 
30  //delete m_algorithmType;
31 }
32 

◆ ~JetROI()

LVL1::JetROI::~JetROI ( )

Definition at line 34 of file JetROI.cxx.

35  {
36  return m_roiWord;

Member Function Documentation

◆ clusterEnergy4()

unsigned int LVL1::JetROI::clusterEnergy4 ( ) const
inline

returns the most energetic cluster from window size 4

Definition at line 86 of file JetROI.h.

◆ clusterEnergy6()

unsigned int LVL1::JetROI::clusterEnergy6 ( ) const
inline

returns the most energetic cluster from window size 6

Definition at line 88 of file JetROI.h.

◆ clusterEnergy8()

unsigned int LVL1::JetROI::clusterEnergy8 ( ) const
inline

returns the most energetic cluster from window size 8

Definition at line 90 of file JetROI.h.

◆ energy()

int LVL1::JetROI::energy ( ) const

returns the energy

returns energy of ROI core

Definition at line 84 of file JetROI.cxx.

◆ eta()

double LVL1::JetROI::eta ( ) const

returns eta coord of ROI

Definition at line 73 of file JetROI.cxx.

73  {
74  return m_phi;
75 }

◆ fwdThresholdPassed()

bool LVL1::JetROI::fwdThresholdPassed ( int  threshold_number) 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.

1st threshold is thresh 1

Definition at line 53 of file JetROI.cxx.

54  {
55  if ((m_eta<-3.1)||(m_eta>3.1)) return true;
56  return false;

◆ isForward()

bool LVL1::JetROI::isForward ( ) const

returns true if the RoI is a forward jet

Definition at line 59 of file JetROI.cxx.

61  {
62  // shouldn't ever be reached.

◆ phi()

double LVL1::JetROI::phi ( ) const

returns phi coord of ROI

Definition at line 78 of file JetROI.cxx.

79  {
80  return m_energy;

◆ roiWord()

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

returns the 32bit ROI word.

Todo:
implement hardware coords in ROI word
Todo:
implement hardware coords in ROI word

Definition at line 40 of file JetROI.cxx.

41  {
42  if (m_roiWord & (1<<(thresh-1)) )return true;

◆ saturated()

bool LVL1::JetROI::saturated ( ) const

returns TRUE if ROI constructed from a Jet Element that was saturated - in other words this ROI is signalling that it does not know it's correct energy.

Todo:
implement

Definition at line 93 of file JetROI.cxx.

◆ thresholdPassed()

bool LVL1::JetROI::thresholdPassed ( int  threshold_number) 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.

1st threshold is thresh 1

Definition at line 46 of file JetROI.cxx.

48  {
49  if (m_roiWord & (1<<(thresh+7)) )return true;

◆ thresholdType()

LVL1::TrigT1CaloDefs::JetWindowSize LVL1::JetROI::thresholdType ( int  threshold_number) const

returns type of thresholds number threshold_number

returns type of thresholds number threshold_number.

Todo:
implement

Definition at line 66 of file JetROI.cxx.

68  {
69  return m_eta;

Member Data Documentation

◆ m_algorithmType

std::vector<unsigned int> LVL1::JetROI::m_algorithmType
private

Contains the algo type of thresh sets.

This should really be in a database.

Definition at line 121 of file JetROI.h.

◆ m_cluster4

int LVL1::JetROI::m_cluster4
private

Energy of most energetic cluster.

Definition at line 104 of file JetROI.h.

◆ m_cluster6

int LVL1::JetROI::m_cluster6
private

Energy of most energetic cluster.

Definition at line 107 of file JetROI.h.

◆ m_cluster8

int LVL1::JetROI::m_cluster8
private

Energy of most energetic cluster.

Definition at line 110 of file JetROI.h.

◆ m_energy

int LVL1::JetROI::m_energy
private

Energy of ROI core,.

Definition at line 101 of file JetROI.h.

◆ m_eta

double LVL1::JetROI::m_eta
private

eta coord of ROI

Definition at line 98 of file JetROI.h.

◆ m_isSaturated

bool LVL1::JetROI::m_isSaturated
private

saturation flag

Definition at line 118 of file JetROI.h.

◆ m_phi

double LVL1::JetROI::m_phi
private

phi coord of ROI

Definition at line 95 of file JetROI.h.

◆ m_roiWord

unsigned long int LVL1::JetROI::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 115 of file JetROI.h.


The documentation for this class was generated from the following files:
LVL1::JetROI::m_eta
double m_eta
eta coord of ROI
Definition: JetROI.h:98
physval_make_web_display.thresh
thresh
Definition: physval_make_web_display.py:36
LVL1::JetROI::~JetROI
~JetROI()
Definition: JetROI.cxx:34
LVL1::JetROI::m_roiWord
unsigned long int m_roiWord
this is the actual format of the data sent from the LVL1 hardware.
Definition: JetROI.h:115
LVL1::JetROI::m_energy
int m_energy
Energy of ROI core,.
Definition: JetROI.h:101
LVL1::JetROI::m_phi
double m_phi
phi coord of ROI
Definition: JetROI.h:95