CaloSwEtaoff_v2 Class Reference

EM calorimeter eta offset (S-shape) corrections. More...

#include <CaloSwEtaoff_v2.h>

Inheritance diagram for CaloSwEtaoff_v2:

Collaboration diagram for CaloSwEtaoff_v2:

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	CaloSwEtaoff_v2_parms

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

Private Attributes
Constant< CxxUtils::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< 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::DDHelper >	m_ddhelper
	Helper for detector description lookup. More...
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

EM calorimeter eta offset (S-shape) corrections.

The measured cluster eta positions are biased towards the centers of the cells. This correction attempts to remove this bias.

If you plot \(\Delta\eta = \eta_{\rm true} - \eta_{\rm measured}\) as a function of \(\eta\), the result is nearly periodic in the cell structure. We model this by binning the plots in \(|\eta|\), fitting an empirical function to the bins, and then interpolating the fit parameters in \(|\eta|\) in order to extend the function over the entire range.

The function that is fit derives from a form suggested by Nicolas Kerschen. Let the offset of the cluster within the cell be \(u\), where \(u=0\) is at the center, and \(u=\pm 1\) are the edges. Then,

\[ f(u) = A\tan^{-1} Bu + Cu + D|u| + E. \]

We modify this function to ensure continuity by requiring that \(f(-1)=f(1)=0\). We also redefine the variables in order to remove correlations between them that cause the fit to behave poorly. ( \(A\) and \(B\) are highly correlated in the above, since they both strongly affect the total amplitude of the function. We take the terms involving \(A\) and \(B\), find the \(u\) positions where this part of the function are at extrema, and divide these terms by their value at these points, with \(A\) factored out.) Signs are also adjusted so that they are usually all positive. After the constraints are imposed, there are three parameters remaining:

\[ f(u) = A\left[{u\tan^{-1} B - \tan^{-1} Bu \over (Z/B)\tan^{-1} B - \tan^{-1} Z} + C(1-|u|)\right], \]

where

\[ Z = \sqrt{B\over \tan^{-1} B - 1}. \]

This is the form that we fit.

The parameters are tabulated as a function of energy; a second interpolation in energy is done on the parameters.

Definition at line 70 of file CaloSwEtaoff_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

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

inherited

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.

       {
    // Barrel, sampling 1.
    EMB1 = 0,
 
    // Barrel, sampling 2.
    EMB2 = 1,
 
    // Endcap, sampling 1.
    EME1 = 2,
 
    // Endcap, sampling 2.
    EME2 = 3,
 
    // Average of barrel and endcap in sampling 2.
    COMBINED2 = 4,
 
    // Overall cluster position.
    CLUSTER = 5,
 
    // Number of different region codes.
    NREGIONS = 6
  };

Member Function Documentation

CaloClusterCorrectionCommon()

CaloClusterCorrectionCommon::CaloClusterCorrectionCommon

Inherit constructor.

Definition at line 46 of file CaloClusterCorrectionCommon.cxx.

  : CaloClusterCorrection (type, name, parent)
{
}

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.

{
  const CaloClusterCorr::DDHelper* ddhelper = m_ddhelper.get();
  if (!ddhelper) {
    auto newhelper = std::make_unique<const CaloClusterCorr::DDHelper> (dd_man);
    ddhelper = m_ddhelper.set (std::move (newhelper));
  }
  return *ddhelper;
}

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 575 of file CaloClusterCorrectionCommon.cxx.

{
  // Calculate the correction for each energy.
  unsigned int n_energies = energies.size();
  unsigned int shape[] = {n_energies, 2};
  CaloRec::WritableArrayData<2> corrtab (shape);
 
  // If we're outside the range of the table, we'll just be using the
  // value at the end (no extrapolation).  We only need to calculate
  // that one point in that case.
  unsigned int beg = 0;
  unsigned int end = n_energies;
  if (energy <= energies[0])
    end = 1;
  else if (energy >= energies[n_energies-1])
    beg = n_energies-1;
 
  // Build the table.
  int n_good = 0;
  for (unsigned int i=beg; i<end; i++)
    docalc (i, builder, energies, corrtab, n_good);
 
  // If we only evaluated one point, but it wasn't good, keep
  // searching until we find a good one.
  while (n_good == 0 && beg > 0) {
    --beg;
    docalc (beg, builder, energies, corrtab, n_good);
  }
  while (n_good == 0 && end < n_energies) {
    docalc (end, builder, energies, corrtab, n_good);
    ++end;
  }
 
  // Now interpolate in energy.
  // But if we're outside of the range of the table, just use the value
  // at the end (don't extrapolate).
  if (n_good == 0) {
    // No good energies --- return a null correction.
    return 0;
  }
  else if (n_good == 1) {
    // Only one good energy --- nothing to do but to use it.
    return corrtab[0][1];
  }
  else if (energy <= corrtab[0][0]) {
    // Off the low end of the table --- return the first value.
    return corrtab[0][1];
  }
  else if (energy >= corrtab[n_good-1][0]) {
    // Off the high end of the table --- return the last value.
    return corrtab[n_good-1][1];
  }
 
  // Do the interpolation.
  return interpolate (corrtab, energy, energy_degree,
                      1, CaloRec::Array<1>(), n_good);
}

execute() [1/4]

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

overrideinherited

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

inherited

Execute on a single cluster.

Parameters

cluster	The cluster to process.
ctx	The event context.

execute() [3/4]

StatusCode CaloClusterProcessor::execute

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

finalinherited

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

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.

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

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 436 of file CaloClusterCorrectionCommon.cxx.

{
  int region = m_region (myctx);
 
  SG::ReadCondHandle<CaloDetDescrManager> caloMgrHandle{m_caloMgrKey, myctx.ctx()};
  const CaloDetDescrManager* dd_man = *caloMgrHandle;
 
  // This causes a lot of overhead (mostly from the MsgStream ctor).
  // Comment out when not needed.
  //MsgStream log( msgSvc(), name() );
  //log << MSG::DEBUG << "Entering makeCorrection" << endmsg;
  //log << MSG::DEBUG << "e, eta, phi, etasize, phisize" << " " << cluster->e() << " " << cluster->eta() << " " << cluster->phi() 
  //  << " " <<  cluster->etasize(CaloSampling::EMB2) << " " << cluster->phisize(CaloSampling::EMB2) << endmsg;
  //log << MSG::DEBUG << "B / E  " << cluster->inBarrel() << " " << cluster->inEndcap() << endmsg;
  //log << MSG::DEBUG << "region " << region << endmsg;
 
  float eta;
  float phi;
  CaloSampling::CaloSample samp = CaloSampling::Unknown;
 
  // Find the proper @f$\eta@f$ and @f$\phi@f$ measures of the cluster.
  // Also set up the sampling code @c samp.
  switch (region) {
  case EMB1:
  case EMB2:
  case EME1:
  case EME2:
    // Return immediately if we can tell we're in the wrong region.
    if (barrel_p (region)) {
      if (!cluster->inBarrel()) return;
    }
    else {
      if (!cluster->inEndcap()) return;
    }
 
    switch (region) {
    case EMB1:
      samp = CaloSampling::EMB1;
      break;
    case EMB2:
      samp = CaloSampling::EMB2;
      break;
    case EME1:
      samp = CaloSampling::EME1;
      break;
    case EME2:
      samp = CaloSampling::EME2;
      break;
    }
 
    eta = cluster->etaSample (samp);
    phi = cluster->phiSample (samp);
    break;
 
  case COMBINED2:
    eta = cluster->etaBE (2);
    phi = cluster->phiBE (2);
    break;
 
  case CLUSTER:
    eta = cluster->eta();
    phi = cluster->phi();
    break;
 
  default:
    abort();
  }
 
  // Give up if one of them is an error flag.
  if (std::abs (phi) > 900 || std::abs (eta) > 900)
    return;
 
  // Sometimes unnormalized @f$\phi@f$ values still come through.
  // Make sure this is in the proper range before calling the correction.
  phi = CaloPhiRange::fix (phi);
 
  // Look up the DD element.
  // Give up if we can't find one.
  const CaloDetDescrElement* elt = ddhelper(dd_man).find_dd_elt (dd_man,
                                 region,
                                 cluster,
                                 eta, phi);
  if (!elt)
    return;
 
  // Compute the adjusted eta and phi --- the coordinates shifted
  // from the actual to the nominal coordinate system.
  float adj_eta = eta - elt->eta() + elt->eta_raw();
  float adj_phi = CaloPhiRange::fix (phi - elt->phi() + elt->phi_raw());
 
  // Call the actual correction.
  makeTheCorrection (myctx, cluster, elt, eta, adj_eta, phi, adj_phi, samp);
}

makeTheCorrection()

void CaloSwEtaoff_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

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 45 of file CaloSwEtaoff_v2.cxx.

{
  const CxxUtils::Array<3> correction = m_correction (myctx);
  const CxxUtils::Array<1> interp_barriers = m_interp_barriers (myctx);
  const CxxUtils::Array<1> energies = m_energies (myctx);
  const int degree = m_degree (myctx);
  const int energy_degree = m_energy_degree (myctx);
 
  // Find u, the normalized displacement of the cluster within the cell.
  // In the range -1...1, with 0 at the center.
  float u = (eta - elt->eta()) / elt->deta() * 2;
  if (elt->eta_raw() < 0)
    u = -u;
 
  // u can sometimes be outside of the prescribed range, due to DD bugs.
  if (u > 1)
    u = 1;
  else if (u < -1)
    u = -1;
 
  // For each energy, interpolate in eta.
  // We can't use the common energy_interpolation code here,
  // because we're interpolating the fit parameters, not the overall
  // correction.  This should probably be done differently in the
  // next version.
  unsigned int n_energies = energies.size();
  unsigned int shape[] = {n_energies, 4};
  CaloRec::WritableArrayData<2> partab (shape);
 
  // If we're outside the range of the table, we'll just be using the
  // value at the end (no extrapolation).  We only need to calculate
  // that one point in that case.
  int beg = 0;
  int end = n_energies;
  float energy = cluster->e();
  if (energy <= energies[0])
    end = 1;
  else if (energy >= energies[n_energies-1])
    beg = n_energies-1;
 
  for (int i=beg; i<end; i++) {
    partab[i][0] = energies[i];
    for (int j=0; j < 3; j++)
      partab[i][j+1] = interpolate (correction[i],
                                    std::abs (adj_eta), 
                                    degree,
                                    j+1,
                                    interp_barriers);
  }
 
  // Now interpolate in energy.
  // But if we're outside of the range of the table, just use the value
  // at the end (don't extrapolate).
  float par[3];
  for (int i=0; i < 3; i++) {
    if (end-beg > 1)
      par[i] = interpolate (partab, energy, energy_degree, i+1);
    else
      par[i] = partab[beg][i+1];
  }
 
  // Calculate the fit function.
  // Don't allow b to go all the way to zero; we get a division
  // by zero there.
  double b = std::max ((double)par[1], 1e-5);
  double atanb = std::atan(b);
  double sq = std::sqrt (b/atanb - 1);
  double den = (sq/b*atanb - std::atan(sq));
  float offs = par[0]* ((- std::atan (b*u) + u*atanb) / den +
                        par[2]*(1-std::abs(u)));
 
  // Apply the offset correction to the cluster.
  if (eta < 0)
    offs = -offs;
  cluster->setEta (samp, eta + offs);
}

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]	out	Object to receive our constants.
	ctx	Event context.

setenergy()

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

virtualinherited

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

virtualinherited

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

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

Member Data Documentation

CaloSw_sample_energies

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

Definition at line 24 of file CaloSwEtaoff_v2.py.

CaloSwEtaoff_v2_parms

dictionary CaloSwEtaoff_v2.CaloSwEtaoff_v2_parms

Initial value:

=  { EMB1 : CaloSwEtaoff_v2_b1_parms,
                          EMB2 : CaloSwEtaoff_v2_b2_parms,
                          EME1 : CaloSwEtaoff_v2_e1_parms,
                          EME2 : CaloSwEtaoff_v2_e2_parms,
                          }

Definition at line 254 of file CaloSwEtaoff_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<CxxUtils::Array<3> > CaloSwEtaoff_v2::m_correction { this, "correction", "Tabulated arrays of function parameters." }

private

Calibration constant: tabulated arrays of function parameters.

Definition at line 109 of file CaloSwEtaoff_v2.h.

m_DBHandle

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

privateinherited

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> CaloSwEtaoff_v2::m_degree { this, "degree", "Degree of the polynomial interpolation." }

private

Calibration constant: degree of the polynomial interpolation.

Definition at line 118 of file CaloSwEtaoff_v2.h.

m_energies

Constant<CxxUtils::Array<1> > CaloSwEtaoff_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 123 of file CaloSwEtaoff_v2.h.

m_energy_degree

Constant<int> CaloSwEtaoff_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 127 of file CaloSwEtaoff_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> > CaloSwEtaoff_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 114 of file CaloSwEtaoff_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:

• CaloSwEtaoff_v2.h
• CaloSwEtaoff_v2.py
• CaloSwEtaoff_v2.cxx