#include <eFEXegAlgo.h>

Inheritance diagram for LVL1::eFEXegAlgo:

Collaboration diagram for LVL1::eFEXegAlgo:

Classes
class	Corrections

Public Member Functions
	eFEXegAlgo (const std::string &type, const std::string &name, const IInterface *parent)
	Constructors. More...

virtual StatusCode	initialize ()
	standard Athena-Algorithm method More...

virtual	~eFEXegAlgo ()
	Destructor. More...

virtual StatusCode	safetyTest () const

virtual void	setup (int inputTable[3][3], int efex_id, int fpga_id, int central_eta)

virtual void	getReta (std::vector< unsigned int > &)

virtual void	getRhad (std::vector< unsigned int > &)

virtual void	getWstot (std::vector< unsigned int > &)

virtual void	getRealPhi (float &phi)

virtual void	getRealEta (float &eta)

virtual std::unique_ptr< eFEXegTOB >	geteFEXegTOB ()

virtual void	getClusterCells (std::vector< unsigned int > &cellETs)
	Return cell ET values used in cluster. More...

virtual unsigned int	getET ()

virtual unsigned int	dmCorrection (unsigned int ET, unsigned int layer)

virtual void	getWindowET (int layer, int jPhi, int SCID, unsigned int &)

virtual bool	hasSeed () const

virtual unsigned int	getSeed () const

virtual unsigned int	getUnD () const

virtual void	getCoreEMTowerET (unsigned int &et)

virtual void	getCoreHADTowerET (unsigned int &et)

virtual void	getSums (unsigned int seed, bool UnD, std::vector< unsigned int > &RetaSums, std::vector< unsigned int > &RhadSums, std::vector< unsigned int > &WstotSums)

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static const InterfaceID &	interfaceID ()

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	setSeed ()

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
bool	m_seed_UnD = false

unsigned int	m_seedID = 999

int	m_eFEXegAlgoTowerID [3][3] {}

int	m_efexid {}

int	m_fpgaid {}

int	m_central_eta {}

bool	m_hasSeed {}

Corrections m_corrections	ATLAS_THREAD_SAFE

Gaudi::Property< bool >	m_dmCorr {this, "dmCorr", false, "Enable dead material correctionst"}

Gaudi::Property< int >	m_algoVersion {this, "algoVersion", 0, "AlgoVersion, part of the L1Menu spec"}

SG::ReadHandleKey< LVL1::eTowerContainer >	m_eTowerContainerKey {this, "MyETowers", "eTowerContainer", "Input container for eTowers"}

SG::ReadCondHandleKey< CondAttrListCollection >	m_dmCorrectionsKey

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 31 of file eFEXegAlgo.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ eFEXegAlgo()

LVL1::eFEXegAlgo::eFEXegAlgo	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Constructors.

Definition at line 23 of file eFEXegAlgo.cxx.

                                                                                                 :
             AthAlgTool(type, name, parent)
     {
         declareInterface<eFEXegAlgo>(this);
     }

◆ ~eFEXegAlgo()

LVL1::eFEXegAlgo::~eFEXegAlgo ( )

virtual

Destructor.

Definition at line 30 of file eFEXegAlgo.cxx.

31 {

32 }

Member Function Documentation

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                      {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ dmCorrection()

unsigned int LVL1::eFEXegAlgo::dmCorrection	(	unsigned int	ET,
		unsigned int	layer
	)

virtual

Check corrections are required and layer is valid, otherwise do nothing

Get correction factor Start by calculating RoI |eta| with range 0-24

Retrieve the factor from table (eventually from DB)

Calculate correction Factors are 7 bit words, highest bit corresponding to the most significant term in the correction (ET/2). So we'll work backwards from the top bit (bit 6) to implement it

And this should now be the corrected ET

Definition at line 365 of file eFEXegAlgo.cxx.

                                                                                   {
         if ( !m_dmCorr || layer > 2 ) return ET;
  
         int efexEta = m_efexid%3;
         int ieta = 0;
         if (efexEta == 2) {  // Rightmost eFEX
             // m_central_eta has range 1-4 or 1-5
             ieta = 8 + m_fpgaid*4 + m_central_eta - 1;
         }
         else if (efexEta == 1 && m_fpgaid > 1) { // central eFEX, eta > 0
             // m_central_eta has range 1-4
             ieta = (m_fpgaid-2)*4 + m_central_eta - 1;
         }
         else if (efexEta == 1) { // central eFEX, eta < 0
             // m_central_eta had range 1-4
             ieta = (1-m_fpgaid)*4 + (4-m_central_eta);
         }
         else {   // Leftmost eFEX
             // m_central_eta has range 0-4 or 1-4
             ieta = 8 + 4*(3-m_fpgaid) + (4-m_central_eta);
         }
  
     static std::once_flag flag;
     std::call_once(flag, [&]() {
  
             if (!m_dmCorrectionsKey.empty()) {
                 // replace m_corrections values with values from database ... only try this once
                 SG::ReadCondHandle <CondAttrListCollection> dmCorrections{m_dmCorrectionsKey/*, ctx*/ };
                 if (dmCorrections.isValid()) {
                     if(dmCorrections->size()==0 && Gaudi::Hive::currentContext().eventID().time_stamp()>1672527600) { // not an error for data before 2023 (will include MC21 and MC23a)
                         ATH_MSG_ERROR("No dead material corrections found in conditions database for this event in folder " << m_dmCorrectionsKey.key());
                         throw std::runtime_error("No dead material corrections found in database for this event");
                     }
                     m_corrections = Corrections (*dmCorrections.cptr(), msg());
                 }
         ATH_MSG_INFO("Loaded DM Corrections from database");
             }
         });
  
         unsigned int factor = m_corrections.corr(layer, ieta);
  
         unsigned int correction = ET;
         for (int bit = 6; bit >= 0; bit--) {
             correction /= 2;
             if (factor & (1<<bit))
                 ET += correction;
         }
         return ET;
     }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ getClusterCells()

void LVL1::eFEXegAlgo::getClusterCells ( std::vector< unsigned int > & cellETs )

virtual

Return cell ET values used in cluster.

Placed in its own function to allow other classes to access these

Definition at line 269 of file eFEXegAlgo.cxx.

                                                                          {
  
         int phiUpDownID = 0;
         if (m_seed_UnD) phiUpDownID = 2;
  
         // Initialise results vector
         cellETs.resize(16,0);
         // Fill vector with 2 PS cells, 6 L1, 6 L2, 2 L3
         // Presampler
         getWindowET(0, 1, 0, cellETs[0]);
         getWindowET(0, phiUpDownID, 0, cellETs[1]);
         // central phi Layer 1
         getWindowET(1, 1, m_seedID,     cellETs[2]);
         getWindowET(1, 1, m_seedID - 1, cellETs[3]);
         getWindowET(1, 1, m_seedID + 1, cellETs[4]);
         // top/bottom phi Layer 1
         getWindowET(1, phiUpDownID, m_seedID,     cellETs[5]);
         getWindowET(1, phiUpDownID, m_seedID - 1, cellETs[6]);
         getWindowET(1, phiUpDownID, m_seedID + 1, cellETs[7]);
         // central phi Layer 2
         getWindowET(2, 1, m_seedID,     cellETs[8]);
         getWindowET(2, 1, m_seedID - 1, cellETs[9]);
         getWindowET(2, 1, m_seedID + 1, cellETs[10]);
         // top/bottom phi Layer 2
         getWindowET(2, phiUpDownID, m_seedID,     cellETs[11]);
         getWindowET(2, phiUpDownID, m_seedID - 1, cellETs[12]);
         getWindowET(2, phiUpDownID, m_seedID + 1, cellETs[13]);
         // Layer 3
         getWindowET(3, 1, 0,           cellETs[14]);
         getWindowET(3, phiUpDownID, 0, cellETs[15]);
  
         return;
  
     }

◆ getCoreEMTowerET()

void LVL1::eFEXegAlgo::getCoreEMTowerET ( unsigned int & et )

virtual

Definition at line 66 of file eFEXegAlgo.cxx.

                                                            {
  
         SG::ReadHandle<eTowerContainer> eTowerContainer(m_eTowerContainerKey/*,ctx*/);
  
         const LVL1::eTower * tmpTower = eTowerContainer->findTower(m_eFEXegAlgoTowerID[1][1]);
         et = tmpTower->getLayerTotalET(0) + tmpTower->getLayerTotalET(1) + tmpTower->getLayerTotalET(2) + tmpTower->getLayerTotalET(3);
     }

◆ getCoreHADTowerET()

void LVL1::eFEXegAlgo::getCoreHADTowerET ( unsigned int & et )

virtual

Definition at line 74 of file eFEXegAlgo.cxx.

                                                             {
  
         SG::ReadHandle<eTowerContainer> eTowerContainer(m_eTowerContainerKey/*,ctx*/);
  
         const LVL1::eTower * tmpTower = eTowerContainer->findTower(m_eFEXegAlgoTowerID[1][1]);
         et = tmpTower->getLayerTotalET(4);
     }

◆ geteFEXegTOB()

std::unique_ptr< eFEXegTOB > LVL1::eFEXegAlgo::geteFEXegTOB ( )

virtual

Definition at line 426 of file eFEXegAlgo.cxx.

                                                           {
  
         std::unique_ptr<eFEXegTOB> out = std::make_unique<eFEXegTOB>();
         out->setET(getET());
  
         std::vector<unsigned int> temvector;
         getWstot(temvector);
         // For wstot, num and den seem switched around, but this is because the 'numerator' and 'denominator'
         // mean different things at different points in the processing chain
         // When the threshold comparison is done in the SetIsoWP function, we actually check Den/Num
         out->setWstotNum(temvector[1]);
         out->setWstotDen(temvector[0]);
         getRhad(temvector);
         out->setRhadEM(temvector[0]);
         out->setRhadHad(temvector[1]);
         getReta(temvector);
         out->setRetaCore(temvector[0]);
         out->setRetaEnv(temvector[1]);
         out->setSeedUnD(m_seed_UnD);
         out->setSeed(m_seedID);
         return out;
     }

◆ getET()

unsigned int LVL1::eFEXegAlgo::getET ( )

virtual

Get cells used in cluster

Layer sums including dead material corrections

Final ET sum

Definition at line 304 of file eFEXegAlgo.cxx.

                                        {
  
         std::vector<unsigned int> clusterCells;
         getClusterCells(clusterCells);
  
  
         unsigned int PS_ET = 0;
  
         if(m_algoVersion==0) {
             PS_ET = dmCorrection(clusterCells[0], 0)
                     + dmCorrection(clusterCells[1], 0);
         } else {
             // 2025 algoVersion only uses 1 PS scell, except at most extreme eta values
             PS_ET = dmCorrection(clusterCells[0], 0);
             if ( ((m_efexid%3) == 0 && m_fpgaid == 0) || ((m_efexid%3) == 2 && m_fpgaid == 3)) {
                 PS_ET += dmCorrection(clusterCells[1], 0);
             }
         }
         unsigned int L1_ET = dmCorrection(clusterCells[2], 1)
                              + dmCorrection(clusterCells[3], 1)
                              + dmCorrection(clusterCells[4], 1)
                              + dmCorrection(clusterCells[5], 1)
                              + dmCorrection(clusterCells[6], 1)
                              + dmCorrection(clusterCells[7], 1);
         unsigned int L2_ET = dmCorrection(clusterCells[8], 2)
                              + dmCorrection(clusterCells[9], 2)
                              + dmCorrection(clusterCells[10], 2)
                              + dmCorrection(clusterCells[11], 2)
                              + dmCorrection(clusterCells[12], 2)
                              + dmCorrection(clusterCells[13], 2);
         unsigned int L3_ET = clusterCells[14] + clusterCells[15];
  
         unsigned int totET = PS_ET + L1_ET + L2_ET + L3_ET;
  
         // overflow handling
         if (totET > 0xffff) totET = 0xffff;
  
         return totET;
  
     }

◆ getRealEta()

void LVL1::eFEXegAlgo::getRealEta ( float & eta )

virtual

Definition at line 89 of file eFEXegAlgo.cxx.

                                                {
  
         SG::ReadHandle<eTowerContainer> eTowerContainer(m_eTowerContainerKey/*,ctx*/);
  
         eta = eTowerContainer->findTower(m_eFEXegAlgoTowerID[1][1])->eta() * eTowerContainer->findTower(m_eFEXegAlgoTowerID[1][1])->getPosNeg();
  
     }

◆ getRealPhi()

void LVL1::eFEXegAlgo::getRealPhi ( float & phi )

virtual

Definition at line 82 of file eFEXegAlgo.cxx.

                                                {
  
         SG::ReadHandle<eTowerContainer> eTowerContainer(m_eTowerContainerKey/*,ctx*/);
         phi = eTowerContainer->findTower(m_eFEXegAlgoTowerID[1][1])->phi();
  
     }

◆ getReta()

void LVL1::eFEXegAlgo::getReta ( std::vector< unsigned int > & retavec )

virtual

Definition at line 97 of file eFEXegAlgo.cxx.

                                                               {
  
         unsigned int coresum  = 0;   // 3x2 L2 sum : core
         unsigned int totalsum = 0;   // 7x3 L2 sum : total
         unsigned int envsum   = 0;   // total - core : env
  
         retavec.clear();  // clear the output vector before starting
  
         // window limits
         int iTotalStart = m_seedID-3;
         int iTotalEnd   = m_seedID+3;
         int iCoreStart  = m_seedID-1;
         int iCoreEnd    = m_seedID+1;
         int phiStart    = -999;
         int phiEnd      = -99;
         if (m_seed_UnD) {
             phiStart = 1;
             phiEnd = 2;
         } else {
             phiStart = 0;
             phiEnd = 1;
         }
  
         // 3x2 and 7x3 L2 sum
         for (int i=iTotalStart; i<=iTotalEnd; ++i) { // eta
             for(int j=0; j<=2; ++j) { // phi
                 if (i>=iCoreStart && i <= iCoreEnd && j>=phiStart && j<=phiEnd) {
                     unsigned int tmp_et; getWindowET(2,j,i,tmp_et);
                     coresum += tmp_et;
                 }
  
                 unsigned int tmptot_et; getWindowET(2,j,i,tmptot_et);
                 totalsum += tmptot_et;
             }
         }
  
         // get environment
         envsum = totalsum - coresum;
  
         // Overflow handling
         if (coresum > 0xffff) coresum = 0xffff;
         if (envsum > 0xffff)   envsum = 0xffff;
  
         // Return results
         retavec.push_back(coresum);
         retavec.push_back(envsum);
  
     }

◆ getRhad()

void LVL1::eFEXegAlgo::getRhad ( std::vector< unsigned int > & rhadvec )

virtual

Definition at line 146 of file eFEXegAlgo.cxx.

                                                               {
  
         unsigned int hadsum = 0; // 3x3 Towers Had
         unsigned int emsum = 0;  // (1x3 + 3x3 + 3x3 + 1x3) SCs EM
  
         rhadvec.clear();   // clear the output vector before starting
  
         int iCoreStart  = m_seedID-1;
         int iCoreEnd    = m_seedID+1;
  
         SG::ReadHandle<eTowerContainer> eTowerContainer(m_eTowerContainerKey/*,ctx*/);
  
         if(m_algoVersion==0) {
             // 3x3 Towers Had ; 1x3 L0 + 1x3 L3 EM
             for (int i=0; i<3; ++i) { // phi
                 for (int j=0; j<=2; ++j) { // eta
                     if (((m_efexid%3 == 0) && (m_fpgaid == 0) && (m_central_eta == 0) && (j == 0)) || ((m_efexid%3 == 2) && (m_fpgaid == 3) && (m_central_eta == 5) && (j == 2))) {
                         continue;
                     } else {
                         const eTower * tTower = eTowerContainer->findTower(m_eFEXegAlgoTowerID[i][j]);
                         hadsum += tTower->getLayerTotalET(4);
                         if (j==1) {
                             emsum += ( tTower->getLayerTotalET(0) + tTower->getLayerTotalET(3) );
                         }
                     }
                 }
             }
  
             // 3x3 SCs L1 and L2 sum
             for (int i=iCoreStart; i<=iCoreEnd; ++i) { // eta
                 for(int j=0; j<=2; ++j) { // phi
                     unsigned int tmp_et_a, tmp_et_b;
                     getWindowET(1,j,i,tmp_et_a);
                     getWindowET(2,j,i,tmp_et_b);
                     emsum += ( tmp_et_a + tmp_et_b );
                 }
             }
         } else {
  
             // see slide 4 of https://indico.cern.ch/event/1513502/contributions/6389265/attachments/3019474/5326755/Rate%20Reduction%20Methods%20Overview.pdf
             // Update 29-Apr-2025: removing 4 corners of EM3 from sum
  
             // EM cluster depends on UnD flag
             int phi2 = (m_seed_UnD > 0 ? 2 : 0);
  
             // 3x3 Towers Had + EM3 (excluding corners in EM3); 1x2 L0
             for (int i = 0; i < 3; ++i) { // phi
                 for (int j = 0; j <= 2; ++j) { // eta
                     if (((m_efexid % 3 == 0) && (m_fpgaid == 0) && (m_central_eta == 0) && (j == 0)) ||
                         ((m_efexid % 3 == 2) && (m_fpgaid == 3) && (m_central_eta == 5) && (j == 2))) {
                         continue;
                     } else {
                         const eTower *tTower = eTowerContainer->findTower(m_eFEXegAlgoTowerID[i][j]);
                         hadsum += tTower->getLayerTotalET(4) + (((i==0&&j==0)||(i==2&&j==2)||(i==0&&j==2)||(i==2&&j==0)) ? 0 : tTower->getLayerTotalET(3));
                         // For PS add central tower + UnD phi neighbour
                         if (j == 1 && (i == 1 || i == phi2)) {
                             emsum += (tTower->getLayerTotalET(0));
                         }
                     }
                 }
             }
  
             // 3x2 SCs L1 and L2 sum, so phi range depends on UnD flag
             int phiStart = 0;
             int phiEnd = 1;
             if (m_seed_UnD > 0) {
                 phiStart = 1;
                 phiEnd = 2;
             }
             for (int i = iCoreStart; i <= iCoreEnd; ++i) { // eta
                 for (int j = phiStart; j <= phiEnd; ++j) { // phi
                     unsigned int tmp_et_a, tmp_et_b;
                     getWindowET(1, j, i, tmp_et_a);
                     getWindowET(2, j, i, tmp_et_b);
                     emsum += (tmp_et_a + tmp_et_b);
                 }
             }
         }
         // Overflow handling
         if (emsum > 0xffff)   emsum = 0xffff;
         if (hadsum > 0xffff) hadsum = 0xffff;
  
         // Return results
         rhadvec.push_back(emsum);
         rhadvec.push_back(hadsum);
  
     }

◆ getSeed()

virtual unsigned int LVL1::eFEXegAlgo::getSeed ( ) const

inlinevirtual

Definition at line 58 of file eFEXegAlgo.h.

58 {return m_seedID;};

◆ getSums()

void LVL1::eFEXegAlgo::getSums	(	unsigned int	seed,
		bool	UnD,
		std::vector< unsigned int > &	RetaSums,
		std::vector< unsigned int > &	RhadSums,
		std::vector< unsigned int > &	WstotSums
	)

virtual

Definition at line 494 of file eFEXegAlgo.cxx.

     {
         // Set seed parameters to supplied values
         m_seed_UnD = UnD;
         m_seedID = seed;
         m_hasSeed = true;
  
         // Now just call the 3 discriminant calculation methods
         getReta(RetaSums);
         getRhad(RhadSums);
         getWstot(WstotSums);
  
     }

◆ getUnD()

virtual unsigned int LVL1::eFEXegAlgo::getUnD ( ) const

inlinevirtual

Definition at line 59 of file eFEXegAlgo.h.

59 {return m_seed_UnD;};

◆ getWindowET()

void LVL1::eFEXegAlgo::getWindowET	(	int	layer,
		int	jPhi,
		int	SCID,
		unsigned int &	outET
	)

virtual

Definition at line 449 of file eFEXegAlgo.cxx.

                                                                                         {
  
         SG::ReadHandle<eTowerContainer> eTowerContainer(m_eTowerContainerKey/*,ctx*/);
  
         if (SCID<0) { // left towers in eta
             if ((m_efexid%3 == 0) && (m_fpgaid == 0) && (m_central_eta == 0)) {
                 outET = 0;
             } else {
                 int etaID = 4+SCID;
                 const eTower * tmpTower = eTowerContainer->findTower(m_eFEXegAlgoTowerID[jPhi][0]);
                 if (layer==1 || layer==2) {
                     outET = tmpTower->getET(layer,etaID);
                 } else if (layer==0 || layer==3 || layer==4) {
                     outET = tmpTower->getLayerTotalET(layer);
                 }
             }
         } else if (SCID>=0 && SCID<4) { // central towers in eta
             const eTower * tmpTower = eTowerContainer->findTower(m_eFEXegAlgoTowerID[jPhi][1]);
             if (layer==1 || layer==2) {
                 outET = tmpTower->getET(layer,SCID);
             } else if (layer==0 || layer==3 || layer==4) {
                 outET = tmpTower->getLayerTotalET(layer);
             }
         } else if (SCID>=4){ // right towers in eta
             if ((m_efexid%3 == 2) && (m_fpgaid == 3) && (m_central_eta == 5)) {
                 outET = 0;
             } else {
                 int etaID = SCID-4;
                 const eTower * tmpTower = eTowerContainer->findTower(m_eFEXegAlgoTowerID[jPhi][2]);
                 if (layer==1 || layer==2) {
                     outET = tmpTower->getET(layer,etaID);
                 } else if (layer==0 || layer==3 || layer==4) {
                     outET = tmpTower->getLayerTotalET(layer);
                 }
             }
         }
  
         // overflow handling
         if (outET > 0xffff) outET = 0xffff;
  
     }

◆ getWstot()

void LVL1::eFEXegAlgo::getWstot ( std::vector< unsigned int > & output )

virtual

Definition at line 234 of file eFEXegAlgo.cxx.

                                                                  {
         unsigned int numer = 0;
         unsigned int den = 0;
  
         output.clear(); // clear the output vector before starting
  
         int iStart = m_seedID - 2;
         int iEnd = m_seedID + 2;
  
         for (int i = iStart; i <= iEnd; ++i) { // eta
             int diff = i - m_seedID;
             unsigned int weight = diff*diff;
             for (int j = 0; j <= 2; ++j) { // phi
                 unsigned int eT;
                 getWindowET(1, j, i, eT);
                 // NB need to be careful as numer and den are defined such that wstot=numer/den,
                 // but in the firmware (and therefore this bitwise code) we actually
                 // check that den/numer < Threshold
                 numer += eT*weight;
                 den += eT;
             }
         }
  
         // Overflow handling
         //if (den > 0xffff)     den = 0xffff; - commented out so that denom can overflow, will then automatically pass all thresholds (see eFEXFPGA::SetIsoWP)
         if (numer > 0xffff) numer = 0xffff;
  
         // Return results
         output.push_back(den);
         output.push_back(numer);
  
     }

◆ hasSeed()

virtual bool LVL1::eFEXegAlgo::hasSeed ( ) const

inlinevirtual

Definition at line 57 of file eFEXegAlgo.h.

57 {return m_hasSeed;};

◆ initialize()

StatusCode LVL1::eFEXegAlgo::initialize ( )

virtual

standard Athena-Algorithm method

Definition at line 34 of file eFEXegAlgo.cxx.

                                      {
  
         ATH_CHECK(m_eTowerContainerKey.initialize());
         ATH_CHECK( m_dmCorrectionsKey.initialize(SG::AllowEmpty) );
  
         return StatusCode::SUCCESS;
     }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

static const InterfaceID& LVL1::eFEXegAlgo::interfaceID ( )

inlinestatic

Definition at line 37 of file eFEXegAlgo.h.

37 { return IID_IeFEXegAlgo; };

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ safetyTest()

StatusCode LVL1::eFEXegAlgo::safetyTest ( ) const

virtual

Definition at line 43 of file eFEXegAlgo.cxx.

                                             {
  
         SG::ReadHandle<eTowerContainer> eTowerContainer(m_eTowerContainerKey/*,ctx*/);
         if(!eTowerContainer.isValid()){
             ATH_MSG_FATAL("Could not retrieve container " << m_eTowerContainerKey.key() );
             return StatusCode::FAILURE;
         }
  
         return StatusCode::SUCCESS;
     }

◆ setSeed()

void LVL1::eFEXegAlgo::setSeed ( )

private

Definition at line 513 of file eFEXegAlgo.cxx.

                              {
  
         m_hasSeed = false;
         m_seed_UnD = false;
         unsigned int tmpID = 999;
         unsigned int maxET = 0;
  
         for (int i=0; i<4 ; ++i) {
             int iSeedL = i-1;
             int iSeedR = i+1;
  
             // eta ID of candidate seed
             unsigned int cETUp;
             getWindowET(2,2,i,cETUp);
             unsigned int iSeedET;
             getWindowET(2,1,i, iSeedET);
             unsigned int cETDown;
             getWindowET(2,0,i, cETDown);
  
             // left of candidate seed
             unsigned int lETUp;
             getWindowET(2,2,iSeedL,lETUp);
             unsigned int lET;
             getWindowET(2,1,iSeedL,lET);
             unsigned int lETDown;
             getWindowET(2,0,iSeedL,lETDown);
  
             // right of candidate seed
             unsigned int rETUp;
             getWindowET(2,2,iSeedR,rETUp);
             unsigned int rET;
             getWindowET(2,1,iSeedR,rET);
             unsigned int rETDown;
             getWindowET(2,0,iSeedR,rETDown);
  
             // greater or equal than for left and down cells, greater than for right and up ones
             if (iSeedET>=lET && iSeedET>rET
                 && iSeedET>=lETUp    && iSeedET>cETUp    && iSeedET>rETUp
                 && iSeedET>=lETDown && iSeedET>=cETDown && iSeedET>rETDown) {
                 if (iSeedET>=maxET) { // if two maxima exist and have the same ET, keep the one to the right
                     maxET = iSeedET;
                     tmpID = i;
                 }
             }
         }
  
         if(tmpID!=999) {
             m_seedID = tmpID;
             m_hasSeed = true;
             unsigned int tmp_et_up, tmp_et_down;
             getWindowET(2,2,m_seedID,tmp_et_up);
             getWindowET(2,0,m_seedID,tmp_et_down);
             if (tmp_et_up >= tmp_et_down) {
                 m_seed_UnD = true; // go up if energy greater or equal to bottom
             }
         }
     }

◆ setup()

void LVL1::eFEXegAlgo::setup	(	int	inputTable[3][3],
		int	efex_id,
		int	fpga_id,
		int	central_eta
	)

virtual

Definition at line 54 of file eFEXegAlgo.cxx.

                                                                                           {
  
         std::copy(&inputTable[0][0], &inputTable[0][0] + 9, &m_eFEXegAlgoTowerID[0][0]);
  
         m_efexid = efex_id;
         m_fpgaid = fpga_id;
         m_central_eta = central_eta;
  
         setSeed();
  
     }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

Corrections m_corrections LVL1::eFEXegAlgo::ATLAS_THREAD_SAFE

mutableprivate

Definition at line 90 of file eFEXegAlgo.h.

◆ m_algoVersion

Gaudi::Property<int> LVL1::eFEXegAlgo::m_algoVersion {this, "algoVersion", 0, "AlgoVersion, part of the L1Menu spec"}

private

Definition at line 94 of file eFEXegAlgo.h.

◆ m_central_eta

int LVL1::eFEXegAlgo::m_central_eta {}

private

Definition at line 73 of file eFEXegAlgo.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_dmCorr

Gaudi::Property<bool> LVL1::eFEXegAlgo::m_dmCorr {this, "dmCorr", false, "Enable dead material correctionst"}

private

Definition at line 93 of file eFEXegAlgo.h.

◆ m_dmCorrectionsKey

SG::ReadCondHandleKey<CondAttrListCollection> LVL1::eFEXegAlgo::m_dmCorrectionsKey

private

Initial value:

{this,"DMCorrectionsKey","",

"Key to dead material corrections (AttrListCollection)"}

Definition at line 100 of file eFEXegAlgo.h.

◆ m_eFEXegAlgoTowerID

int LVL1::eFEXegAlgo::m_eFEXegAlgoTowerID[3][3] {}

private

Definition at line 70 of file eFEXegAlgo.h.

◆ m_efexid

int LVL1::eFEXegAlgo::m_efexid {}

private

Definition at line 71 of file eFEXegAlgo.h.

◆ m_eTowerContainerKey

SG::ReadHandleKey<LVL1::eTowerContainer> LVL1::eFEXegAlgo::m_eTowerContainerKey {this, "MyETowers", "eTowerContainer", "Input container for eTowers"}

private

Definition at line 97 of file eFEXegAlgo.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_fpgaid

int LVL1::eFEXegAlgo::m_fpgaid {}

private

Definition at line 72 of file eFEXegAlgo.h.

◆ m_hasSeed

bool LVL1::eFEXegAlgo::m_hasSeed {}

private

Definition at line 74 of file eFEXegAlgo.h.

◆ m_seed_UnD

bool LVL1::eFEXegAlgo::m_seed_UnD = false

private

Definition at line 68 of file eFEXegAlgo.h.

◆ m_seedID

unsigned int LVL1::eFEXegAlgo::m_seedID = 999

private

Definition at line 69 of file eFEXegAlgo.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ eFEXegAlgo()

◆ ~eFEXegAlgo()

Member Function Documentation

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ detStore()

◆ dmCorrection()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getClusterCells()

◆ getCoreEMTowerET()

◆ getCoreHADTowerET()

◆ geteFEXegTOB()

◆ getET()

◆ getRealEta()

◆ getRealPhi()

◆ getReta()

◆ getRhad()

◆ getSeed()

◆ getSums()

◆ getUnD()

◆ getWindowET()

◆ getWstot()

◆ hasSeed()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ safetyTest()

◆ setSeed()

◆ setup()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_algoVersion

◆ m_central_eta

◆ m_detStore

◆ m_dmCorr

◆ m_dmCorrectionsKey

◆ m_eFEXegAlgoTowerID

◆ m_efexid

◆ m_eTowerContainerKey

◆ m_evtStore

◆ m_fpgaid

◆ m_hasSeed

◆ m_seed_UnD

◆ m_seedID

◆ m_varHandleArraysDeclared

◆ m_vhka