This class defines the reconstructed EnergySum ROI. More...

#include <RecEnergyRoI.h>

Collaboration diagram for LVL1::RecEnergyRoI:

Public Member Functions
	RecEnergyRoI ()

	RecEnergyRoI (unsigned int RoIWord0, unsigned int RoIWord1, unsigned int RoIWord2, const std::vector< TrigConf::TriggerThreshold * > *caloThresholds)

	RecEnergyRoI (unsigned int RoIWord0, unsigned int RoIWord1, unsigned int RoIWord2, const TrigConf::L1Menu *const l1menu)
	constructor using Run 3 configuration More...

	~RecEnergyRoI ()

	RecEnergyRoI (const RecEnergyRoI &obj)

RecEnergyRoI &	operator= (const RecEnergyRoI &obj)

void	construct (unsigned int RoIWord0, unsigned int RoIWord1, unsigned int RoIWord2, const std::vector< TrigConf::TriggerThreshold * > *caloThresholds)
	The "construct" call unpacks the RoIWord and copies information about the passed thresholds from the vector of TriggerThresholds into maps for later retrieval. More...

void	construct (const TrigConf::L1Menu *const l1menu)

unsigned int	roiWord0 () const
	returns roi word 0. More...

unsigned int	roiWord1 () const
	returns roi word 1. More...

unsigned int	roiWord2 () const
	returns roi word 2. More...

bool	passedEtMissThreshold (unsigned int thresholdNumber) const
	returns TRUE if threshold number threshold_number has been passed by this ROI. More...

bool	passedSumEtThreshold (unsigned int thresholdNumber) const
	returns TRUE if threshold number threshold_number has been passed by this ROI. More...

bool	passedMEtSigThreshold (unsigned int thresholdNumber) const
	returns TRUE if threshold number threshold_number has been passed by this ROI. More...

std::vector< unsigned int >	etMissThresholdsPassed () const
	returns a vector of thresholds passed. More...

std::vector< unsigned int >	sumEtThresholdsPassed () const
	returns a vector of thresholds passed. More...

std::vector< unsigned int >	mEtSigThresholdsPassed () const
	returns a vector of thresholds passed. More...

unsigned int	etMissTriggerThreshold (const unsigned int thresh) const
	returns the value of the trigger threshold for the threshold passed. More...

unsigned int	sumEtTriggerThreshold (const unsigned int thresh) const
	returns the value of the trigger threshold for the threshold passed. More...

unsigned int	mEtSigTriggerThreshold (const unsigned int thresh) const
	returns the value of the trigger threshold for the threshold passed. More...

bool	isValidEtMissThreshold (const unsigned int thresh) const
	returns true if thresh is a valid EtMiss threshold number More...

bool	isValidSumEtThreshold (const unsigned int thresh) const
	returns true if thresh is a valid Sum Et threshold number More...

bool	isValidMEtSigThreshold (const unsigned int thresh) const
	returns true if thresh is a valid Sum Et threshold number More...

int	energyX () const
	returns the (signed) Ex energy projection. More...

bool	overflowX () const
	returns the Ex overflow bit More...

int	energyY () const
	returns the (signed) Ey energy projection. More...

bool	overflowY () const
	returns the Ey overflow bit More...

int	energyT () const
	returns the total ET. More...

bool	overflowT () const
	returns the ETsum overflow bit More...

Private Attributes
unsigned long int	m_roiWord0 { 0 }
	this is the actual format of the data sent from the LVL1 hardware. More...

unsigned long int	m_roiWord1 { 0 }
	this is the actual format of the data sent from the LVL1 hardware. More...

unsigned long int	m_roiWord2 { 0 }
	this is the actual format of the data sent from the LVL1 hardware. More...

std::map< int, unsigned int >	m_etMissThresholdValue

std::map< int, unsigned int >	m_sumEtThresholdValue

std::map< int, unsigned int >	m_mEtSigThresholdValue

Detailed Description

This class defines the reconstructed EnergySum ROI.

It is generated from the Slink output of TrigT1Calo

Author: Edward Moyse

Definition at line 37 of file RecEnergyRoI.h.

Constructor & Destructor Documentation

◆ RecEnergyRoI() [1/4]

LVL1::RecEnergyRoI::RecEnergyRoI ( )

inline

Definition at line 41 of file RecEnergyRoI.h.

41 {}

◆ RecEnergyRoI() [2/4]

LVL1::RecEnergyRoI::RecEnergyRoI	(	unsigned int	RoIWord0,
		unsigned int	RoIWord1,
		unsigned int	RoIWord2,
		const std::vector< TrigConf::TriggerThreshold * > *	caloThresholds
	)

Definition at line 26 of file RecEnergyRoI.cxx.

 {
  
    this->construct(RoIWord0, RoIWord1, RoIWord2, caloThresholds);
 }

◆ RecEnergyRoI() [3/4]

LVL1::RecEnergyRoI::RecEnergyRoI	(	unsigned int	RoIWord0,
		unsigned int	RoIWord1,
		unsigned int	RoIWord2,
		const TrigConf::L1Menu *const	l1menu
	)

constructor using Run 3 configuration

Definition at line 33 of file RecEnergyRoI.cxx.

     : m_roiWord0(RoIWord0),
       m_roiWord1(RoIWord1),
       m_roiWord2(RoIWord2)
 {
    construct(l1menu);
 }

◆ ~RecEnergyRoI()

LVL1::RecEnergyRoI::~RecEnergyRoI ( )

Definition at line 68 of file RecEnergyRoI.cxx.

68 {}

◆ RecEnergyRoI() [4/4]

LVL1::RecEnergyRoI::RecEnergyRoI ( const RecEnergyRoI & obj )

Definition at line 43 of file RecEnergyRoI.cxx.

     : m_roiWord0(obj.m_roiWord0),
       m_roiWord1(obj.m_roiWord1),
       m_roiWord2(obj.m_roiWord2),
       m_etMissThresholdValue(obj.m_etMissThresholdValue),
       m_sumEtThresholdValue(obj.m_sumEtThresholdValue),
       m_mEtSigThresholdValue(obj.m_mEtSigThresholdValue)
 {
 }

Member Function Documentation

◆ construct() [1/2]

void LVL1::RecEnergyRoI::construct ( const TrigConf::L1Menu *const l1menu )

Definition at line 132 of file RecEnergyRoI.cxx.

 {
    // Find which thresholds this RoI passed and copy the values into the maps
    if ( ! l1menu->thresholds("XE").empty() ) {
       for (unsigned int xeMapping : etMissThresholdsPassed())
       {
          const TrigConf::L1Threshold &thr = l1menu->threshold("XE", xeMapping - 1);
          auto &caloThr = dynamic_cast<const TrigConf::L1Threshold_Calo &>(thr);
          m_etMissThresholdValue[xeMapping] = caloThr.thrValueCounts();
       }
    }
    if ( ! l1menu->thresholds("TE").empty() ) {
       for (unsigned int teMapping : sumEtThresholdsPassed())
       {
          const TrigConf::L1Threshold &thr = l1menu->threshold("TE", teMapping - 1);
          auto &caloThr = dynamic_cast<const TrigConf::L1Threshold_Calo &>(thr);
          m_sumEtThresholdValue[teMapping] = caloThr.thrValueCounts();
       }
    }
    if ( ! l1menu->thresholds("XS").empty() ) {
       for (unsigned int xsMapping : mEtSigThresholdsPassed())
       {
          const TrigConf::L1Threshold &thr = l1menu->threshold("XS", xsMapping - 1);
          auto &caloThr = dynamic_cast<const TrigConf::L1Threshold_Calo &>(thr);
          m_mEtSigThresholdValue[xsMapping] = caloThr.thrValueCounts();
       }
    }
 }

◆ construct() [2/2]

void LVL1::RecEnergyRoI::construct	(	unsigned int	RoIWord0,
		unsigned int	RoIWord1,
		unsigned int	RoIWord2,
		const std::vector< TrigConf::TriggerThreshold * > *	caloThresholds
	)

The "construct" call unpacks the RoIWord and copies information about the passed thresholds from the vector of TriggerThresholds into maps for later retrieval.

One warning here: the methods of the RecRoI classes assume threshold numbering starts at 1, rather than 0 in the calorimeter trigger simulation and Lvl1ConfigSvc. There will be some tweaks in this code to make this work.

Definition at line 76 of file RecEnergyRoI.cxx.

 {
    m_roiWord0 = RoIWord0;
    m_roiWord1 = RoIWord1;
    m_roiWord2 = RoIWord2;
  
    // Copy threshold values into maps for matching to list of thresholds passed
    std::map< int, TriggerThreshold* > etMissMap;
    std::map< int, TriggerThreshold* > sumEtMap;
    std::map< int, TriggerThreshold* > mEtSigMap;
    for( std::vector< TriggerThreshold* >::const_iterator it = caloThresholds->begin();
          it != caloThresholds->end(); ++it ) {
       if( ( *it )->type() == L1DataDef::typeAsString(L1DataDef::XE) ) {
          int num = ( *it )->thresholdNumber();
          etMissMap.insert( std::map< int, TriggerThreshold* >::value_type( num, *it ) );
       }
       else if( ( *it )->type() == L1DataDef::typeAsString(L1DataDef::TE) ) {
          int num = ( *it )->thresholdNumber();
          sumEtMap.insert( std::map< int, TriggerThreshold* >::value_type( num, *it ) );
       }
       else if( ( *it )->type() == L1DataDef::typeAsString(L1DataDef::XS) ) {
          int num = ( *it )->thresholdNumber();
          mEtSigMap.insert( std::map< int, TriggerThreshold* >::value_type( num, *it ) );
       }
    }
  
    // Find which thresholds this RoI passed and copy the values into the maps
    for (unsigned int xeMapping : etMissThresholdsPassed())
    {
       std::map<int, TriggerThreshold *>::const_iterator thr = etMissMap.find(xeMapping - 1);
       if (thr != etMissMap.end()) {
          TriggerThresholdValue* ttv = thr->second->triggerThresholdValue(0,0);
          m_etMissThresholdValue.insert(std::map<int, unsigned int>::value_type(xeMapping, ttv->thresholdValueCount()));
       }
    }
  
    for (unsigned int teMapping : sumEtThresholdsPassed())
    {
       std::map<int, TriggerThreshold *>::const_iterator thr = sumEtMap.find(teMapping - 1);
       if (thr != sumEtMap.end()) {
          TriggerThresholdValue* ttv = thr->second->triggerThresholdValue(0,0);
          m_sumEtThresholdValue.insert(std::map<int, unsigned int>::value_type(teMapping, ttv->thresholdValueCount()));
       }
    }
  
    for (unsigned int xsMapping : mEtSigThresholdsPassed())
    {
       std::map<int, TriggerThreshold *>::const_iterator thr = mEtSigMap.find(xsMapping - 1);
       if (thr != mEtSigMap.end()) {
          TriggerThresholdValue* ttv = thr->second->triggerThresholdValue(0,0);
          m_mEtSigThresholdValue.insert(std::map<int, unsigned int>::value_type(xsMapping, ttv->thresholdValueCount()));
       }
    }
 }

◆ energyT()

int LVL1::RecEnergyRoI::energyT ( ) const

returns the total ET.

returns the (signed) Ex energy projection.

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

Definition at line 309 of file RecEnergyRoI.cxx.

 {
    JEPRoIDecoder get;
    return get.energyT(m_roiWord2);
 }

◆ energyX()

int LVL1::RecEnergyRoI::energyX ( ) const

returns the (signed) Ex energy projection.

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

Definition at line 291 of file RecEnergyRoI.cxx.

 {
  
    JEPRoIDecoder get;
    return get.energyX(m_roiWord0);
 }

◆ energyY()

int LVL1::RecEnergyRoI::energyY ( ) const

returns the (signed) Ey energy projection.

returns the (signed) Ex energy projection.

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

Definition at line 300 of file RecEnergyRoI.cxx.

 {
  
    JEPRoIDecoder get;
    return get.energyY(m_roiWord1);
 }

◆ etMissThresholdsPassed()

vector< unsigned int > LVL1::RecEnergyRoI::etMissThresholdsPassed ( ) const

returns a vector of thresholds passed.

Definition at line 213 of file RecEnergyRoI.cxx.

 {
    JEPRoIDecoder get;
    return get.etMissThresholdsPassed(m_roiWord2);
 }

◆ etMissTriggerThreshold()

unsigned int LVL1::RecEnergyRoI::etMissTriggerThreshold ( const unsigned int thresh ) const

returns the value of the trigger threshold for the threshold passed.

The trigger threshold is also sometimes called the cluster threshold.

Definition at line 235 of file RecEnergyRoI.cxx.

 {
    std::map< int, unsigned int >::const_iterator it = m_etMissThresholdValue.find( thresh );
    if( it != m_etMissThresholdValue.end() ) {
       return it->second;
    }
    return TrigT1CaloDefs::Error;
 }

◆ isValidEtMissThreshold()

bool LVL1::RecEnergyRoI::isValidEtMissThreshold ( const unsigned int thresh ) const

returns true if thresh is a valid EtMiss threshold number

returns true if thresh is a valid threshold number

Definition at line 269 of file RecEnergyRoI.cxx.

 {
  
    return (thresh <= TrigT1CaloDefs::numOfMissingEtThresholds);
 }

◆ isValidMEtSigThreshold()

bool LVL1::RecEnergyRoI::isValidMEtSigThreshold ( const unsigned int thresh ) const

returns true if thresh is a valid Sum Et threshold number

returns true if thresh is a valid threshold number

Definition at line 283 of file RecEnergyRoI.cxx.

 {
  
    return (thresh <= TrigT1CaloDefs::numOfMEtSigThresholds);
 }

◆ isValidSumEtThreshold()

bool LVL1::RecEnergyRoI::isValidSumEtThreshold ( const unsigned int thresh ) const

returns true if thresh is a valid Sum Et threshold number

returns true if thresh is a valid threshold number

Definition at line 276 of file RecEnergyRoI.cxx.

 {
  
    return (thresh <= TrigT1CaloDefs::numOfSumEtThresholds);
 }

◆ mEtSigThresholdsPassed()

vector< unsigned int > LVL1::RecEnergyRoI::mEtSigThresholdsPassed ( ) const

returns a vector of thresholds passed.

Definition at line 227 of file RecEnergyRoI.cxx.

 {
    JEPRoIDecoder get;
    return get.mEtSigThresholdsPassed(m_roiWord0);
 }

◆ mEtSigTriggerThreshold()

unsigned int LVL1::RecEnergyRoI::mEtSigTriggerThreshold ( const unsigned int thresh ) const

returns the value of the trigger threshold for the threshold passed.

The trigger threshold is also sometimes called the cluster threshold.

Definition at line 258 of file RecEnergyRoI.cxx.

 {
  
    std::map< int, unsigned int >::const_iterator it = m_mEtSigThresholdValue.find( thresh );
    if( it != m_mEtSigThresholdValue.end() ) {
       return it->second;
    }
    return TrigT1CaloDefs::Error;
 }

◆ operator=()

LVL1::RecEnergyRoI & LVL1::RecEnergyRoI::operator= ( const RecEnergyRoI & obj )

Definition at line 55 of file RecEnergyRoI.cxx.

 {
    if(this != &rhs) {
       m_roiWord0 = rhs.m_roiWord0;
       m_roiWord1 = rhs.m_roiWord1;
       m_roiWord2 = rhs.m_roiWord2;
       m_etMissThresholdValue = rhs.m_etMissThresholdValue;
       m_sumEtThresholdValue = rhs.m_sumEtThresholdValue;
       m_mEtSigThresholdValue = rhs.m_mEtSigThresholdValue;
    }
    return *this;
 }

◆ overflowT()

bool LVL1::RecEnergyRoI::overflowT ( ) const

returns the ETsum overflow bit

Definition at line 330 of file RecEnergyRoI.cxx.

 {
    JEPRoIDecoder get;
    return get.energyOverflow(m_roiWord2);
 }

◆ overflowX()

bool LVL1::RecEnergyRoI::overflowX ( ) const

returns the Ex overflow bit

Definition at line 316 of file RecEnergyRoI.cxx.

 {
    JEPRoIDecoder get;
    return get.energyOverflow(m_roiWord0);
 }

◆ overflowY()

bool LVL1::RecEnergyRoI::overflowY ( ) const

returns the Ey overflow bit

Definition at line 323 of file RecEnergyRoI.cxx.

 {
    JEPRoIDecoder get;
    return get.energyOverflow(m_roiWord1);
 }

◆ passedEtMissThreshold()

bool LVL1::RecEnergyRoI::passedEtMissThreshold ( unsigned int thresholdNumber ) const

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

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

Definition at line 178 of file RecEnergyRoI.cxx.

 {
  
    if ( this->isValidEtMissThreshold( thresholdNumber ) ) {
       JEPRoIDecoder get;
       return ( get.etMissThresholdPassed( m_roiWord2, thresholdNumber ) );
    }
    return false;
 }

◆ passedMEtSigThreshold()

bool LVL1::RecEnergyRoI::passedMEtSigThreshold ( unsigned int thresholdNumber ) const

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

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

Definition at line 202 of file RecEnergyRoI.cxx.

 {
  
    if ( this->isValidSumEtThreshold( thresholdNumber ) ) {
       JEPRoIDecoder get;
       return ( get.mEtSigThresholdPassed( m_roiWord0, thresholdNumber ) );
    }
    return false;
 }

◆ passedSumEtThreshold()

bool LVL1::RecEnergyRoI::passedSumEtThreshold ( unsigned int thresholdNumber ) const

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

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

Definition at line 190 of file RecEnergyRoI.cxx.

 {
  
    if ( this->isValidSumEtThreshold( thresholdNumber ) ) {
       JEPRoIDecoder get;
       return ( get.sumEtThresholdPassed( m_roiWord1, thresholdNumber ) );
    }
    return false;
 }

◆ roiWord0()

unsigned int LVL1::RecEnergyRoI::roiWord0 ( ) const

returns roi word 0.

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

Definition at line 161 of file RecEnergyRoI.cxx.

 {
    return m_roiWord0;
 }

◆ roiWord1()

unsigned int LVL1::RecEnergyRoI::roiWord1 ( ) const

returns roi word 1.

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

Definition at line 166 of file RecEnergyRoI.cxx.

 {
    return m_roiWord1;
 }

◆ roiWord2()

unsigned int LVL1::RecEnergyRoI::roiWord2 ( ) const

returns roi word 2.

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

Definition at line 171 of file RecEnergyRoI.cxx.

 {
    return m_roiWord2;
 }

◆ sumEtThresholdsPassed()

vector< unsigned int > LVL1::RecEnergyRoI::sumEtThresholdsPassed ( ) const

returns a vector of thresholds passed.

Definition at line 220 of file RecEnergyRoI.cxx.

 {
    JEPRoIDecoder get;
    return get.etSumThresholdsPassed(m_roiWord1);
 }

◆ sumEtTriggerThreshold()

unsigned int LVL1::RecEnergyRoI::sumEtTriggerThreshold ( const unsigned int thresh ) const

returns the value of the trigger threshold for the threshold passed.

The trigger threshold is also sometimes called the cluster threshold.

Definition at line 246 of file RecEnergyRoI.cxx.

 {
  
    std::map< int, unsigned int >::const_iterator it = m_sumEtThresholdValue.find( thresh );
    if( it != m_sumEtThresholdValue.end() ) {
       return it->second;
    }
    return TrigT1CaloDefs::Error;
 }

Member Data Documentation

◆ m_etMissThresholdValue

std::map< int, unsigned int > LVL1::RecEnergyRoI::m_etMissThresholdValue

private

Definition at line 147 of file RecEnergyRoI.h.

◆ m_mEtSigThresholdValue

std::map< int, unsigned int > LVL1::RecEnergyRoI::m_mEtSigThresholdValue

private

Definition at line 149 of file RecEnergyRoI.h.

◆ m_roiWord0

unsigned long int LVL1::RecEnergyRoI::m_roiWord0 { 0 }

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 137 of file RecEnergyRoI.h.

◆ m_roiWord1

unsigned long int LVL1::RecEnergyRoI::m_roiWord1 { 0 }

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 141 of file RecEnergyRoI.h.

◆ m_roiWord2

unsigned long int LVL1::RecEnergyRoI::m_roiWord2 { 0 }

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 145 of file RecEnergyRoI.h.

◆ m_sumEtThresholdValue

std::map< int, unsigned int > LVL1::RecEnergyRoI::m_sumEtThresholdValue

private

Definition at line 148 of file RecEnergyRoI.h.

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RecEnergyRoI() [1/4]

◆ RecEnergyRoI() [2/4]

◆ RecEnergyRoI() [3/4]

◆ ~RecEnergyRoI()

◆ RecEnergyRoI() [4/4]

Member Function Documentation

◆ construct() [1/2]

◆ construct() [2/2]

◆ energyT()

◆ energyX()

◆ energyY()

◆ etMissThresholdsPassed()

◆ etMissTriggerThreshold()

◆ isValidEtMissThreshold()

◆ isValidMEtSigThreshold()

◆ isValidSumEtThreshold()

◆ mEtSigThresholdsPassed()

◆ mEtSigTriggerThreshold()

◆ operator=()

◆ overflowT()

◆ overflowX()

◆ overflowY()

◆ passedEtMissThreshold()

◆ passedMEtSigThreshold()

◆ passedSumEtThreshold()

◆ roiWord0()

◆ roiWord1()

◆ roiWord2()

◆ sumEtThresholdsPassed()

◆ sumEtTriggerThreshold()

Member Data Documentation

◆ m_etMissThresholdValue

◆ m_mEtSigThresholdValue

◆ m_roiWord0

◆ m_roiWord1

◆ m_roiWord2

◆ m_sumEtThresholdValue