eflowRingSubtractionManager.cxx

Go to the documentation of this file.

/*
  Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
 
/********************************************************************
 
NAME:     eflowRingSubtractionManager.h
PACKAGE:  offline/Reconstruction/eflowRec
 
AUTHORS:  M.Hodgkinson, R Duxfield (based on R.Duxfields Root package)
CREATED:  18th Aug, 2005
 
 ********************************************************************/
 
//Athena Headers
#include "eflowRingSubtractionManager.h"
#include "eflowFirstIntParameters.h"
#include "eflowEEtaBinnedParameters.h"
#include "eflowRingThicknesses.h"
 
#include <cmath>
#include <list>
 
eflowRingSubtractionManager::eflowRingSubtractionManager() : m_ringThickness(eflowCalo::nRegions), m_fudgeMean(0), m_fudgeStdDev(-1) {}
 
double eflowRingSubtractionManager::ringMeanRank(const std::vector<double>& p, double rMin, double rMax) {
 
  double x1 = 0.0;
  double x2 = 0.0;
 
  if (0 != p[1] && 0 != p[3]){
    x1 = std::exp(-rMin / p[1]) - std::exp(-rMax / p[1]);
    x2 = std::exp(-rMin / p[3]) - std::exp(-rMax / p[3]);
  }
 
  return (p[0] * p[1] * x1 + p[2] * p[3] * x2) / (rMax - rMin); // hard coded 4-param model for now
}
 
std::vector<eflowCaloENUM> eflowRingSubtractionManager::orderedLayersByShowerParam(
    const eflowFirstIntParameters& param, unsigned int whichParam) {
  /* Prepare a vector of calo layers which is ordered by the p0 parameter */
  /* First prepare a list of all layers (which are not eflowCalo::Unknown i.e. 999) */
  std::list<eflowCaloENUM> allLayers;
  for (int iLayer = 0; iLayer < eflowCalo::nRegions; iLayer++) {
    if (iLayer != eflowCalo::Unknown) {
      allLayers.push_back((eflowCaloENUM) (iLayer));
    }
  }
  /* Loop over the list to find the layer with highest p0.
   * Attach it to the end of the ordered vector and remove it from the list.
   * Repeat until the list is empty */
  std::vector<eflowCaloENUM> orderedLayers;
  while (!allLayers.empty()) {
    std::list<eflowCaloENUM>::iterator itLayer = allLayers.begin();
    std::list<eflowCaloENUM>::iterator itMaxP0Layer = itLayer;
    double p0Max = param.getShapeParameter(*itMaxP0Layer, whichParam);
    /* Get current highest p0-layer */
    for (; itLayer != allLayers.end(); ++itLayer) {
      double p0 = param.getShapeParameter(*itLayer, whichParam);
      if (p0 > p0Max) {
        itMaxP0Layer = itLayer;
        p0Max = p0;
      }
    }
    /* Attach to vector and remove from list */
    orderedLayers.push_back(*itMaxP0Layer);
    allLayers.erase(itMaxP0Layer);
  }
  return orderedLayers;
}
 
void eflowRingSubtractionManager::setParameters(const eflowFirstIntParameters& param, const std::vector<double>& ringThickness) {
  /* Prepare a vector of calo layers which is ordered by the p0 parameter */
  std::vector<eflowCaloENUM> orderedLayers = orderedLayersByShowerParam(param, 0);
 
  /* Set e/p and ring thicknesses */
  m_fudgeMean = param.fudgeMean();
  m_fudgeStdDev = param.fudgeStdDev();
  m_ringThickness = ringThickness;
 
  /* Populate the ring/rank map */
  m_rankMap.clear();
  double weight;
  double weightMax = ringMeanRank(param.getShapeParameters(orderedLayers[0]), 0.0, ringThickness[orderedLayers[0]])/m_weightRange;
  for (const auto & layer : orderedLayers) {
    /* Add weights to map (map does the ordering) */
    const int nRings = (int)(m_rMax / ringThickness[layer]);
 
    for (int iRing = 0; iRing < nRings; iRing++) {
      weight = ringMeanRank(param.getShapeParameters(layer), iRing*ringThickness[layer], (iRing+1)*ringThickness[layer]);
      if (weight == 0 || weight < weightMax) {
        break;                    // only add weights within a factor (range) of weightMax (say 10^6)
      } else {
        m_rankMap[1.0/weight] = RingId(layer, iRing);
      }
    }
  }
}
 
bool eflowRingSubtractionManager::getOrdering(const eflowEEtaBinnedParameters* binnedParameters, double e, double eta, eflowFirstIntENUM j1st, bool useLegacyEnergyBinIndexing) {
  const eflowParameters* bin1 = nullptr;
  const eflowParameters* bin2 = nullptr;
 
  /* Get the left- and right-bin given (e,eta), return the weight of the two bins and fill the bins to &bin1 and &bin2 */
  double weight = binnedParameters->getInterpolation(&bin1, &bin2, e, eta, useLegacyEnergyBinIndexing);
  if (!(bin1 && bin2)) { return false; }
 
  eflowFirstIntENUM adjustedJ1st = binnedParameters->adjustLFI(e, eta, j1st, useLegacyEnergyBinIndexing);
 
  /* Interpolate the firstInBins */
  eflowFirstIntParameters meanBin;
  bool isFailed = !(meanBin.getWeightedParameters(bin1->getFirstIntBin(adjustedJ1st), bin2->getFirstIntBin(adjustedJ1st), weight));
  if (isFailed) { return false; }
 
  /* Set the ring thicknesses */
  std::vector<double> ringThicknesses(eflowCalo::nRegions);
  for (int i = 0; i < eflowCalo::nRegions; i++) {
    //This was reviously interpolated - but the ring thickeness is a geometric property of the calorimeter without any energy dependence, so it was not needed.
    ringThicknesses[i] = eflowRingThicknesses::ringThickness((eflowCaloENUM) i);
  }
 
  setParameters(meanBin, ringThicknesses);
  return true;
}