CaloSwGap_v2 Class Reference

EM calorimeter gap corrections. More...

#include <CaloSwGap_v2.h>

Inheritance diagram for CaloSwGap_v2:

Collaboration diagram for CaloSwGap_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...

Public Member Functions
virtual StatusCode	initialize () override
	Standard Gaudi initialize method.
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.
virtual StatusCode	setCaloCellContainerName (const std::string &name) override
	Change the name of the CaloCellContainer used by this tool.
	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 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.

Public Attributes
list	CaloSwGap_v2
	Gap energy correction up to version 11.x.x.

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< float >	m_etamin_crack { this, "etamin_crack", "Lower end of range over which this correction is defined." }
	Calibration constants: The range over which this correction is defined.
Constant< float >	m_etamax_crack { this, "etamax_crack", "Upper end of range over which this correction is defined." }
Constant< int >	m_degree { this, "degree", "Interpolation degree." }
	Calibration constant: The interpolation degree.
Constant< CxxUtils::Array< 2 > >	m_correction { this, "correction", "The tabulated array of correction weights, A and alpha." }
	Calibration constant: The tabulated array of correction weights, A and alpha.
Constant< bool >	m_use_raw_eta { this, "use_raw_eta", "If true, tabulated values are in terms of raw (local) eta." }
	Calibration constant: If true, tabulated values are in terms of raw (local) eta.
SG::ReadHandleKey< CaloCellContainer >	m_cells_name { this, "cells_name", "AllCalo", "The name of the container in which to look to find tile cells." }
	Property: The name of the container in which to look to find tile cells.
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 gap corrections.

This tool attempts to correct for the energy lost in dead material in the gap between the barrel and end cryostats. In addition to the energy in the EM calorimeter, we also use energy deposited in scintillators between the cryostats. The correction is of the form

\[ E' = A(E_c + \alpha E_s), \]

where \(E_c\) is the measured energy in the EM calorimeter, and \(E_s\) is the measured energy in the scintillator. The coefficients \(A\) and \(\alpha\) are \(\eta\)-dependent. The total scale \(A\) is determined by fitting a polynomial to the \(E_{\rm meas}/E_{\rm true}\) curve outside the gap region, and interpolating over the gap. The weight \(\alpha\) is found by requiring that the RMS of \(E'\) be a minimum.

The resulting weights do not vary a lot with energy in the range studied (50 to 200 GeV). Thus, we combine together all the energies when determining the correction; the resulting correction is then energy-independent. The residual energy dependence will be folded into subsequent corrections.

Definition at line 71 of file CaloSwGap_v2.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	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent )

Inherit constructor.

Definition at line 46 of file CaloClusterCorrectionCommon.cxx.

  : CaloClusterCorrection (type, name, parent)
{
}

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.

{
  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 574 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/2]

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

overrideinherited

Definition at line 52 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/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.

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

initialize()

StatusCode CaloSwGap_v2::initialize ( )

overridevirtual

Standard Gaudi initialize method.

Reimplemented from CaloClusterCorrection.

Definition at line 63 of file CaloSwGap_v2.cxx.

{
  ATH_CHECK( CaloClusterCorrectionCommon::initialize() );
  ATH_CHECK( m_cells_name.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 435 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 CaloSwGap_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 91 of file CaloSwGap_v2.cxx.

{
  // ??? In principle, we should use adj_eta for the interpolation
  //     and range checks.  However, the v2 corrections were derived
  //     using regular eta instead.
  float the_aeta;
  if (m_use_raw_eta(myctx))
    the_aeta = std::abs (adj_eta);
  else
    the_aeta = std::abs (eta);
 
  if (the_aeta < m_etamin_crack(myctx) || the_aeta > m_etamax_crack(myctx))
    return; // no correction required
 
  SG::ReadHandle<CaloCellContainer> cc (m_cells_name, myctx.ctx());
 
  // Add up the tile scintillator energy in the region around the cluster.
  double eh_scint = 0;
  if(cc.isValid())
  {
    CaloCellContainer::const_iterator f_cell =
      cc->beginConstCalo(CaloCell_ID::TILE);
    CaloCellContainer::const_iterator l_cell =
      cc->endConstCalo(CaloCell_ID::TILE);
 
    for ( ; f_cell!=l_cell; ++f_cell)
    {
      const CaloCell* cell = (*f_cell) ; 
 
      if (CaloCell_ID::TileGap3 == cell->caloDDE()->getSampling()) {
        double phic = cell->phi();
        double etac = cell->eta(); 
        if (phic-phi < -pi) phic = phic + twopi;
        if (phic-phi > pi)  phic = phic - twopi;    
        if (etac >= eta-deta && etac <= eta+deta) {
          if (phic >= phi-dphi && phic <= phi+dphi) {
            eh_scint += cell->e();
          }
        }
      }
    }
  }
 
  const int degree = m_degree (myctx);
  const CxxUtils::Array<2> correction = m_correction (myctx);
 
  // Find the correction weights.
  float a = interpolate (correction, the_aeta, degree, 1);
  float alpha = interpolate (correction, the_aeta, degree, 2);
  float offset = interpolate (correction, the_aeta, degree, 3);
 
  // The correction is a weighted sum of calorimeter and scintillator energies.
  float ec = cluster->e();
 
  // Sampling energies don't include scintillator contribution.
  setenergy (cluster, a*(ec + offset));
  cluster->setE (a*(ec + alpha*eh_scint + offset));
}

setCaloCellContainerName()

StatusCode CaloSwGap_v2::setCaloCellContainerName ( const std::string & name )

overridevirtual

Change the name of the CaloCellContainer used by this tool.

Parameters

name	The new container name.

Implements ISetCaloCellContainerName.

Definition at line 163 of file CaloSwGap_v2.cxx.

{
  return this->setProperty (StringProperty ("cells_name", name));
}

setenergy()

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

virtualinherited

Definition at line 93 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 73 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);
}

Member Data Documentation

CaloSwGap_v2

list CaloSwGap_v2.CaloSwGap_v2

Gap energy correction up to version 11.x.x.

Definition at line 119 of file CaloSwGap_v2.py.

m_caloMgrKey

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

protectedinherited

Definition at line 83 of file CaloClusterCorrection.h.

{this,"CaloDetDescrManager", "CaloDetDescrManager"};

m_cells_name

SG::ReadHandleKey<CaloCellContainer> CaloSwGap_v2::m_cells_name { this, "cells_name", "AllCalo", "The name of the container in which to look to find tile cells." }

private

Property: The name of the container in which to look to find tile cells.

Definition at line 146 of file CaloSwGap_v2.h.

{ this, "cells_name", "AllCalo", "The name of the container in which to look to find tile cells." };

m_correction

Constant<CxxUtils::Array<2> > CaloSwGap_v2::m_correction { this, "correction", "The tabulated array of correction weights, A and alpha." }

private

Calibration constant: The tabulated array of correction weights, A and alpha.

Definition at line 137 of file CaloSwGap_v2.h.

{ this, "correction", "The tabulated array of correction weights, A and alpha." };

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> CaloSwGap_v2::m_degree { this, "degree", "Interpolation degree." }

private

Calibration constant: The interpolation degree.

Definition at line 132 of file CaloSwGap_v2.h.

{ this, "degree", "Interpolation degree." };

m_etamax_crack

Constant<float> CaloSwGap_v2::m_etamax_crack { this, "etamax_crack", "Upper end of range over which this correction is defined." }

private

Definition at line 128 of file CaloSwGap_v2.h.

{ this, "etamax_crack", "Upper end of range over which this correction is defined." };

m_etamin_crack

Constant<float> CaloSwGap_v2::m_etamin_crack { this, "etamin_crack", "Lower end of range over which this correction is defined." }

private

Calibration constants: The range over which this correction is defined.

Definition at line 126 of file CaloSwGap_v2.h.

{ this, "etamin_crack", "Lower end of range over which this correction is defined." };

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.

{ this, "region", "Calorimeter region" };

m_use_raw_eta

Constant<bool> CaloSwGap_v2::m_use_raw_eta { this, "use_raw_eta", "If true, tabulated values are in terms of raw (local) eta." }

private

Calibration constant: If true, tabulated values are in terms of raw (local) eta.

Definition at line 142 of file CaloSwGap_v2.h.

{ this, "use_raw_eta", "If true, tabulated values are in terms of raw (local) eta." };

---

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

• CaloSwGap_v2.h
• CaloSwGap_v2.py
• CaloSwGap_v2.cxx