ATLAS Offline Software
Classes | Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Attributes | Private Member Functions | Private Attributes | List of all members
CaloSwPhioff_v2 Class Reference

EM calorimeter \(\phi\) offset corrections. More...

#include <CaloSwPhioff_v2.h>

Inheritance diagram for CaloSwPhioff_v2:
Collaboration diagram for CaloSwPhioff_v2:

Classes

class  Builder
 Helper class for calculating the energy interpolation table. More...
 

Public Types

enum  {
  EMB1 = 0, EMB2 = 1, EME1 = 2, EME2 = 3,
  COMBINED2 = 4, CLUSTER = 5, NREGIONS = 6
}
 Region codes for m_region below. More...
 
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 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. More...
 
 CaloClusterCorrectionCommon (const std::string &type, const std::string &name, const IInterface *parent)
 Inherit constructor. More...
 
virtual void makeCorrection (const Context &myctx, xAOD::CaloCluster *cluster) const override
 Perform the correction. More...
 
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
 
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...
 

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

Public Attributes

list CaloSw_sample_energies = [50*GeV, 100*GeV, 200*GeV]
 
dictionary CaloSwPhioff_v2_parms
 

Protected Attributes

SG::ReadCondHandleKey< CaloDetDescrManagerm_caloMgrKey {this,"CaloDetDescrManager", "CaloDetDescrManager"}
 

Private Member Functions

const CaloClusterCorr::DDHelperddhelper (const CaloDetDescrManager *dd_man) const
 Retrieve the detector description helper, creating it if needed. More...
 

Private Attributes

Constant< CaloRec::Array< 3 > > m_correction { this, "correction", "Tabulated arrays of function parameters." }
 Calibration constant: tabulated arrays of function parameters. More...
 
Constant< CxxUtils::Array< 1 > > m_interp_barriers { this, "interp_barriers", "Allow breaking up the interpolation into independent regions." }
 Calibration constant: allow breaking up the interpolation into independent regions. More...
 
Constant< int > m_degree { this, "degree", "Degree of the polynomial interpolation." }
 Calibration constant: degree of the polynomial interpolation. More...
 
Constant< float > m_correction_coef { this, "correction_coef", "Coefficient by which to scale the entire correction." }
 Calibration constant: coefficient by which to scale the entire correction. More...
 
Constant< bool > m_flip_phi { this, "flip_phi", "If true, the correction gets an opposite sign if eta < 0." }
 Calibration constant: if true, the correction gets an opposite sign if eta < 0. More...
 
Constant< CxxUtils::Array< 1 > > m_energies { this, "energies", "Table of energies at which the correction was tabulated." }
 Calibration constant: table of energies at which the correction was tabulated. More...
 
Constant< int > m_energy_degree { this, "energy_degree", "Degree of the polynomial interpolation in energy." }
 Calibration constant: degree of the polynomial interpolation in energy. More...
 
Constant< int > m_region { this, "region", "Calorimeter region" }
 Calibration constant: The calorimeter region for which this correction is intended. More...
 
CxxUtils::CachedUniquePtr< const CaloClusterCorr::DDHelperm_ddhelper
 Helper for detector description lookup. More...
 
SG::ReadCondHandleKey< CaloRec::ToolConstantsm_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

EM calorimeter \(\phi\) offset corrections.

The correction is an interpolation in a table, as a function of abs(eta). One thing to be careful about: in geant 4, this correction has opposite sign for eta>0 and eta<0. For geant 3, it had the same sign in both halves. This behavior is controlled by m_flip_phi.

The correction parameters are tabulated by energy. A second interpolation is done on the cluster energy.

Definition at line 54 of file CaloSwPhioff_v2.h.

Member Typedef Documentation

◆ base_class

typedef ToolWithConstants CaloUtils::ToolWithConstants< CaloClusterProcessor >::base_class
inherited

Shorthand for derived classes.

Definition at line 443 of file ToolWithConstants.h.

◆ Constant

using CaloUtils::ToolWithConstants< CaloClusterProcessor >::Constant = ToolConstant<T>
inherited

Alias for the Constant type.

Definition at line 456 of file ToolWithConstants.h.

◆ Context

Convenient alias for the Context type.

Definition at line 451 of file ToolWithConstants.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.

100  {
101  // Barrel, sampling 1.
102  EMB1 = 0,
103 
104  // Barrel, sampling 2.
105  EMB2 = 1,
106 
107  // Endcap, sampling 1.
108  EME1 = 2,
109 
110  // Endcap, sampling 2.
111  EME2 = 3,
112 
113  // Average of barrel and endcap in sampling 2.
114  COMBINED2 = 4,
115 
116  // Overall cluster position.
117  CLUSTER = 5,
118 
119  // Number of different region codes.
120  NREGIONS = 6
121  };

Member Function Documentation

◆ CaloClusterCorrectionCommon()

CaloClusterCorrectionCommon::CaloClusterCorrectionCommon

Inherit constructor.

Definition at line 46 of file CaloClusterCorrectionCommon.cxx.

412 {
413 }

◆ context()

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

Create a Context object.

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

◆ ddhelper()

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

Retrieve the detector description helper, creating it if needed.

Definition at line 640 of file CaloClusterCorrectionCommon.cxx.

641 {
643  if (!ddhelper) {
644  auto newhelper = std::make_unique<const CaloClusterCorr::DDHelper> (dd_man);
645  ddhelper = m_ddhelper.set (std::move (newhelper));
646  }
647  return *ddhelper;
648 }

◆ 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
energyThe energy value for the interpolation.
builderHelper to construct the interpolation table.
energiesThe energy interpolation table.
energy_degreeThe 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 575 of file CaloClusterCorrectionCommon.cxx.

581 {
582  // Calculate the correction for each energy.
583  unsigned int n_energies = energies.size();
584  unsigned int shape[] = {n_energies, 2};
585  CaloRec::WritableArrayData<2> corrtab (shape);
586 
587  // If we're outside the range of the table, we'll just be using the
588  // value at the end (no extrapolation). We only need to calculate
589  // that one point in that case.
590  unsigned int beg = 0;
591  unsigned int end = n_energies;
592  if (energy <= energies[0])
593  end = 1;
594  else if (energy >= energies[n_energies-1])
595  beg = n_energies-1;
596 
597  // Build the table.
598  int n_good = 0;
599  for (unsigned int i=beg; i<end; i++)
600  docalc (i, builder, energies, corrtab, n_good);
601 
602  // If we only evaluated one point, but it wasn't good, keep
603  // searching until we find a good one.
604  while (n_good == 0 && beg > 0) {
605  --beg;
606  docalc (beg, builder, energies, corrtab, n_good);
607  }
608  while (n_good == 0 && end < n_energies) {
609  docalc (end, builder, energies, corrtab, n_good);
610  ++end;
611  }
612 
613  // Now interpolate in energy.
614  // But if we're outside of the range of the table, just use the value
615  // at the end (don't extrapolate).
616  if (n_good == 0) {
617  // No good energies --- return a null correction.
618  return 0;
619  }
620  else if (n_good == 1) {
621  // Only one good energy --- nothing to do but to use it.
622  return corrtab[0][1];
623  }
624  else if (energy <= corrtab[0][0]) {
625  // Off the low end of the table --- return the first value.
626  return corrtab[0][1];
627  }
628  else if (energy >= corrtab[n_good-1][0]) {
629  // Off the high end of the table --- return the last value.
630  return corrtab[n_good-1][1];
631  }
632 
633  // Do the interpolation.
634  return interpolate (corrtab, energy, energy_degree,
635  1, CaloRec::Array<1>(), n_good);
636 }

◆ execute() [1/4]

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

Definition at line 53 of file CaloClusterCorrection.cxx.

55 {
56  this->makeCorrection (context(ctx), cluster);
57 
58 #if 0
59  ATH_MSG_DEBUG( " ...... e, et " << cluster->e() << " " << cluster->et() << endmsg);
60  ATH_MSG_DEBUG( " ...... eta, etaBE, etaSmp " << cluster->eta() << " " << cluster->etaBE(2)
61  << " " << cluster->etaSample(CaloSampling::EMB1)
62  << " " << cluster->etaSample(CaloSampling::EMB2)
63  << " " << cluster->etaSample(CaloSampling::EMB3) << endmsg);
64  ATH_MSG_DEBUG( " ...... phi, phiBE, phiSmp " << cluster->phi() << " " << cluster->phiBE(2)
65  << " " << cluster->phiSample(CaloSampling::EMB1)
66  << " " << cluster->phiSample(CaloSampling::EMB2)
67  << " " << cluster->phiSample(CaloSampling::EMB3) << endmsg);
68 #endif
69 
70  return StatusCode::SUCCESS;
71 }

◆ execute() [2/4]

virtual StatusCode CaloClusterProcessor::execute
inherited

Execute on a single cluster.

Parameters
clusterThe cluster to process.
ctxThe event context.

◆ execute() [3/4]

StatusCode CaloClusterProcessor::execute
inherited

Execute on an entire collection of clusters.

Parameters
collectionThe container of clusters.

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

Parameters
collectionThe container of clusters.
ctxThe 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.

59 {
60  xAOD::CaloClusterContainer::iterator beg = collection->begin();
61  xAOD::CaloClusterContainer::iterator end = collection->end();
62  for (; beg != end; ++beg) {
63  CHECK( execute (ctx, *beg) );
64  }
65  return StatusCode::SUCCESS;
66 }

◆ execute() [4/4]

StatusCode CaloClusterProcessor::execute
finalinherited

Execute on a single cluster.

Parameters
clusterThe cluster to process. (deprecated)

Definition at line 63 of file CaloClusterProcessor.cxx.

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

◆ initialize()

StatusCode CaloClusterCorrection::initialize ( )
overridevirtualinherited

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.

47  {
50  return StatusCode::SUCCESS;
51 }

◆ makeCorrection()

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

Perform the correction.

Called by the tool

Parameters
myctxToolWithConstants context.
clusterThe cluster to correct. It is updated in place.

Called by the tool.

Parameters
myctxToolWithConstants context.
clusterThe 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 436 of file CaloClusterCorrectionCommon.cxx.

438 {
439  int region = m_region (myctx);
440 
441  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey, myctx.ctx()};
442  const CaloDetDescrManager* dd_man = *caloMgrHandle;
443 
444  // This causes a lot of overhead (mostly from the MsgStream ctor).
445  // Comment out when not needed.
446  //MsgStream log( msgSvc(), name() );
447  //log << MSG::DEBUG << "Entering makeCorrection" << endmsg;
448  //log << MSG::DEBUG << "e, eta, phi, etasize, phisize" << " " << cluster->e() << " " << cluster->eta() << " " << cluster->phi()
449  // << " " << cluster->etasize(CaloSampling::EMB2) << " " << cluster->phisize(CaloSampling::EMB2) << endmsg;
450  //log << MSG::DEBUG << "B / E " << cluster->inBarrel() << " " << cluster->inEndcap() << endmsg;
451  //log << MSG::DEBUG << "region " << region << endmsg;
452 
453  float eta;
454  float phi;
456 
457  // Find the proper @f$\eta@f$ and @f$\phi@f$ measures of the cluster.
458  // Also set up the sampling code @c samp.
459  switch (region) {
460  case EMB1:
461  case EMB2:
462  case EME1:
463  case EME2:
464  // Return immediately if we can tell we're in the wrong region.
465  if (barrel_p (region)) {
466  if (!cluster->inBarrel()) return;
467  }
468  else {
469  if (!cluster->inEndcap()) return;
470  }
471 
472  switch (region) {
473  case EMB1:
474  samp = CaloSampling::EMB1;
475  break;
476  case EMB2:
477  samp = CaloSampling::EMB2;
478  break;
479  case EME1:
480  samp = CaloSampling::EME1;
481  break;
482  case EME2:
483  samp = CaloSampling::EME2;
484  break;
485  }
486 
487  eta = cluster->etaSample (samp);
488  phi = cluster->phiSample (samp);
489  break;
490 
491  case COMBINED2:
492  eta = cluster->etaBE (2);
493  phi = cluster->phiBE (2);
494  break;
495 
496  case CLUSTER:
497  eta = cluster->eta();
498  phi = cluster->phi();
499  break;
500 
501  default:
502  abort();
503  }
504 
505  // Give up if one of them is an error flag.
506  if (std::abs (phi) > 900 || std::abs (eta) > 900)
507  return;
508 
509  // Sometimes unnormalized @f$\phi@f$ values still come through.
510  // Make sure this is in the proper range before calling the correction.
512 
513  // Look up the DD element.
514  // Give up if we can't find one.
515  const CaloDetDescrElement* elt = ddhelper(dd_man).find_dd_elt (dd_man,
516  region,
517  cluster,
518  eta, phi);
519  if (!elt)
520  return;
521 
522  // Compute the adjusted eta and phi --- the coordinates shifted
523  // from the actual to the nominal coordinate system.
524  float adj_eta = eta - elt->eta() + elt->eta_raw();
525  float adj_phi = CaloPhiRange::fix (phi - elt->phi() + elt->phi_raw());
526 
527  // Call the actual correction.
528  makeTheCorrection (myctx, cluster, elt, eta, adj_eta, phi, adj_phi, samp);
529 }

◆ makeTheCorrection()

void CaloSwPhioff_v2::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
myctxToolWithConstants context.
clusterThe cluster to correct. It is updated in place.
eltThe detector description element corresponding to the cluster location.
etaThe \(\eta\) coordinate of the cluster, in this sampling.
adj_etaThe \(\eta\) adjusted for any shift between the actual and nominal coordinates. (This is shifted back to the nominal coordinate system.)
phiThe \(\phi\) coordinate of the cluster, in this sampling.
adj_phiThe \(\phi\) adjusted for any shift between the actual and nominal coordinates. (This is shifted back to the nominal coordinate system.)
sampThe 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 72 of file CaloSwPhioff_v2.cxx.

80 {
81  // Calculate the correction.
82  float offs = m_correction_coef(myctx) * energy_interpolation
83  (cluster->e(),
84  Builder (m_correction (myctx),
85  m_interp_barriers (myctx),
86  m_degree (myctx),
87  std::abs (adj_eta)),
88  m_energies(myctx),
89  m_energy_degree(myctx));
90 
91  // Flip the sign, if needed.
92  if (m_flip_phi(myctx) && elt->eta_raw() < 0)
93  offs = -offs;
94 
95  // Apply the correction.
96  cluster->setPhi (samp, CaloPhiRange::fix (phi + offs));
97 }

◆ mergeConstants()

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

Merge our constants into out with the proper prefix.

Parameters
[out]outObject to receive our constants.
ctxEvent context.

◆ setenergy()

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

Definition at line 94 of file CaloClusterCorrection.cxx.

95 {
96  if (cluster->e() == 0) {
97  if (energy != 0)
98  REPORT_MESSAGE (MSG::WARNING)
99  << "Attempt to rescale zero-energy cluster to energy " << energy
100  << " ignored.";
101  return;
102  }
103 
104  float correction = energy/cluster->e();
105  cluster->setE(energy);
106 
107  // also correct individual sampling energies:
108 
109  for (int iSample=CaloSampling::PreSamplerB;
110  iSample < CaloSampling::Unknown;
111  ++iSample)
112  {
113  CaloSampling::CaloSample sampling=static_cast<CaloSampling::CaloSample>(iSample);
114  if (cluster->hasSampling (sampling)) {
115  double e = cluster->eSample(sampling);
116  cluster->setEnergy(sampling,e*correction) ;
117  }
118  }
119 }

◆ 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 74 of file CaloClusterCorrection.cxx.

79 {
80  cluster->setEnergy(sampling, em);
81  cluster->setEta(sampling, etam);
82  cluster->setPhi(sampling, phim);
83 
84  cluster->setEmax(sampling,emax);
85  cluster->setEtamax(sampling,etamax);
86  cluster->setPhimax(sampling,phimax);
87 
88  cluster->setEtasize(sampling, etas);
89  cluster->setPhisize(sampling, phis);
90 }

◆ toolType()

virtual const std::string& CaloUtils::ToolWithConstants< CaloClusterProcessor >::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< CaloClusterProcessor >::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< CaloClusterProcessor >::writeConstants ( std::ostream &  stream,
const std::string &  name,
const EventContext &  ctx 
) const
virtualinherited

Dump method (for debugging)

Parameters
streamOstream to which to write.
nameName to go in output
ctxEvent context.

Member Data Documentation

◆ CaloSw_sample_energies

list CaloSwPhioff_v2.CaloSw_sample_energies = [50*GeV, 100*GeV, 200*GeV]

Definition at line 22 of file CaloSwPhioff_v2.py.

◆ CaloSwPhioff_v2_parms

dictionary CaloSwPhioff_v2.CaloSwPhioff_v2_parms
Initial value:
= { EMB2 : CaloSwPhioff_v2_b_parms,
EME2 : CaloSwPhioff_v2_e_parms,
}

Definition at line 155 of file CaloSwPhioff_v2.py.

◆ m_caloMgrKey

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

Definition at line 119 of file CaloClusterCorrection.h.

◆ m_correction

Constant<CaloRec::Array<3> > CaloSwPhioff_v2::m_correction { this, "correction", "Tabulated arrays of function parameters." }
private

Calibration constant: tabulated arrays of function parameters.

Definition at line 128 of file CaloSwPhioff_v2.h.

◆ m_correction_coef

Constant<float> CaloSwPhioff_v2::m_correction_coef { this, "correction_coef", "Coefficient by which to scale the entire correction." }
private

Calibration constant: coefficient by which to scale the entire correction.

Definition at line 142 of file CaloSwPhioff_v2.h.

◆ m_DBHandle

Handle to a ToolConstants conditions object.

Definition at line 527 of file ToolWithConstants.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> CaloSwPhioff_v2::m_degree { this, "degree", "Degree of the polynomial interpolation." }
private

Calibration constant: degree of the polynomial interpolation.

Definition at line 137 of file CaloSwPhioff_v2.h.

◆ m_energies

Constant<CxxUtils::Array<1> > CaloSwPhioff_v2::m_energies { this, "energies", "Table of energies at which the correction was tabulated." }
private

Calibration constant: table of energies at which the correction was tabulated.

Definition at line 152 of file CaloSwPhioff_v2.h.

◆ m_energy_degree

Constant<int> CaloSwPhioff_v2::m_energy_degree { this, "energy_degree", "Degree of the polynomial interpolation in energy." }
private

Calibration constant: degree of the polynomial interpolation in energy.

Definition at line 156 of file CaloSwPhioff_v2.h.

◆ m_flip_phi

Constant<bool> CaloSwPhioff_v2::m_flip_phi { this, "flip_phi", "If true, the correction gets an opposite sign if eta < 0." }
private

Calibration constant: if true, the correction gets an opposite sign if eta < 0.

Definition at line 147 of file CaloSwPhioff_v2.h.

◆ m_impl

ToolWithConstantsImpl CaloUtils::ToolWithConstants< CaloClusterProcessor >::m_impl
privateinherited

Internal implementation object.

Definition at line 535 of file ToolWithConstants.h.

◆ m_interp_barriers

Constant<CxxUtils::Array<1> > CaloSwPhioff_v2::m_interp_barriers { this, "interp_barriers", "Allow breaking up the interpolation into independent regions." }
private

Calibration constant: allow breaking up the interpolation into independent regions.

Definition at line 133 of file CaloSwPhioff_v2.h.

◆ m_isdummy

Constant<bool> CaloUtils::ToolWithConstants< CaloClusterProcessor >::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 553 of file ToolWithConstants.h.

◆ m_order

Constant<int> CaloUtils::ToolWithConstants< CaloClusterProcessor >::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 540 of file ToolWithConstants.h.

◆ m_prefix

StringProperty CaloUtils::ToolWithConstants< CaloClusterProcessor >::m_prefix
privateinherited

Prefix for finding our constants within the ToolConstants object.

Definition at line 531 of file ToolWithConstants.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:
xAOD::CaloCluster_v1::phi
virtual double phi() const
The azimuthal angle ( ) of the particle.
Definition: CaloCluster_v1.cxx:256
CaloClusterCorrectionCommon::ddhelper
const CaloClusterCorr::DDHelper & ddhelper(const CaloDetDescrManager *dd_man) const
Retrieve the detector description helper, creating it if needed.
Definition: CaloClusterCorrectionCommon.cxx:640
GetLCDefs::Unknown
@ Unknown
Definition: GetLCDefs.h:21
xAOD::CaloCluster_v1::setPhisize
bool setPhisize(const CaloSample sampling, const float phiSize)
Set the cluster size in for a given sampling.
Definition: CaloCluster_v1.cxx:624
CaloClusterCorr::DDHelper::find_dd_elt
const CaloDetDescrElement * find_dd_elt(const CaloDetDescrManager *dd_mgr, int region, const xAOD::CaloCluster *cluster, float eta, float phi) const
Find the detector descriptor element for a given position, correcting for DD edge bugs.
Definition: CaloClusterCorrectionCommon.cxx:165
constants.EMB1
int EMB1
Definition: Calorimeter/CaloClusterCorrection/python/constants.py:53
phi
Scalar phi() const
phi method
Definition: AmgMatrixBasePlugin.h:64
SG::ReadCondHandle
Definition: ReadCondHandle.h:44
eta
Scalar eta() const
pseudorapidity method
Definition: AmgMatrixBasePlugin.h:79
CxxUtils::Array::size
unsigned int size(unsigned int dim=0) const
Return the size of the array along one dimension.
CaloDetDescrElement
This class groups all DetDescr information related to a CaloCell. Provides a generic interface for al...
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:66
CaloClusterCorr::DDHelper
Definition: CaloClusterCorrectionCommon.cxx:84
CaloClusterCorrectionCommon::m_ddhelper
CxxUtils::CachedUniquePtr< const CaloClusterCorr::DDHelper > m_ddhelper
Helper for detector description lookup.
Definition: CaloClusterCorrectionCommon.h:165
xAOD::CaloCluster_v1::et
double et() const
Definition: CaloCluster_v1.h:856
CaloSwPhioff_v2::m_energies
Constant< CxxUtils::Array< 1 > > m_energies
Calibration constant: table of energies at which the correction was tabulated.
Definition: CaloSwPhioff_v2.h:153
xAOD::CaloCluster_v1::phiBE
float phiBE(const unsigned layer) const
Get the phi in one layer of the EM Calo.
Definition: CaloCluster_v1.cxx:680
CaloClusterCorrectionCommon::EMB2
@ EMB2
Definition: CaloClusterCorrectionCommon.h:105
xAOD::CaloCluster_v1::setEnergy
bool setEnergy(const CaloSample sampling, const float e)
Set energy for a given sampling. Returns false if the sample isn't part of the cluster.
Definition: CaloCluster_v1.cxx:526
CaloSwPhioff_v2::m_energy_degree
Constant< int > m_energy_degree
Calibration constant: degree of the polynomial interpolation in energy.
Definition: CaloSwPhioff_v2.h:157
CaloClusterCorrectionCommon::NREGIONS
@ NREGIONS
Definition: CaloClusterCorrectionCommon.h:120
xAOD::CaloCluster_v1::setEmax
bool setEmax(const CaloSample sampling, const float eMax)
Set the Energy of the cell with the highest energy in a particular sampling.
Definition: CaloCluster_v1.cxx:571
CaloDetDescrElement::eta_raw
float eta_raw() const
cell eta_raw
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:350
mergePhysValFiles.end
end
Definition: DataQuality/DataQualityUtils/scripts/mergePhysValFiles.py:93
xAOD::CaloCluster_v1::etaSample
float etaSample(const CaloSample sampling) const
Retrieve barycenter in a given sample.
Definition: CaloCluster_v1.cxx:532
CaloUtils::ToolWithConstants::initialize
virtual StatusCode initialize() override
Initialize method.
tools.zlumi_mc_cf.correction
def correction(mu, runmode, campaign, run=None)
Definition: zlumi_mc_cf.py:4
xAOD::CaloCluster_v1::etaBE
float etaBE(const unsigned layer) const
Get the eta in one layer of the EM Calo.
Definition: CaloCluster_v1.cxx:644
xAOD::CaloCluster_v1::setE
void setE(flt_t)
Definition: CaloCluster_v1.cxx:375
xAOD::CaloCluster_v1::setPhimax
bool setPhimax(const CaloSample sampling, const float phiMax)
Set the phi of the cell with the highest energy in a particular sampling.
Definition: CaloCluster_v1.cxx:597
xAOD::CaloCluster_v1
Description of a calorimeter cluster.
Definition: CaloCluster_v1.h:59
xAOD::CaloCluster_v1::inEndcap
bool inEndcap() const
Returns true if at least one clustered cell in the endcap.
Definition: CaloCluster_v1.h:901
ParticleGun_FastCalo_ChargeFlip_Config.energy
energy
Definition: ParticleGun_FastCalo_ChargeFlip_Config.py:78
constants.EMB2
int EMB2
Definition: Calorimeter/CaloClusterCorrection/python/constants.py:54
DataModel_detail::iterator
(Non-const) Iterator class for DataVector/DataList.
Definition: DVLIterator.h:184
xAOD::CaloCluster_v1::eta
virtual double eta() const
The pseudorapidity ( ) of the particle.
Definition: CaloCluster_v1.cxx:251
lumiFormat.i
int i
Definition: lumiFormat.py:92
CaloSampling::CaloSample
CaloSample
Definition: Calorimeter/CaloGeoHelpers/CaloGeoHelpers/CaloSampling.h:22
createSimpleDistributions.builder
builder
Definition: createSimpleDistributions.py:52
endmsg
#define endmsg
Definition: AnalysisConfig_Ntuple.cxx:63
ATH_MSG_DEBUG
#define ATH_MSG_DEBUG(x)
Definition: AthMsgStreamMacros.h:29
CxxUtils::Array
Read-only multidimensional array.
Definition: Control/CxxUtils/CxxUtils/Array.h:138
xAOD::CaloCluster_v1::inBarrel
bool inBarrel() const
Returns true if at least one clustered cell in the barrel.
Definition: CaloCluster_v1.h:896
test_pyathena.parent
parent
Definition: test_pyathena.py:15
CaloClusterCorrectionCommon::COMBINED2
@ COMBINED2
Definition: CaloClusterCorrectionCommon.h:114
constants.EME1
int EME1
Definition: Calorimeter/CaloClusterCorrection/python/constants.py:55
CxxUtils::WritableArrayData
Definition: Control/CxxUtils/CxxUtils/Array.h:778
ATH_CHECK
#define ATH_CHECK
Definition: AthCheckMacros.h:40
CHECK
#define CHECK(...)
Evaluate an expression and check for errors.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:422
xAOD::CaloCluster_v1::phiSample
float phiSample(const CaloSample sampling) const
Retrieve barycenter in a given sample.
Definition: CaloCluster_v1.cxx:547
CaloPhiRange::fix
static double fix(double phi)
Definition: CaloPhiRange.cxx:14
CaloSwPhioff_v2::m_degree
Constant< int > m_degree
Calibration constant: degree of the polynomial interpolation.
Definition: CaloSwPhioff_v2.h:138
CaloSwPhioff_v2::m_correction_coef
Constant< float > m_correction_coef
Calibration constant: coefficient by which to scale the entire correction.
Definition: CaloSwPhioff_v2.h:143
WriteBchToCool.beg
beg
Definition: WriteBchToCool.py:69
CaloClusterCorrectionCommon::makeTheCorrection
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 =0
Virtual function for the correction-specific code.
name
std::string name
Definition: Control/AthContainers/Root/debug.cxx:192
SG::CondHandleKey::initialize
StatusCode initialize(bool used=true)
CaloUtils::ToolWithConstants< CaloClusterProcessor >::context
Context context(const EventContext &ctx) const
Create a Context object.
CaloClusterCorrection::m_caloMgrKey
SG::ReadCondHandleKey< CaloDetDescrManager > m_caloMgrKey
Definition: CaloClusterCorrection.h:119
REPORT_MESSAGE
#define REPORT_MESSAGE(LVL)
Report a message.
Definition: Control/AthenaKernel/AthenaKernel/errorcheck.h:365
CaloClusterCorrection::makeCorrection
virtual void makeCorrection(const Context &myctx, xAOD::CaloCluster *) const =0
CaloSwPhioff_v2::m_correction
Constant< CaloRec::Array< 3 > > m_correction
Calibration constant: tabulated arrays of function parameters.
Definition: CaloSwPhioff_v2.h:129
xAOD::CaloCluster_v1::eSample
float eSample(const CaloSample sampling) const
Definition: CaloCluster_v1.cxx:521
DiTauMassTools::MaxHistStrategyV2::e
e
Definition: PhysicsAnalysis/TauID/DiTauMassTools/DiTauMassTools/HelperFunctions.h:26
CaloClusterCorrectionCommon::EMB1
@ EMB1
Definition: CaloClusterCorrectionCommon.h:102
CaloClusterCorrectionCommon::energy_interpolation
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.
Definition: CaloClusterCorrectionCommon.cxx:575
CaloDetDescrManager
This class provides the client interface for accessing the detector description information common to...
Definition: CaloDetDescrManager.h:473
CaloCell_ID_FCS::PreSamplerB
@ PreSamplerB
Definition: FastCaloSim_CaloCell_ID.h:19
python.CaloScaleNoiseConfig.type
type
Definition: CaloScaleNoiseConfig.py:78
CaloClusterCorr::interpolate
float interpolate(const CaloRec::Array< 2 > &a, float x, unsigned int degree, unsigned int ycol=1, const CaloRec::Array< 1 > &regions=CaloRec::Array< 1 >(), int n_points=-1, bool fixZero=false)
Polynomial interpolation in a table.
Definition: interpolate.cxx:75
xAOD::CaloCluster_v1::setPhi
bool setPhi(const CaloSample sampling, const float phi)
Set in a given sampling. Returns false if the sample isn't part of the cluster.
Definition: CaloCluster_v1.cxx:556
CaloClusterCorrectionCommon::EME1
@ EME1
Definition: CaloClusterCorrectionCommon.h:108
CaloSwPhioff_v2::m_flip_phi
Constant< bool > m_flip_phi
Calibration constant: if true, the correction gets an opposite sign if eta < 0.
Definition: CaloSwPhioff_v2.h:148
xAOD::CaloCluster_v1::setEtamax
bool setEtamax(const CaloSample sampling, const float etaMax)
Set the eta of the cell with the highest energy in a particular sampling.
Definition: CaloCluster_v1.cxx:584
CaloDetDescrElement::eta
float eta() const
cell eta
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:344
CaloDetDescrElement::phi
float phi() const
cell phi
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:346
xAOD::CaloCluster_v1::setEtasize
bool setEtasize(const CaloSample sampling, const float etaSize)
Set the cluster size in for a given sampling.
Definition: CaloCluster_v1.cxx:611
CaloClusterCorrection
Definition: CaloClusterCorrection.h:55
xAOD::CaloCluster_v1::setEta
bool setEta(const CaloSample sampling, const float eta)
Set in a given sampling. Returns false if the sample isn't part of the cluster.
Definition: CaloCluster_v1.cxx:541
xAOD::CaloCluster_v1::hasSampling
bool hasSampling(const CaloSample s) const
Checks if certain smapling contributes to cluster.
Definition: CaloCluster_v1.h:890
CaloSwPhioff_v2::m_interp_barriers
Constant< CxxUtils::Array< 1 > > m_interp_barriers
Calibration constant: allow breaking up the interpolation into independent regions.
Definition: CaloSwPhioff_v2.h:134
CaloClusterCorrection::execute
StatusCode execute(const EventContext &ctx, xAOD::CaloCluster *cluster) const override
Definition: CaloClusterCorrection.cxx:53
CaloCell_ID_FCS::EMB3
@ EMB3
Definition: FastCaloSim_CaloCell_ID.h:22
xAOD::CaloCluster_v1::e
virtual double e() const
The total energy of the particle.
Definition: CaloCluster_v1.cxx:265
EgEfficiencyCorr_testFixedInput.etas
list etas
Definition: EgEfficiencyCorr_testFixedInput.py:9
constants.EME2
int EME2
Definition: Calorimeter/CaloClusterCorrection/python/constants.py:56
CaloClusterCorrectionCommon::CLUSTER
@ CLUSTER
Definition: CaloClusterCorrectionCommon.h:117
CaloClusterCorrectionCommon::EME2
@ EME2
Definition: CaloClusterCorrectionCommon.h:111
CaloDetDescrElement::phi_raw
float phi_raw() const
cell phi_raw
Definition: Calorimeter/CaloDetDescr/CaloDetDescr/CaloDetDescrElement.h:352
CaloClusterCorrectionCommon::m_region
Constant< int > m_region
Calibration constant: The calorimeter region for which this correction is intended.
Definition: CaloClusterCorrectionCommon.h:162