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.
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.
double	phi () const
	returns phi coord of ROI
double	eta () const
	returns eta coord of ROI
int	energy () const
	returns the energy
bool	thresholdPassed (int threshold_number) const
	returns TRUE if threshold number threshold_number has been passed by this ROI.
bool	fwdThresholdPassed (int threshold_number) const
	returns TRUE if threshold number threshold_number has been passed by this ROI.
bool	isForward () const
	returns true if the RoI is a forward jet
TrigT1CaloDefs::JetWindowSize	thresholdType (int threshold_number) const
	returns type of thresholds number threshold_number
unsigned int	clusterEnergy4 () const
	returns the most energetic cluster from window size 4
unsigned int	clusterEnergy6 () const
	returns the most energetic cluster from window size 6
unsigned int	clusterEnergy8 () const
	returns the most energetic cluster from window size 8

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

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 30 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 15 of file JetROI.cxx.

                 :
  m_phi(phi),
  m_eta(eta),
  m_energy(energy),
  m_cluster4(cluster4),
  m_cluster6(cluster6),
  m_cluster8(cluster8),
  m_roiWord(roiWord),
  m_isSaturated(saturated)
{
}

◆ ~JetROI()

LVL1::JetROI::~JetROI ( )

Definition at line 29 of file JetROI.cxx.

               {
    //delete m_algorithmType;
}

Member Function Documentation

◆ clusterEnergy4()

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

inline

returns the most energetic cluster from window size 4

Definition at line 76 of file JetROI.h.

76{ return m_cluster4;}

◆ clusterEnergy6()

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

inline

returns the most energetic cluster from window size 6

Definition at line 78 of file JetROI.h.

78{ return m_cluster6;}

◆ clusterEnergy8()

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

inline

returns the most energetic cluster from window size 8

Definition at line 80 of file JetROI.h.

80{ return m_cluster8;}

◆ energy()

int LVL1::JetROI::energy ( ) const

returns the energy

returns energy of ROI core

Definition at line 79 of file JetROI.cxx.

                             {
    return m_energy;
}

◆ eta()

double LVL1::JetROI::eta ( ) const

returns eta coord of ROI

Definition at line 68 of file JetROI.cxx.

                             {
  return m_eta;
}

◆ 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 48 of file JetROI.cxx.

                                                    {
  if (m_roiWord & (1<<(thresh+7)) )return true;
  return false;
}

◆ isForward()

bool LVL1::JetROI::isForward ( ) const

returns true if the RoI is a forward jet

Definition at line 54 of file JetROI.cxx.

                                {
  if ((m_eta<-3.1)||(m_eta>3.1)) return true;
  return false;
}

◆ phi()

double LVL1::JetROI::phi ( ) const

returns phi coord of ROI

Definition at line 73 of file JetROI.cxx.

                             {
  return m_phi;
}

◆ 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 35 of file JetROI.cxx.

                                      {
  return m_roiWord;
}

◆ 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 88 of file JetROI.cxx.

                                 {
  return m_isSaturated;
}

◆ 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 41 of file JetROI.cxx.

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

◆ 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 61 of file JetROI.cxx.

                                                                    {
  // shouldn't ever be reached.
  return TrigT1CaloDefs::JetWinError;
}

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 111 of file JetROI.h.

◆ m_cluster4

int LVL1::JetROI::m_cluster4

private

Energy of most energetic cluster.

Definition at line 94 of file JetROI.h.

◆ m_cluster6

int LVL1::JetROI::m_cluster6

private

Energy of most energetic cluster.

Definition at line 97 of file JetROI.h.

◆ m_cluster8

int LVL1::JetROI::m_cluster8

private

Energy of most energetic cluster.

Definition at line 100 of file JetROI.h.

◆ m_energy

int LVL1::JetROI::m_energy

private

Energy of ROI core,.

Definition at line 91 of file JetROI.h.

◆ m_eta

double LVL1::JetROI::m_eta

private

eta coord of ROI

Definition at line 88 of file JetROI.h.

◆ m_isSaturated

bool LVL1::JetROI::m_isSaturated

private

saturation flag

Definition at line 108 of file JetROI.h.

◆ m_phi

double LVL1::JetROI::m_phi

private

phi coord of ROI

Definition at line 85 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 105 of file JetROI.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ JetROI()

◆ ~JetROI()

Member Function Documentation

◆ clusterEnergy4()

◆ clusterEnergy6()

◆ clusterEnergy8()

◆ energy()

◆ eta()

◆ fwdThresholdPassed()

◆ isForward()

◆ phi()

◆ roiWord()

◆ saturated()

◆ thresholdPassed()

◆ thresholdType()

Member Data Documentation

◆ m_algorithmType

◆ m_cluster4

◆ m_cluster6

◆ m_cluster8

◆ m_energy

◆ m_eta

◆ m_isSaturated

◆ m_phi

◆ m_roiWord