EM calorimeter containment correction. More...

#include <CaloScaleCluster.h>

Inheritance diagram for CaloScaleCluster:

Collaboration diagram for CaloScaleCluster:

Public Types
enum	{ EMB1 = 0 , EMB2 = 1 , EME1 = 2 , EME2 = 3 , COMBINED2 = 4 , CLUSTER = 5 , NREGIONS = 6 }
	Region codes for `m_region` below. More...

Public Member Functions
virtual void	makeTheCorrection (const Context &myctx, xAOD::CaloCluster cluster, const CaloDetDescrElement elt, float eta, float adj_eta, float phi, float adj_phi, CaloSampling::CaloSample samp) const override
	Virtual function for the correction-specific code.
	CaloClusterCorrectionCommon (const std::string &type, const std::string &name, const IInterface *parent)
	Inherit constructor.
virtual void	makeCorrection (const Context &myctx, xAOD::CaloCluster *cluster) const override
	Perform the correction.
virtual StatusCode	initialize () override
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
StatusCode	execute (const EventContext &ctx, xAOD::CaloCluster *cluster) const override
virtual StatusCode	execute (const EventContext &ctx, xAOD::CaloClusterContainer *collection) const
	Execute on an entire collection of clusters.

Static Public Member Functions
static float	energy_interpolation (float energy, const TableBuilder &builder, const CaloRec::Array< 1 > &energies, int energy_degree)
	Many of the corrections use the same method for doing the final interpolation in energy.

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

Private Member Functions
const CaloClusterCorr::DDHelper &	ddhelper (const CaloDetDescrManager *dd_man) const
	Retrieve the detector description helper, creating it if needed.

Private Attributes
Constant< CxxUtils::Array< 2 > >	m_correction { this, "correction", "Arrays of function parameters" }
	Calibration constant: tabulated arrays of function parameters.
Constant< int >	m_degree { this, "degree", "Degree of the polynomial interpolation" }
	Calibration constant: degree of the polynomial interpolation.
Constant< float >	m_etamax { this, "etamax", "Maximum eta for which this correction is defined" }
	Calibration constant: maximum eta for which this correction is defined.
Constant< int >	m_region { this, "region", "Calorimeter region" }
	Calibration constant: The calorimeter region for which this correction is intended.
CxxUtils::CachedUniquePtr< const CaloClusterCorr::DDHelper >	m_ddhelper
	Helper for detector description lookup.

Detailed Description

EM calorimeter containment correction.

This correction scales the total cluster energy by a factor that depends on eta (but not on energy). Note that only the total energy is changed; the individual sampling energies are not changed.

Definition at line 35 of file CaloScaleCluster.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

inherited

Region codes for m_region below.

This is used to decide how to report the position of the cluster. Note: This numbering is also used in the job options files.

Enumerator
EMB1
EMB2
EME1
EME2
COMBINED2
CLUSTER
NREGIONS

Definition at line 100 of file CaloClusterCorrectionCommon.h.

Member Function Documentation

◆ CaloClusterCorrectionCommon()

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

Inherit constructor.

Definition at line 46 of file CaloClusterCorrectionCommon.cxx.

◆ ddhelper()

const CaloClusterCorr::DDHelper & CaloClusterCorrectionCommon::ddhelper ( const CaloDetDescrManager * dd_man ) const

privateinherited

Retrieve the detector description helper, creating it if needed.

Definition at line 639 of file CaloClusterCorrectionCommon.cxx.

◆ energy_interpolation()

float CaloClusterCorrectionCommon::energy_interpolation	(	float	energy,
		const TableBuilder &	builder,
		const CaloRec::Array< 1 > &	energies,
		int	energy_degree )

staticinherited

Many of the corrections use the same method for doing the final interpolation in energy.

Perform energy interpolation.

We factor out this common code here. builder is used to construct the interpolation table; energy is the energy value for the interpolation. energies is the list of energies at which we have tabulated values, and energy_degree is the degree of the polynomial interpolation in energy.

Parameters

energy	The energy value for the interpolation.
builder	Helper to construct the interpolation table.
energies	The energy interpolation table.
energy_degree	The polynomial interpolation degree for the energy interpolation.

Many of the corrections use the same method for doing the final interpolation in energy. We factor out this common code here.

Definition at line 574 of file CaloClusterCorrectionCommon.cxx.

◆ execute() [1/2]

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

overrideinherited

Definition at line 52 of file CaloClusterCorrection.cxx.

◆ execute() [2/2]

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

inherited

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 65 of file CaloClusterProcessor.cxx.

◆ initialize()

StatusCode CaloClusterCorrection::initialize ( )

overridevirtualinherited

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

Definition at line 46 of file CaloClusterCorrection.cxx.

◆ makeCorrection()

void CaloClusterCorrectionCommon::makeCorrection	(	const Context &	myctx,
		xAOD::CaloCluster *	cluster ) const

overridevirtualinherited

Perform the correction.

Called by the tool

Parameters

myctx	ToolWithConstants context.
cluster	The cluster to correct. It is updated in place.

Called by the tool.

Parameters

myctx	ToolWithConstants context.
cluster	The cluster to correct. It is updated in place.

Does the following:

Checks whether the cluster is present in the given calorimeter and sampling. If not, do nothing.
Computes quantities to pass to makeTheCorrection.
Calls makeTheCorrection.

Implements CaloClusterCorrection.

Definition at line 435 of file CaloClusterCorrectionCommon.cxx.

◆ makeTheCorrection()

void CaloScaleCluster::makeTheCorrection	(	const Context &	myctx,
		xAOD::CaloCluster *	cluster,
		const CaloDetDescrElement *	elt,
		float	eta,
		float	adj_eta,
		float	phi,
		float	adj_phi,
		CaloSampling::CaloSample	samp ) const

overridevirtual

Virtual function for the correction-specific code.

Parameters

myctx	ToolWithConstants context.
cluster	The cluster to correct. It is updated in place.
elt	The detector description element corresponding to the cluster location.
eta	The \(\eta\) coordinate of the cluster, in this sampling.
adj_eta	The \(\eta\) adjusted for any shift between the actual and nominal coordinates. (This is shifted back to the nominal coordinate system.)
phi	The \(\phi\) coordinate of the cluster, in this sampling.
adj_phi	The \(\phi\) adjusted for any shift between the actual and nominal coordinates. (This is shifted back to the nominal coordinate system.)
samp	The calorimeter sampling we're examining. This is a sampling code as defined by `CaloSampling::CaloSample`; i.e., it has both the calorimeter region and sampling encoded.

Implements CaloClusterCorrectionCommon.

Definition at line 41 of file CaloScaleCluster.cxx.

◆ setenergy()

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

virtualinherited

Definition at line 93 of file CaloClusterCorrection.cxx.

◆ 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

virtualinherited

Definition at line 73 of file CaloClusterCorrection.cxx.

Member Data Documentation

◆ m_caloMgrKey

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

protectedinherited

Definition at line 83 of file CaloClusterCorrection.h.

◆ m_correction

Constant<CxxUtils::Array<2> > CaloScaleCluster::m_correction { this, "correction", "Arrays of function parameters" }

private

Calibration constant: tabulated arrays of function parameters.

Definition at line 75 of file CaloScaleCluster.h.

◆ m_ddhelper

CxxUtils::CachedUniquePtr<const CaloClusterCorr::DDHelper> CaloClusterCorrectionCommon::m_ddhelper

privateinherited

Helper for detector description lookup.

Definition at line 165 of file CaloClusterCorrectionCommon.h.

◆ m_degree

Constant<int> CaloScaleCluster::m_degree { this, "degree", "Degree of the polynomial interpolation" }

private

Calibration constant: degree of the polynomial interpolation.

Definition at line 79 of file CaloScaleCluster.h.

◆ m_etamax

Constant<float> CaloScaleCluster::m_etamax { this, "etamax", "Maximum eta for which this correction is defined" }

private

Calibration constant: maximum eta for which this correction is defined.

Definition at line 83 of file CaloScaleCluster.h.

◆ m_region

Constant<int> CaloClusterCorrectionCommon::m_region { this, "region", "Calorimeter region" }

privateinherited

Calibration constant: The calorimeter region for which this correction is intended.

This should be one of the constants above. This affects the meaning of the eta and phi arguments passed to makeTheCorrection, as well as the samp argument.

Definition at line 161 of file CaloClusterCorrectionCommon.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Member Function Documentation

◆ CaloClusterCorrectionCommon()

◆ ddhelper()

◆ energy_interpolation()

◆ execute() [1/2]

◆ execute() [2/2]

◆ initialize()

◆ makeCorrection()

◆ makeTheCorrection()

◆ setenergy()

◆ setsample()

Member Data Documentation

◆ m_caloMgrKey

◆ m_correction

◆ m_ddhelper

◆ m_degree

◆ m_etamax

◆ m_region