egammaCellRecoveryTool Class Reference

tool to recover cells lost because of the topocluster timing cut More...

#include <egammaCellRecoveryTool.h>

Inheritance diagram for egammaCellRecoveryTool:

Collaboration diagram for egammaCellRecoveryTool:

Classes
struct	existingCells

Public Member Functions
	egammaCellRecoveryTool (const std::string &type, const std::string &name, const IInterface *parent)
	Default constructor.
	~egammaCellRecoveryTool ()=default
	Destructor.
StatusCode	initialize () override
	initialize method
StatusCode	finalize () override
	finalize method
virtual StatusCode	execute (const xAOD::CaloCluster &cluster, Info &info) const override final
	Method to just calculate hadronic leakage.
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

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	AlgTool interface methods.

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
existingCells	buildCellArrays (const xAOD::CaloCluster *clus, double etamax, double phimax) const
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
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

Static Private Attributes
static constexpr double	m_timeCut = 12.
static constexpr double	m_phiSize = 2*M_PI/256
static const int	m_nL2 = 5*7
static const int	m_nL3 = 10

Detailed Description

tool to recover cells lost because of the topocluster timing cut

Definition at line 15 of file egammaCellRecoveryTool.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

egammaCellRecoveryTool()

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

Default constructor.

Definition at line 9 of file egammaCellRecoveryTool.cxx.

  : AthAlgTool(type, name, parent){
  // declare Interface
  declareInterface<IegammaCellRecoveryTool>(this);
}

~egammaCellRecoveryTool()

egammaCellRecoveryTool::~egammaCellRecoveryTool ( )

default

Destructor.

Member Function Documentation

buildCellArrays()

egammaCellRecoveryTool::existingCells egammaCellRecoveryTool::buildCellArrays ( const xAOD::CaloCluster * clus, double etamax, double phimax ) const

private

Definition at line 112 of file egammaCellRecoveryTool.cxx.

                                                                       {
 
  egammaCellRecoveryTool::existingCells result{};
  // Just to be sure. But should not be needed
  for (int i = 0; i < m_nL2; i++)
    { result.existL2[i] = 0; }
  for (int i = 0; i < m_nL3; i++)
    { result.existL3[i] = 0; }
  
  const CaloClusterCellLink* cellLinks = cluster->getCellLinks();
  if (!cellLinks) {
    ATH_MSG_WARNING("No cell link for cluster. Do nothing");
    return result;
  }
  
  CaloClusterCellLink::const_iterator it_cell = cellLinks->begin(),
    it_cell_e = cellLinks->end();
  
  for (; it_cell != it_cell_e; ++it_cell) {
    const CaloCell* cell = (*it_cell);
    if (cell) {
      if (!cell->caloDDE()) {
    ATH_MSG_WARNING("Calo cell without detector element ?? eta = "
            << cell->eta() << " phi = " << cell->phi());
    continue;
      }
      int layer = cell->caloDDE()->getSampling();
      if (layer != CaloSampling::EMB2 && layer != CaloSampling::EME2 &&
      layer != CaloSampling::EMB3 && layer != CaloSampling::EME3)
    continue;
      
       double deta = cell->caloDDE()->eta_raw() - etamax;
       double dphi = cell->caloDDE()->phi_raw() - phimax;
       if (dphi < -M_PI) dphi += 2*M_PI;
       if (dphi > M_PI)  dphi -= 2*M_PI;
       if ((layer == CaloSampling::EMB2 || layer == CaloSampling::EME2) && 
       std::abs(deta) < 0.07 && std::abs(dphi) < 0.085) {
     int ieta = (int)((deta+0.052)/0.025);
     int iphi = (int)((dphi+0.075)/m_phiSize);
     if (ieta < 0 || ieta > 4 || iphi < 0 || iphi > 6) {
       ATH_MSG_WARNING("Should never happen ieta = " << ieta
               << " iphi = " << iphi);
     } else {
       int index = 7*ieta+iphi;
       result.existL2[index] = true;
     }
       } else if ((layer == CaloSampling::EMB3 || layer == CaloSampling::EME3) &&
          std::abs(deta) < 0.05 && std::abs(dphi) < 0.06) {
     int ieta = (int)(std::abs(deta)/0.025);
     int iphi = (int)((dphi+0.05)/m_phiSize);
     if (ieta > 1 || iphi < 0 || iphi > 4) {
       ATH_MSG_WARNING("Should never happen ieta = " << ieta
               << " iphi = " << iphi);
     } else {
       int index = 5*ieta+iphi;
       result.existL3[index] = true; 
     }
       } // L2 or L3, in window vs max
    }   // cell exists
  }     // loop over cells
  
  return result;
}

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.

{ return m_detStore; }

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.

{ return m_evtStore; }

execute()

StatusCode egammaCellRecoveryTool::execute ( const xAOD::CaloCluster & cluster, Info & info ) const

finaloverridevirtual

Method to just calculate hadronic leakage.

Implements IegammaCellRecoveryTool.

Definition at line 22 of file egammaCellRecoveryTool.cxx.

                                         {
 
  double etamax = info.etamax;
  double phimax = info.phimax;
  ATH_MSG_DEBUG("etamax = " << etamax << " phimax = " << phimax);
  info.addedCells.reserve(10);
 
  // Build rectangular cluster arount it (and also in L3)
  egammaCellRecoveryTool::existingCells arrayCells =
    buildCellArrays(&cluster,etamax,phimax);
 
  //Now compare with the cells stored in the CaloCell container
  // and compute the energy from missed cells
 
  // define required size = 3x7 in barrel and 5x7 in endcap for layer 2
  int iphi1 = 0, iphi2 = 6;
  int ieta1 = 0, ieta2 = 4;
  if (std::abs(etamax) < 1.475) { 
    ieta1 = 1;
    ieta2 = 3;
  }
 
  const CaloCellContainer *caloCells = cluster.getCellLinks()->getCellContainer();
  for (const auto * cell : *caloCells) {
    if (!cell->caloDDE()) {
      ATH_MSG_WARNING("Calo cell without detector element ?? eta = "
              << cell->eta() << " phi = " << cell->phi());
      continue;
    }
    
    double deta = cell->caloDDE()->eta_raw()-etamax;
    double dphi = cell->caloDDE()->phi_raw()-phimax;
    if (dphi < -M_PI) dphi += 2*M_PI;
    if (dphi > M_PI)  dphi -= 2*M_PI;
    
    if (std::abs(deta) > 0.1 || std::abs(dphi) > 0.1) continue;
    
    int layer = cell->caloDDE()->getSampling();
    if (layer != CaloSampling::EMB2 && layer != CaloSampling::EME2 &&
    layer != CaloSampling::EMB3 && layer != CaloSampling::EME3)
      continue;
    
    if ((layer == CaloSampling::EMB2 || layer == CaloSampling::EME2) &&
    std::abs(deta) < 0.07 && std::abs(dphi) < 0.085) {
      int ieta = (int)((deta+0.052)/0.025);
      int iphi = (int)((dphi+0.075)/m_phiSize);
      if (ieta >= ieta1 && ieta <= ieta2 && iphi >= iphi1 && iphi <= iphi2) {
    int index = 7*ieta+iphi;
    if (!arrayCells.existL2[index]) {
      if (std::abs(cell->time()) > m_timeCut) {
        info.nCells[0]++;
        info.eCells[0] += cell->energy();
        info.addedCells.push_back(cell);
      } // would have been rejected by time cut
    }   // cell not in cluster
      }     // eta-phi window cut
    } else if ((layer == CaloSampling::EMB3 || layer == CaloSampling::EME3) &&
           std::abs(deta) < 0.05 && std::abs(dphi) < 0.06) {
      int ieta = (int)(std::abs(deta)/0.025);
      int iphi = (int)((dphi+0.05)/m_phiSize);
      if (ieta <= 1 && iphi >= 0 && iphi <= 4) {
    int index = 5*ieta+iphi;
    if (!arrayCells.existL3[index]) {
      if (std::abs(cell->time()) > m_timeCut) {
        info.nCells[1]++;
        info.eCells[1] += cell->energy();
        info.addedCells.push_back(cell);
      }
    }
      }
    } 
  }  // loop over cell container
 
  if (msgLvl(MSG::DEBUG)) {
 
    ATH_MSG_DEBUG("Added cells in L2, n = " << info.nCells[0] << " E = " << info.eCells[0]
          << " and in L3, n = " << info.nCells[1] << " E = " << info.eCells[1]
          << " n(L2+L3) = " << info.addedCells.size());
 
    for (const auto *c : info.addedCells) {
      ATH_MSG_DEBUG("cell layer " << c->caloDDE()->getSampling() << " E = " << c->energy()
            << " eta = " << c->caloDDE()->eta_raw()
            << " phi = " << c->caloDDE()->phi_raw());
    }
  }
 
  return StatusCode::SUCCESS;
}

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

finalize()

StatusCode egammaCellRecoveryTool::finalize ( )

inlineoverride

finalize method

Definition at line 30 of file egammaCellRecoveryTool.h.

{ return StatusCode::SUCCESS; }

initialize()

StatusCode egammaCellRecoveryTool::initialize ( )

override

initialize method

Definition at line 17 of file egammaCellRecoveryTool.cxx.

                                             {
  ATH_MSG_DEBUG("Initializing egammaCellRecoveryTool");
  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()

const InterfaceID & IegammaCellRecoveryTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 48 of file IegammaCellRecoveryTool.h.

{
  return IID_IegammaCellRecoveryTool;
}

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

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_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_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_nL2

const int egammaCellRecoveryTool::m_nL2 = 5*7

staticprivate

Definition at line 44 of file egammaCellRecoveryTool.h.

m_nL3

const int egammaCellRecoveryTool::m_nL3 = 10

staticprivate

Definition at line 45 of file egammaCellRecoveryTool.h.

m_phiSize

double egammaCellRecoveryTool::m_phiSize = 2*M_PI/256

staticconstexprprivate

Definition at line 41 of file egammaCellRecoveryTool.h.

m_timeCut

double egammaCellRecoveryTool::m_timeCut = 12.

staticconstexprprivate

Definition at line 38 of file egammaCellRecoveryTool.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:

• egammaCellRecoveryTool.h
• egammaCellRecoveryTool.cxx