CaloClusterCorrection Class Reference

#include <CaloClusterCorrection.h>

Inherits CaloUtils::ToolWithConstants< CaloClusterProcessor >.

Inherited by CaloClusterBadChannelList, CaloClusterCorrectionCommon, CaloClusterUpdate, CaloDummyCorrection, CaloFillRectangularCluster, CaloSwApplyWgts_g3, CaloSwClcon_g3, CaloSwECcrack_g3, CaloSwEta1b_g3, CaloSwEta1e_g3, CaloSwEta2b_g3, CaloSwEta2e_g3, CaloSwEtamod_g3, CaloSwGap_g3, CaloSwPhimod_g3, and CaloSwTime.

Collaboration diagram for CaloClusterCorrection:

Public Types
typedef ToolWithConstants	base_class
	Shorthand for derived classes. More...
using	Context = CaloUtils::ToolConstantsContext
	Convenient alias for the Context type. More...
using	Constant = ToolConstant< T >
	Alias for the Constant type. More...

Public Member Functions
virtual StatusCode	initialize () override
	Initialize method. More...
virtual void	setsample (xAOD::CaloCluster *cluster, CaloSampling::CaloSample sampling, float em, float etam, float phim, float emax, float etamax, float phimax, float etas, float phis) const
virtual void	setenergy (xAOD::CaloCluster *cluster, float energy) const
virtual void	makeCorrection (const Context &myctx, xAOD::CaloCluster *) const =0
StatusCode	execute (const EventContext &ctx, xAOD::CaloCluster *cluster) const override
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloCluster *cluster) const=0
	Execute on a single cluster. More...
virtual StatusCode	execute (xAOD::CaloCluster *cluster) final
	Execute on a single cluster. More...
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *collection) const
	Execute on an entire collection of clusters. More...
Context	context (const EventContext &ctx) const
	Create a Context object. More...
virtual void	writeConstants (std::ostream &stream, const std::string &name, const EventContext &ctx) const
	Dump method (for debugging) More...
virtual StatusCode	mergeConstants (CaloRec::ToolConstants &out, const EventContext &ctx) const override
	Merge our constants into out with the proper prefix. More...
virtual int	toolVersion () const
	Return the version number for this tool. More...
virtual const std::string &	toolType () const
	Return the name of the type of this tool. More...

Protected Attributes
SG::ReadCondHandleKey< CaloDetDescrManager >	m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}

Private Attributes
SG::ReadCondHandleKey< CaloRec::ToolConstants >	m_DBHandle
	Handle to a ToolConstants conditions object. More...
StringProperty	m_prefix
	Prefix for finding our constants within the ToolConstants object. More...
ToolWithConstantsImpl	m_impl
	Internal implementation object. More...
Constant< int >	m_order
	Used to fix the ordering of tools when we're initializing from COOL based on a hierarchical tag. More...
Constant< bool >	m_isdummy
	If true, then this is a dummy tool that should not be executed. More...

Detailed Description

Definition at line 53 of file CaloClusterCorrection.h.

Member Typedef Documentation

base_class

typedef ToolWithConstants CaloUtils::ToolWithConstants< BASE >::base_class

inherited

Shorthand for derived classes.

Definition at line 450 of file ToolWithConstants.h.

Constant

using CaloUtils::ToolWithConstants< BASE >::Constant = ToolConstant<T>

inherited

Alias for the Constant type.

Definition at line 463 of file ToolWithConstants.h.

Context

using CaloUtils::ToolWithConstants< BASE >::Context = CaloUtils::ToolConstantsContext

inherited

Convenient alias for the Context type.

Definition at line 458 of file ToolWithConstants.h.

Member Function Documentation

context()

Context CaloUtils::ToolWithConstants< BASE >::context ( const EventContext &  ctx ) const

inherited

Create a Context object.

This can then be passed to Constant::operator().

execute() [1/4]

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

override

Definition at line 53 of file CaloClusterCorrection.cxx.

{
  this->makeCorrection (context(ctx), cluster);
 
#if 0
  ATH_MSG_DEBUG( " ...... e, et " << cluster->e() << " " << cluster->et() << endmsg);
  ATH_MSG_DEBUG( " ...... eta, etaBE, etaSmp " << cluster->eta() << " " << cluster->etaBE(2) 
      << " " << cluster->etaSample(CaloSampling::EMB1) 
      << " " << cluster->etaSample(CaloSampling::EMB2) 
      << " " << cluster->etaSample(CaloSampling::EMB3) << endmsg);
  ATH_MSG_DEBUG( " ...... phi, phiBE, phiSmp " << cluster->phi() << " " << cluster->phiBE(2) 
      << " " << cluster->phiSample(CaloSampling::EMB1) 
      << " " << cluster->phiSample(CaloSampling::EMB2) 
      << " " << cluster->phiSample(CaloSampling::EMB3) << endmsg);
#endif
  
  return StatusCode::SUCCESS;
}

execute() [2/4]

virtual StatusCode CaloClusterProcessor::execute

Execute on a single cluster.

Parameters

cluster	The cluster to process.
ctx	The event context.

execute() [3/4]

StatusCode CaloClusterProcessor::execute

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.

Definition at line 73 of file CaloClusterProcessor.cxx.

{
  xAOD::CaloClusterContainer::iterator beg = collection->begin();
  xAOD::CaloClusterContainer::iterator end = collection->end();
  for (; beg != end; ++beg) {
    CHECK( execute (ctx, *beg) );
  }
  return StatusCode::SUCCESS;
}

execute() [4/4]

StatusCode CaloClusterProcessor::execute

final

Execute on a single cluster.

Parameters

cluster

The cluster to process. (deprecated)

Definition at line 63 of file CaloClusterProcessor.cxx.

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

initialize()

StatusCode CaloClusterCorrection::initialize ( )

overridevirtual

Initialize method.

Derived classes must call this.

Reimplemented from CaloUtils::ToolWithConstants< CaloClusterProcessor >.

Reimplemented in CaloSwGap_v2, CaloFillRectangularCluster, CaloTopoEMlayers, CaloSwGap_v3, CaloSwDeadOTX_back, CaloSwDeadOTX_ps, CaloSwGap_g3, CaloClusterBadChannelList, CaloDummyCorrection, and CaloTopoEMGap.

Definition at line 47 of file CaloClusterCorrection.cxx.

                                             {
  ATH_CHECK(m_caloMgrKey.initialize());
  ATH_CHECK(base_class::initialize());
  return StatusCode::SUCCESS;
}

makeCorrection()

virtual void CaloClusterCorrection::makeCorrection ( const Context &  myctx, xAOD::CaloCluster *    ) const

pure virtual

Implemented in CaloClusterUpdate, CaloFillRectangularCluster, CaloSwEta2b_g3, CaloSwClcon_g3, CaloSwEta1b_g3, CaloSwPhimod_g3, CaloSwEtamod_g3, CaloSwECcrack_g3, CaloSwEta2e_g3, CaloSwEta1e_g3, CaloSwGap_g3, CaloClusterCorrectionCommon, CaloClusterBadChannelList, CaloSwApplyWgts_g3, CaloSwTime, and CaloDummyCorrection.

mergeConstants()

virtual StatusCode CaloUtils::ToolWithConstants< BASE >::mergeConstants ( CaloRec::ToolConstants &  out, const EventContext &  ctx  ) const

overridevirtualinherited

Merge our constants into out with the proper prefix.

Parameters

[out]	out	Object to receive our constants.
	ctx	Event context.

setenergy()

void CaloClusterCorrection::setenergy ( xAOD::CaloCluster *  cluster, float  energy  ) const

virtual

Definition at line 94 of file CaloClusterCorrection.cxx.

{
  if (cluster->e() == 0) {
    if (energy != 0)
      REPORT_MESSAGE (MSG::WARNING)
        << "Attempt to rescale zero-energy cluster to energy " << energy
        << " ignored.";
    return;
  }
 
  float correction = energy/cluster->e();
  cluster->setE(energy);
 
  // also correct individual sampling energies:
 
  for (int iSample=CaloSampling::PreSamplerB; 
        iSample < CaloSampling::Unknown; 
       ++iSample) 
    {
      CaloSampling::CaloSample sampling=static_cast<CaloSampling::CaloSample>(iSample);
      if (cluster->hasSampling (sampling)) {
        double e = cluster->eSample(sampling);
        cluster->setEnergy(sampling,e*correction) ;
      }
  }
}

setsample()

void CaloClusterCorrection::setsample ( xAOD::CaloCluster *  cluster, CaloSampling::CaloSample  sampling, float  em, float  etam, float  phim, float  emax, float  etamax, float  phimax, float  etas, float  phis  ) const

virtual

Definition at line 74 of file CaloClusterCorrection.cxx.

{
  cluster->setEnergy(sampling, em);
  cluster->setEta(sampling, etam);
  cluster->setPhi(sampling, phim);
 
  cluster->setEmax(sampling,emax);
  cluster->setEtamax(sampling,etamax);
  cluster->setPhimax(sampling,phimax);
 
  cluster->setEtasize(sampling, etas);
  cluster->setPhisize(sampling, phis);
}

toolType()

virtual const std::string& CaloUtils::ToolWithConstants< BASE >::toolType ( ) const

virtualinherited

Return the name of the type of this tool.

A saved set of constants includes both the C++ class name and a version number. Normally, the class name is taken from the Gaudi type() method, but that may be changed by overriding this method. This can be used, for example, when there are tools with distinct C++ classes but which are yet similar enough to combine together.

toolVersion()

virtual int CaloUtils::ToolWithConstants< BASE >::toolVersion ( ) const

virtualinherited

Return the version number for this tool.

A saved set of constants includes both the C++ class name and a version number. The idea is that the version number can be bumped whenever there's a backwards-incompatible change; this gives some protection against trying to use an old version of a tool with an incompatible newer set of constants.

If you want a tool to have a version number, override this method. Otherwise, it will default to a version number of 0.

writeConstants()

virtual void CaloUtils::ToolWithConstants< BASE >::writeConstants ( std::ostream &  stream, const std::string &  name, const EventContext &  ctx  ) const

virtualinherited

Dump method (for debugging)

Parameters

stream	Ostream to which to write.
name	Name to go in output
ctx	Event context.

Member Data Documentation

m_caloMgrKey

SG::ReadCondHandleKey<CaloDetDescrManager> CaloClusterCorrection::m_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}

protected

Definition at line 119 of file CaloClusterCorrection.h.

m_DBHandle

SG::ReadCondHandleKey<CaloRec::ToolConstants> CaloUtils::ToolWithConstants< BASE >::m_DBHandle

privateinherited

Handle to a ToolConstants conditions object.

Definition at line 534 of file ToolWithConstants.h.

m_impl

ToolWithConstantsImpl CaloUtils::ToolWithConstants< BASE >::m_impl

privateinherited

Internal implementation object.

Definition at line 542 of file ToolWithConstants.h.

m_isdummy

Constant<bool> CaloUtils::ToolWithConstants< BASE >::m_isdummy

privateinherited

If true, then this is a dummy tool that should not be executed.

This is used for the case of reading from COOL using hierarchical tags: we need to have such tags associated with some object in each folder, regardless of whether or not the correction from that folder is actually used. [Every folder that IOVDbSvc knows about at configuration time needs to have a valid object for the configured tag, else IOVDbSvc will raise a fatal error. But we don't know at configuration time which folders we're actually going to need, so we gotta configure all of them.]

Definition at line 560 of file ToolWithConstants.h.

m_order

Constant<int> CaloUtils::ToolWithConstants< BASE >::m_order

privateinherited

Used to fix the ordering of tools when we're initializing from COOL based on a hierarchical tag.

Tools should be executed in order of increasing m_order.

Definition at line 547 of file ToolWithConstants.h.

m_prefix

StringProperty CaloUtils::ToolWithConstants< BASE >::m_prefix

privateinherited

Prefix for finding our constants within the ToolConstants object.

Definition at line 538 of file ToolWithConstants.h.

---

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

• CaloClusterCorrection.h
• CaloClusterCorrection.cxx