#include <EFexEMEnergyWeightedClusterTool.h>

Inheritance diagram for LVL1::EFexEMEnergyWeightedClusterTool:

Collaboration diagram for LVL1::EFexEMEnergyWeightedClusterTool:

Public Member Functions
	EFexEMEnergyWeightedClusterTool (const std::string &type, const std::string &name, const IInterface *parent)
	Name : EFexEMEnergyWeightedClusterTool.cxx PACKAGE : Trigger/TrigT1/TrigT1CaloFexPerf AUTHOR : Denis Oliveira Damazio PURPOSE : emulate the eFex EM algorithm for phase 1 L1Calo (energy weighted clustering)
void	findCellsAbove_EMB2_EMEC2 (const CaloConstCellContainer , const float &thr, std::vector< const CaloCell > &out) const
void	findCellsAround (const CaloConstCellContainer , const CaloCell cell, std::vector< const CaloCell * > &out, const float deta, const float dphi) const
void	findCellsAround (const CaloConstCellContainer , const float eta, const float phi, std::vector< const CaloCell > &out, const float deta, const float dphi) const
void	findTTsAround (const xAOD::TriggerTowerContainer , const float eta, const float phi, std::vector< const xAOD::TriggerTower > &out) const
	finds TTs around a seed cell.
bool	isCellEmMaximum (const std::vector< const CaloCell * > &scells, const CaloCell *cell) const
	checks if a give (seed) cell is the highest in a vector of cells.
float	sumEmCells (const std::vector< const CaloCell * > &scells) const
	sum all cells from the vector that are in the EM calorimeter part
float	sumEmCells2nd (const std::vector< const CaloCell * > &scells) const
	sum all cells from the vector that are in the EM calorimeter part (only 2nd layer)
float	sumHadCells (const std::vector< const CaloCell * > &scells) const
	sum all cells from the vector that are in the HAD calorimeter part
float	sumHadTTs (const std::vector< const xAOD::TriggerTower * > &scells) const
	sum all TTs from the vector that are in the HAD calorimeter part, but only for \|eta\|<1.72 (tile region)
void	findCluster (const std::vector< const CaloCell * > &scells, float &etaCluster, float &phiCluster) const
	detect central cluster position
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	findCellsAbove (const CaloConstCellContainer , const float &thr, std::vector< const CaloCell > &out) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
const float	m_detaTT {0.125}
	member variables
const float	m_dphiTT {0.15}
	dphi for the cluster to TT definition
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 23 of file EFexEMEnergyWeightedClusterTool.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

◆ EFexEMEnergyWeightedClusterTool()

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

Name : EFexEMEnergyWeightedClusterTool.cxx PACKAGE : Trigger/TrigT1/TrigT1CaloFexPerf AUTHOR : Denis Oliveira Damazio PURPOSE : emulate the eFex EM algorithm for phase 1 L1Calo (energy weighted clustering)

Definition at line 12 of file EFexEMEnergyWeightedClusterTool.cxx.

13 : AthAlgTool(type, name, parent)

14{}

AthAlgTool::AthAlgTool

AthAlgTool()

Default constructor:

Member Function Documentation

◆ declareGaudiProperty()

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());
 
  }

◆ declareProperty()

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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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; }

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ 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

◆ findCellsAbove()

void LVL1::EFexEMEnergyWeightedClusterTool::findCellsAbove	(	const CaloConstCellContainer *	scells,
		const float &	thr,
		std::vector< const CaloCell * > &	out ) const

private

Definition at line 18 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   out.clear();
   for(auto scell : *scells) {
      if ( scell->et() < Thr )  continue;
      out.push_back(scell);
   }
}

◆ findCellsAbove_EMB2_EMEC2()

void LVL1::EFexEMEnergyWeightedClusterTool::findCellsAbove_EMB2_EMEC2	(	const CaloConstCellContainer *	scells,
		const float &	thr,
		std::vector< const CaloCell * > &	out ) const

Definition at line 29 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   out.clear();
   for(auto scell : *scells) {
      if ( scell->et() < Thr )  continue;
      if ( scell->caloDDE()->getSampling()==2 || scell->caloDDE()->getSampling()==6 ) {
         out.push_back(scell);
      }
   }
}

◆ findCellsAround() [1/2]

void LVL1::EFexEMEnergyWeightedClusterTool::findCellsAround	(	const CaloConstCellContainer *	scells,
		const CaloCell *	cell,
		std::vector< const CaloCell * > &	out,
		const float	deta,
		const float	dphi ) const

Definition at line 42 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   out.clear();
   if ( !cell ) return;
   float etacell = cell->eta();
   float phicell = cell->phi();
   for(auto scell : *scells) {
      if ( std::abs( scell->eta() - etacell) > detaSize ) continue;
      float dphi = std::abs( scell->phi() - phicell);
      dphi = std::abs( M_PI - dphi );
      dphi = std::abs( M_PI - dphi );
      if ( std::abs( dphi ) > dphiSize ) continue;
      out.push_back(scell);
   }
}

◆ findCellsAround() [2/2]

void LVL1::EFexEMEnergyWeightedClusterTool::findCellsAround	(	const CaloConstCellContainer *	scells,
		const float	eta,
		const float	phi,
		std::vector< const CaloCell * > &	out,
		const float	deta,
		const float	dphi ) const

Definition at line 61 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   out.clear();
   for(auto scell : *scells) {
      if ( std::abs( scell->eta() - etacell) > detaSize ) continue;
      float dphi = std::abs( scell->phi() - phicell);
      dphi = std::abs( M_PI - dphi );
      dphi = std::abs( M_PI - dphi );
      if ( std::abs( dphi ) > dphiSize ) continue;
      out.push_back(scell);
   }
}

◆ findCluster()

void LVL1::EFexEMEnergyWeightedClusterTool::findCluster	(	const std::vector< const CaloCell * > &	scells,
		float &	etaCluster,
		float &	phiCluster ) const

detect central cluster position

Definition at line 161 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   etaCluster=0.0;
   phiCluster=0.0;
   double etaClusterD=0.0;
   double phiClusterD=0.0;
   double energyCluster=0.0;
   bool cross_phi_bound=false;
   int last_sign=0;
   for(auto scell : scells){
      if ( std::abs( scell->phi() ) < 2.7 ) continue;
      int layer = scell->caloDDE()->getSampling();
      if ( ( layer != 2 ) && ( layer != 6 ) ) continue;
      int cell_sign = ( scell->phi() >=0 ? 1 : -1 );
      if ( ( last_sign!=0 ) && ( last_sign != cell_sign ) ) cross_phi_bound = true;
      last_sign = cell_sign;
   }
   for(auto scell : scells){
      int layer = scell->caloDDE()->getSampling();
      if ( ( layer != 2 ) && ( layer != 6 ) ) continue;
      double scelleta = scell->eta();
      double scellphi = scell->phi();
      double scellet = scell->et();
      etaClusterD+= (scellet * scelleta);
      if (cross_phi_bound && scellphi < 0 ) scellphi += 2 * M_PI;
      phiClusterD+= (scellet * scellphi);
      energyCluster+= (scellet) ;
   }
   if ( energyCluster > 0.1 ) {
      etaClusterD/=energyCluster;
      phiClusterD/=energyCluster;
      etaCluster = (float)etaClusterD;
      phiCluster = (float)phiClusterD;
      if ( phiCluster > M_PI ) phiCluster-=2*M_PI;
   } else {
      etaCluster=-999.0;
      phiCluster=-999.0;
   }
}

◆ findTTsAround()

void LVL1::EFexEMEnergyWeightedClusterTool::findTTsAround	(	const xAOD::TriggerTowerContainer *	scells,
		const float	eta,
		const float	phi,
		std::vector< const xAOD::TriggerTower * > &	out ) const

finds TTs around a seed cell.

These TTs will be part of the cluster. This helps to cover the part related to TileCall

Definition at line 77 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   out.clear();
   for(auto scell : *scells) {
      if ( std::abs( scell->eta() - etacell) > m_detaTT ) continue;
      float dphi = std::abs( scell->phi() - phicell);
      dphi = std::abs( M_PI - dphi );
      dphi = std::abs( M_PI - dphi );
      if ( std::abs( dphi ) > m_dphiTT ) continue;
      out.push_back(scell);
   }
}

◆ 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.

◆ isCellEmMaximum()

bool LVL1::EFexEMEnergyWeightedClusterTool::isCellEmMaximum	(	const std::vector< const CaloCell * > &	scells,
		const CaloCell *	cell ) const

checks if a give (seed) cell is the highest in a vector of cells.

This is to make sure we have a real local EM maximum

Definition at line 93 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   if ( !cell ) return false;
   int samp = cell->caloDDE()->getSampling();
   if ( (samp >= 8) && (samp!=21) ) return false; // include FCAL0 EM
   float cellpt = 1.0001*cell->et(); //make sure you don't get thecell itself
   for(auto scell : scells){ 
      int samp1 = scell->caloDDE()->getSampling();
      if ( ( samp1 >= 8 ) && (samp1!=21) ) continue;
      if ( scell->ID() == cell->ID()  ) continue;
      if ( scell->et() > cellpt ) return false;
   }
   return true;
}

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ 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();
  }

◆ sumEmCells()

float LVL1::EFexEMEnergyWeightedClusterTool::sumEmCells ( const std::vector< const CaloCell * > & scells ) const

sum all cells from the vector that are in the EM calorimeter part

Definition at line 110 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   float totalSum = 0.0;
   for(auto scell : scells) {
      int samp1 = scell->caloDDE()->getSampling();
      if ( (samp1<8) || (samp1==21) ) totalSum+= scell->energy();
   }
   return totalSum;
}

◆ sumEmCells2nd()

float LVL1::EFexEMEnergyWeightedClusterTool::sumEmCells2nd ( const std::vector< const CaloCell * > & scells ) const

sum all cells from the vector that are in the EM calorimeter part (only 2nd layer)

Definition at line 122 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   float totalSum = 0.0;
   for(auto scell : scells) {
      if ( (scell->caloDDE()->getSampling()==2) ||(scell->caloDDE()->getSampling()==6) ) {
         totalSum+= scell->energy();
      }
   }
   return totalSum;
}

◆ sumHadCells()

float LVL1::EFexEMEnergyWeightedClusterTool::sumHadCells ( const std::vector< const CaloCell * > & scells ) const

sum all cells from the vector that are in the HAD calorimeter part

Definition at line 135 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   float totalSum = 0.0;
   for(auto scell : scells){
      if ( (scell->caloDDE()->getSampling() <8) || ( scell->caloDDE()->getSampling()>=22) ) continue;
      //totalSum+= (scell->et())*TMath::CosH(scell->eta());
      totalSum+= (scell->energy());
   }
   return totalSum;
}

◆ sumHadTTs()

float LVL1::EFexEMEnergyWeightedClusterTool::sumHadTTs ( const std::vector< const xAOD::TriggerTower * > & scells ) const

sum all TTs from the vector that are in the HAD calorimeter part, but only for |eta|<1.72 (tile region)

Definition at line 148 of file EFexEMEnergyWeightedClusterTool.cxx.

{
   float totalSum = 0.0;
   for(auto scell : scells){
      if ( std::abs( scell->eta() ) > 1.5 ) continue;
      if ( scell->sampling() == 0 ) continue;
      totalSum+= (scell->pt())*TMath::CosH(scell->eta());
   }
   return totalSum * 1e3; // express in MeV
}

◆ 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 asg::AsgMetadataTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and DerivationFramework::CfAthAlgTool.

◆ 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

◆ m_detaTT

const float LVL1::EFexEMEnergyWeightedClusterTool::m_detaTT {0.125}

private

member variables

deta for the cluster to TT definition

Definition at line 67 of file EFexEMEnergyWeightedClusterTool.h.

67{0.125};

◆ 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_dphiTT

const float LVL1::EFexEMEnergyWeightedClusterTool::m_dphiTT {0.15}

private

dphi for the cluster to TT definition

Definition at line 68 of file EFexEMEnergyWeightedClusterTool.h.

68{0.15};

◆ 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_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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ EFexEMEnergyWeightedClusterTool()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ extraDeps_update_handler()

◆ findCellsAbove()

◆ findCellsAbove_EMB2_EMEC2()

◆ findCellsAround() [1/2]

◆ findCellsAround() [2/2]

◆ findCluster()

◆ findTTsAround()

◆ inputHandles()

◆ isCellEmMaximum()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sumEmCells()

◆ sumEmCells2nd()

◆ sumHadCells()

◆ sumHadTTs()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detaTT

◆ m_detStore

◆ m_dphiTT

◆ m_evtStore

◆ m_varHandleArraysDeclared

◆ m_vhka