EgammaSshapeCalibration Class Reference

#include <EgammaSshapeCalibration.h>

Inheritance diagram for EgammaSshapeCalibration:

Collaboration diagram for EgammaSshapeCalibration:

Classes
class	Builder

Public Member Functions
virtual StatusCode	initialize () override
	Initialization of the tool. More...
virtual StatusCode	finalize () override
	Finalization of the tool. More...
virtual void	makeCorrection (xAOD::TrigEMCluster *, const void *) const override
	Virtual function from IEgammaCalibration. More...

Private Types
enum	{   REG_LO = 0, REG_HI = 1, REG_FORM = 2, REG_CELLSIZE = 3,   REG_PHASE = 4 }

Private Member Functions
void	docalc (int, const CaloClusterCorrectionCommon::TableBuilder &, const CxxUtils::Array< 1 > &, CxxUtils::WritableArray< 2 > &, int &) const

Private Attributes
Constant< CxxUtils::Array< 4 > >	m_correction { this, "correction" }
	Calibration constant: tabulated arrays of function parameters. More...
Constant< CxxUtils::Array< 2 > >	m_regions { this, "regions" }
	Calibration constant: table of regions. More...
Constant< CxxUtils::Array< 1 > >	m_energies { this, "energies" }
	Table of energies at which the correction was tabulated. More...
Constant< int >	m_energy_degree { this, "energy_degree", 3 }
	Degree of the polynomial interpolation in energy. More...
Constant< bool >	m_isRange_barrel { this, "rangeBarrel" }
Constant< CxxUtils::Array< 2 > >	m_forms { this, "forms" }
	Calibration constant: Functional form to use per region per energy. More...

Friends
class	Builder

Detailed Description

Definition at line 23 of file EgammaSshapeCalibration.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
REG_LO
REG_HI
REG_FORM
REG_CELLSIZE
REG_PHASE

Definition at line 103 of file EgammaSshapeCalibration.h.

       {
    REG_LO = 0,
    REG_HI = 1,
    REG_FORM = 2,
    REG_CELLSIZE = 3,
    REG_PHASE = 4
  };

Member Function Documentation

docalc()

void EgammaSshapeCalibration::docalc ( int  i, const CaloClusterCorrectionCommon::TableBuilder &  builder, const CxxUtils::Array< 1 > &  energies, CxxUtils::WritableArray< 2 > &  corrtab, int &  n_good  ) const

inlineprivate

Definition at line 216 of file EgammaSshapeCalibration.cxx.

                                            {
  corrtab[n_good][0] = energies[i];
  bool good = false;
  corrtab[n_good][1] = builder.calculate (i, good);
  if (good)
    ++n_good;
}

finalize()

StatusCode EgammaSshapeCalibration::finalize ( )

overridevirtual

Finalization of the tool.

Definition at line 26 of file EgammaSshapeCalibration.cxx.

                                            {
  return StatusCode::SUCCESS;  
}

initialize()

StatusCode EgammaSshapeCalibration::initialize ( )

overridevirtual

Initialization of the tool.

Definition at line 17 of file EgammaSshapeCalibration.cxx.

                                              {
  CHECK(base_class::initialize());
  ATH_MSG_DEBUG( "Initialize Tool : " << name()  );
  return StatusCode::SUCCESS;
}

makeCorrection()

void EgammaSshapeCalibration::makeCorrection ( xAOD::TrigEMCluster *  clus, const void *  arg  ) const

overridevirtual

Virtual function from IEgammaCalibration.

Definition at line 33 of file EgammaSshapeCalibration.cxx.

                                               {
  
  if(arg!=0){
    const CaloDetDescrElement *caloDDE = (const CaloDetDescrElement*) arg;
 
    bool isRange_barrel = m_isRange_barrel();
 
#ifndef NDEBUG    
    ATH_MSG_DEBUG( "caloDDE->descriptor()->is_lar_em_barrel() = " 
                   << caloDDE->descriptor()->is_lar_em_barrel()  );
    ATH_MSG_DEBUG( "caloDDE->descriptor()->is_lar_em_endcap() = " 
                   << caloDDE->descriptor()->is_lar_em_endcap()  );
 
    ATH_MSG_DEBUG( "m_isRange_barrel=" << isRange_barrel  );
 
    ATH_MSG_DEBUG( "clus->energy(CaloSampling::PreSamplerB) = " 
                   << clus->energy(CaloSampling::PreSamplerB)  );
    ATH_MSG_DEBUG( "clus->energy(CaloSampling::EMB1)        = " 
                   << clus->energy(CaloSampling::EMB1)  );
    ATH_MSG_DEBUG( "clus->energy(CaloSampling::EMB2)        = " 
                   << clus->energy(CaloSampling::EMB2)  );
    ATH_MSG_DEBUG( "clus->energy(CaloSampling::EMB3)        = " 
                   << clus->energy(CaloSampling::EMB3)  );
    ATH_MSG_DEBUG( "clus->energy(CaloSampling::PreSamplerE) = " 
                   << clus->energy(CaloSampling::PreSamplerE)  );
    ATH_MSG_DEBUG( "clus->energy(CaloSampling::EME1)        = " 
                   << clus->energy(CaloSampling::EME1)  );
    ATH_MSG_DEBUG( "clus->energy(CaloSampling::EME2)        = " 
                   << clus->energy(CaloSampling::EME2)  );
    ATH_MSG_DEBUG( "clus->energy(CaloSampling::EME3)        = " 
                   << clus->energy(CaloSampling::EME3)  );
 
    if((caloDDE->descriptor()->is_lar_em_barrel() &&  isRange_barrel) ||
       (caloDDE->descriptor()->is_lar_em_endcap() && !isRange_barrel))
      ATH_MSG_DEBUG( "[GOOD]: seedCell location and selected eta range agree"  );
    else if((caloDDE->descriptor()->is_lar_em_barrel() && !isRange_barrel) ||
        (caloDDE->descriptor()->is_lar_em_endcap() &&  isRange_barrel))
      ATH_MSG_DEBUG( "[BAD]: seedCell location and selected eta range disagree !!"  );
#endif
  
    // check if seedCell is in barrel or end-cap for correct range selection
    if((caloDDE->descriptor()->is_lar_em_barrel() && !isRange_barrel) ||
       (caloDDE->descriptor()->is_lar_em_endcap() &&  isRange_barrel))
      return;
    
    double eta      = clus->eta();     // cluster position in eta     
    double elt_eta  = caloDDE->eta();  // seedCell position in eta
    double elt_deta = caloDDE->deta(); // seedCell width in eta
 
    // Find u, the normalized displacement of the cluster within the cell
    // in the range -1...1, with 0 being at the center.
    double u = 2*(eta-elt_eta)/elt_deta; // position within cell
    
    // cluster position in eta without accounting for alignment corrections
    double elt_eta_raw = clus->rawEta(); 
    
    if(elt_eta_raw<0.) u=-u;
   
    // Sanity-check of valid u-range...
    if(u>1) 
      u=1;
    else if(u<-1)   
      u=-1;                 
   
    // The eta adjusted for any shift between the actual and nominal coordinates.    
    double aeta = fabs(eta - elt_eta + elt_eta_raw);
 
#ifndef NDEBUG    
    ATH_MSG_DEBUG( "eta         = " << eta          );
    ATH_MSG_DEBUG( "elt_eta     = " << elt_eta      );
    ATH_MSG_DEBUG( "elt_deta    = " << elt_deta     );
    ATH_MSG_DEBUG( "elt_eta_raw = " << elt_eta_raw  );
    ATH_MSG_DEBUG( "u           = " << u            );
    ATH_MSG_DEBUG( "aeta        = " << aeta         );
#endif
    
    // Find the appropriate region 
    int region_ndx=-1;
    const CxxUtils::Array<2> regions = m_regions();
    unsigned int nreg = regions.size();
 
    // find correct region
    for (unsigned int i=0; i<nreg; i++) {
      if(aeta>=regions[i][REG_LO] && aeta<regions[i][REG_HI]){
    region_ndx=i;
    break;
      }
    }
 
    // Sanity-check for region index...
    if(region_ndx<0){
      return;
    }
 
    // In a few regions, the fit was done using a cell size different
    // from what we actually have.  Need to recalculate u in this case.
    if(std::abs(regions[region_ndx][REG_CELLSIZE]-elt_deta) > 1e-3) {
      float cellsize = regions[region_ndx][REG_CELLSIZE];
      u = fmod(aeta,cellsize)/cellsize*2 - 1;
    }
 
    float energy = clus->energy();
 
    Builder *builder = new Builder(*this, aeta, u, region_ndx);
    
    // Calculate the correction for each energy.
    const CxxUtils::Array<1> energies = m_energies();
    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]) // ok. energies also in MeV
      end = 1;
    else if(energy >= energies[n_energies-1])// ok. energies also in MeV
      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).
    
    float offs=0;
    
    if(n_good==0){ // No good energies --- return a null correction.
      offs=0;  
    }
    else if(n_good==1){ // Only one good energy --- nothing to do but to use it.
      offs=corrtab[0][1]; 
    } 
    else if(energy<=corrtab[0][0]){ // Off the low end of the table --- return the first value.
      offs=corrtab[0][1];
    }
    else if(energy>=corrtab[n_good-1][0]) { // Off the high end of the table --- return the last value.
      offs=corrtab[n_good-1][1];
    }
    else{ // Do the interpolation.
      offs = CaloClusterCorr::interpolate(corrtab, 
                      energy, 
                      m_energy_degree(),
                      1, 
                      CaloRec::Array<1>(), 
                      n_good);
    }
    
    if (eta<0) 
      offs=-offs;
 
    clus->setEta(eta+offs);  
 
#ifndef NDEBUG     
    ATH_MSG_DEBUG( "Before correction : " << eta  );
    ATH_MSG_DEBUG( "offset =" << offs  );
    ATH_MSG_DEBUG( "After correction : " << eta+offs  );
#endif
    
    delete builder;
  }
}

Friends And Related Function Documentation

Builder

friend class Builder

friend

Definition at line 77 of file EgammaSshapeCalibration.h.

Member Data Documentation

m_correction

Constant<CxxUtils::Array<4> > EgammaSshapeCalibration::m_correction { this, "correction" }

private

Calibration constant: tabulated arrays of function parameters.

Index 0: energy Index 1: region Index 2: parameter Index 3: polynomial coefficient

Note: If [e][r][0][-1] (where -1 means the last in the array) is exactly 0, for any e and r, then this energy/region is skipped. (This is usually because insufficient statistics were available to get a good fit.)

Definition at line 90 of file EgammaSshapeCalibration.h.

m_energies

Constant<CxxUtils::Array<1> > EgammaSshapeCalibration::m_energies { this, "energies" }

private

Table of energies at which the correction was tabulated.

Definition at line 112 of file EgammaSshapeCalibration.h.

m_energy_degree

Constant<int> EgammaSshapeCalibration::m_energy_degree { this, "energy_degree", 3 }

private

Degree of the polynomial interpolation in energy.

Definition at line 115 of file EgammaSshapeCalibration.h.

m_forms

Constant<CxxUtils::Array<2> > EgammaSshapeCalibration::m_forms { this, "forms" }

private

Calibration constant: Functional form to use per region per energy.

If this is empty, the form is taken instead from the region table (and is thus same for all energies).

Definition at line 122 of file EgammaSshapeCalibration.h.

m_isRange_barrel

Constant<bool> EgammaSshapeCalibration::m_isRange_barrel { this, "rangeBarrel" }

private

Definition at line 117 of file EgammaSshapeCalibration.h.

m_regions

Constant<CxxUtils::Array<2> > EgammaSshapeCalibration::m_regions { this, "regions" }

private

Calibration constant: table of regions.

For each region, we have:

• Lower \(|\eta|\) for the region.
• Upper \(|\eta|\) for the region.
• Index of the functional form for this region.
• Cell size for this region.
• Offset of cell low edge wrt a multiple of the cell size (not currently used).

If the forms variable is provided, then the functional form is taken from there instead of from here.

Definition at line 102 of file EgammaSshapeCalibration.h.

---

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

• EgammaSshapeCalibration.h
• EgammaSshapeCalibration.cxx