Cluster correction tool to compute the logarithmically weighted centroid. More...

#include <CaloClusterLogPos.h>

Inheritance diagram for CaloClusterLogPos:

Collaboration diagram for CaloClusterLogPos:

Public Member Functions
StatusCode	initialize () override
StatusCode	execute (const EventContext &ctx, xAOD::CaloCluster *theCluster) const override
	Execute on a single cluster.
	CaloClusterLogPos (const std::string &type, const std::string &name, const IInterface *parent)
	Standard AlgTool constructor.
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *collection) const
	Execute on an entire collection of clusters.
virtual StatusCode	execute (xAOD::CaloClusterContainer *collection) final
	Execute on an entire collection of clusters.
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
	DeclareInterfaceID (CaloClusterCollectionProcessor, 1, 0)

Static Public Member Functions
static const InterfaceID &	interfaceID ()
	Standard Gaudi interface ID method.

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
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

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

Cluster correction tool to compute the logarithmically weighted centroid.

The eta and phi position of a cluster are re-calculated with logarithmic weights instead of the default linear weights in cell energy. This gives cells in the shower tails larger weights and thus avoids the bias towards the center of the largest cell. This tool needs to be called after all energy correction tools since any update of the cell weights re-calculates eta and phi. The weighting is done according to:

\[ \eta = 1/{\rm norm} \times \sum\limits{{\rm cell}, w_{\rm cell} > 0} w_{\rm cell} \eta_{\rm cell} \]

with

\[ w_{\rm * cell} = w_0 + \log(|E_{\rm cell}|/|E_{\rm cluster}|) \]

,

\[ {\rm * norm} = \sum\limits{{\rm cell}, w_{\rm cell} > 0} w_{\rm cell} \]

,

where \(w_0\) is an offset to cut off cells with too small energy. The absolute values of the cell and cluster energies * are used in order to keep a valid position for clusters with * negative energy.

See also B.Brabson et al. Nucl. Inst. and Methods, A332 (419-443) 1993. eqn 14.

Definition at line 50 of file CaloClusterLogPos.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

◆ CaloClusterLogPos()

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

Standard AlgTool constructor.

Definition at line 14 of file CaloClusterLogPos.cxx.

  :CaloClusterProcessor(type, name, parent),
   m_offset(4.7)
{
  declareProperty ("LogPosOffset",m_offset) ;
}

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

◆ DeclareInterfaceID()

CaloClusterCollectionProcessor::DeclareInterfaceID	(	CaloClusterCollectionProcessor	,
		1	,
		0	)

inherited

◆ 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

◆ execute() [1/3]

StatusCode CaloClusterLogPos::execute	(	const EventContext &	ctx,
		xAOD::CaloCluster *	cluster ) const

overridevirtual

Execute on a single cluster.

Parameters

cluster	The cluster to process.
ctx	The event context.

Implements CaloClusterProcessor.

Definition at line 31 of file CaloClusterLogPos.cxx.

{
  
  if ( msgSvc()->outputLevel(name()) <= MSG::DEBUG ) {
 
    msg(MSG::DEBUG) << " old cluster eta = " << theCluster->eta() 
            << " phi = " << theCluster->phi() << endmsg;
 
    // std::vector<double> theEtas;
    // std::vector<double> thePhis;
    // theCluster->getEtaInSamples(theEtas);
    // theCluster->getPhiInSamples(thePhis);
    // for(int i=0;i<CaloCell_ID::Unknown;i++) {
    //   report << MSG::DEBUG << " old sampling " << i << " eta = " << theEtas[i]
    //       << " phi = " << thePhis[i] << endmsg;
    //}
  }
 
  const double absEClus = fabs(theCluster->e());
 
  if ( absEClus > 0 ) {
    const double inv_absEClus = 1. / absEClus;
    std::vector<double> weightSample(CaloCell_ID::Unknown,0);
    std::vector<double> etaSample(CaloCell_ID::Unknown,0);
    std::vector<double> phiSample(CaloCell_ID::Unknown,0);
    
    double weightAll(0),etaAll(0),phiAll(0);
    
    xAOD::CaloCluster::cell_iterator itrCell    = theCluster->cell_begin();
    xAOD::CaloCluster::cell_iterator itrCellEnd = theCluster->cell_end();
    for (;itrCell!=itrCellEnd; ++itrCell) {
      const CaloCell* thisCell = *itrCell;
      double weight = itrCell.weight();//theCluster->getCellWeight(itrCell);
      //      Identifier myId = thisCell->ID();
      int theSample = thisCell->caloDDE()->getSampling();
      double absE = fabs(weight*thisCell->e());
      
      if ( absE > 0 ) {
    double lw = m_offset + log(absE*inv_absEClus);
    if ( lw > 0 ) {
 
      ATH_MSG_VERBOSE(" add cell with eta " 
              << thisCell->eta() << " phi " << thisCell->phi() 
              << " energy " << thisCell->e() << " weight " << weight 
              << " sampling " << theSample << " cluster e " 
              << theCluster->e() << " log weight " << lw);
      
 
      etaAll    += thisCell->eta()*lw;
      
      // first cell decides the sign in order to avoid
      // overlap problem at phi = -pi == +pi
      // need to be normalized to the range [-pi,+pi] in the end
      
      if ( weightAll > 0 
           && phiAll/weightAll < CaloPhiRange::phi_min() + 90*deg
           && thisCell->phi() > CaloPhiRange::phi_max() - 90*deg)
        phiAll    += (thisCell->phi()-360*deg)*lw;
      else if ( weightAll > 0 
            && phiAll/weightAll > CaloPhiRange::phi_max() - 90*deg
            && thisCell->phi() < CaloPhiRange::phi_min() + 90*deg)
        phiAll    += (thisCell->phi()+360*deg)*lw;
      else
        phiAll    += thisCell->phi()*lw;
 
      weightAll += lw;
 
      etaSample[theSample]    += thisCell->eta()*lw;
      if ( weightSample[theSample] > 0 
           && phiSample[theSample]/weightSample[theSample] 
           < CaloPhiRange::phi_min() + 90*deg
           && thisCell->phi() > CaloPhiRange::phi_max() - 90*deg)
        phiSample[theSample]    += (thisCell->phi()-360*deg)*lw;
      else if ( weightSample[theSample] > 0 
            && phiSample[theSample]/weightSample[theSample] 
            > CaloPhiRange::phi_max() - 90*deg
            && thisCell->phi() < CaloPhiRange::phi_min() + 90*deg)
        phiSample[theSample]    += (thisCell->phi()+360*deg)*lw;
      else
        phiSample[theSample]    += thisCell->phi()*lw;
      weightSample[theSample] += lw;
      
    }
      }
    }
    
    if ( weightAll > 0 ) {
      const double inv_weightAll = 1. / weightAll;
      theCluster->setEta(etaAll * inv_weightAll);
      theCluster->setPhi(CaloPhiRange::fix(phiAll * inv_weightAll));
    }
    
    // std::vector<double> theEtas(CaloCell_ID::Unknown,0);
    // std::vector<double> thePhis(CaloCell_ID::Unknown,0);
    // for (int i=0;i<CaloCell_ID::Unknown;i++) {
    //   if (theCluster->hasSampling(i)) {
    //  theEtas[i]=theCluster->etaSampl(i);
    //  thePhis[i]=theCluster->phiSampl(i);
    //   }
 
    for(int i=0;i<CaloCell_ID::Unknown;i++) {
      CaloSampling::CaloSample s=(CaloSampling::CaloSample)i;
      if ( theCluster->hasSampling(s) && weightSample[i] > 0 ) {
    float etaSample=theCluster->etaSample(s);
    float phiSample=theCluster->phiSample(s);
    etaSample /= weightSample[i];
    phiSample /= weightSample[i];
    phiSample = CaloPhiRange::fix(phiSample);
    theCluster->setEta(s,etaSample);
    theCluster->setPhi(s,phiSample);
      }
    }//end loop over samples
  }
 
  if ( msgSvc()->outputLevel(name()) <= MSG::DEBUG ) {
 
    ATH_MSG_DEBUG(" new cluster eta = " << theCluster->eta()
          << " phi = " << theCluster->phi());
 
    // std::vector<double> theEtas;
    // std::vector<double> thePhis;
 
    // theCluster->getEtaInSamples(theEtas);
    // theCluster->getPhiInSamples(thePhis);
    // for(int i=0;i<CaloCell_ID::Unknown;i++) {
    //   msg(MSG::DEBUG) << " new sampling " << i << " eta = " << theEtas[i]
    //            << " phi = " << thePhis[i] << endmsg;
    // }
  }
 
  return StatusCode::SUCCESS;
}

◆ execute() [2/3]

StatusCode CaloClusterProcessor::execute	(	const EventContext &	ctx,
		xAOD::CaloClusterContainer *	collection ) const

virtual

Execute on an entire collection of clusters.

Parameters

collection The container of clusters.

This will iterate over all the clusters in collection and call execute on each one individually.

Parameters

collection	The container of clusters.
ctx	The event context.

This will iterate over all the clusters in collection and call execute on each one individually.

Reimplemented from CaloClusterProcessor.

Definition at line 65 of file CaloClusterProcessor.cxx.

{
  for (xAOD::CaloCluster* clu : *collection) {
    ATH_CHECK( execute (ctx, clu) );
  }
  return StatusCode::SUCCESS;
}

◆ execute() [3/3]

virtual StatusCode CaloClusterCollectionProcessor::execute ( xAOD::CaloClusterContainer * collection )

inlinefinalvirtualinherited

Execute on an entire collection of clusters.

Parameters

collection The container of clusters. (deprecated)

Reimplemented from CaloClusterCollectionProcessor.

Definition at line 50 of file CaloClusterCollectionProcessor.h.

  {
    return execute (Gaudi::Hive::currentContext(), collection);
  }

◆ 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

◆ initialize()

StatusCode CaloClusterLogPos::initialize ( )

override

Definition at line 24 of file CaloClusterLogPos.cxx.

                                         {
 
  ATH_MSG_DEBUG("Initializing " << name() << endmsg ) ;
 
  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 & CaloClusterProcessor::interfaceID ( )

inlinestaticinherited

Standard Gaudi interface ID method.

Definition at line 72 of file CaloClusterProcessor.h.

72{return IID_CaloClusterProcessor;}

IID_CaloClusterProcessor

static const InterfaceID IID_CaloClusterProcessor("CaloClusterProcessor", 1, 0)

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

double CaloClusterLogPos::m_offset

private

Definition at line 69 of file CaloClusterLogPos.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

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ CaloClusterLogPos()

Member Function Documentation

◆ declareGaudiProperty()

◆ DeclareInterfaceID()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute() [1/3]

◆ execute() [2/3]

◆ execute() [3/3]

◆ extraDeps_update_handler()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_offset

◆ m_varHandleArraysDeclared

◆ m_vhka