eclLeakageCollectorModule.cc

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
/* Own header. */
#include <ecl/modules/eclLeakageCollector/eclLeakageCollectorModule.h>
 
/* ECL headers. */
#include <ecl/dataobjects/ECLShower.h>
#include <ecl/dataobjects/ECLCalDigit.h>
#include <ecl/geometry/ECLLeakagePosition.h>
#include <ecl/dataobjects/ECLElementNumbers.h>
 
/* Basf2 headers. */
#include <framework/dataobjects/EventMetaData.h>
#include <framework/geometry/VectorUtil.h>
#include <mdst/dataobjects/MCParticle.h>
 
/* Root headers. */
#include <Math/Vector3D.h>
#include <Math/VectorUtil.h>
#include <TTree.h>
 
/* C++ headers. */
#include <cmath>
#include <iostream>
 
using namespace Belle2;
using namespace ECL;
 
//-----------------------------------------------------------------
//                 Register the Module
//-----------------------------------------------------------------
REG_MODULE(eclLeakageCollector);
 
//-----------------------------------------------------------------
//                 Implementation
//-----------------------------------------------------------------
 
//-----------------------------------------------------------------
eclLeakageCollectorModule::eclLeakageCollectorModule() : CalibrationCollectorModule(),
  m_mcParticleArray("MCParticles"),
  m_evtMetaData("EventMetaData")
{
  setDescription("Store quantities from single photon MC used to calculated ECL energy leakage corrections");
  setPropertyFlags(c_ParallelProcessingCertified);
  addParam("position_bins", m_position_bins, "number of crystal subdivisions in theta and phi", 29);
  addParam("number_energies", m_number_energies, "number of generated energies", 8);
  addParam("energies_forward", m_energies_forward, "generated photon energies, forward", std::vector<double> {0.030, 0.050, 0.100, 0.200, 0.483, 1.166, 2.816, 6.800});
  addParam("energies_barrel", m_energies_barrel, "generated photon energies, barrel", std::vector<double> {0.030, 0.050, 0.100, 0.200, 0.458, 1.049, 2.402, 5.500});
  addParam("energies_backward", m_energies_backward, "generated photon energies, backward", std::vector<double> {0.030, 0.050, 0.100, 0.200, 0.428, 0.917, 1.962, 4.200});
  addParam("showerArrayName", m_showerArrayName, "name of ECLShower data object", std::string("ECLTrimmedShowers"));
}
 
 
//-----------------------------------------------------------------
void eclLeakageCollectorModule::prepare()
{
  //-----------------------------------------------------------------
  //..Parameters and other basic info
  B2INFO("eclLeakageCollector: Experiment = " << m_evtMetaData->getExperiment() << "  run = " << m_evtMetaData->getRun());
 
  //..Check that input parameters are consistent
  const int n_e_forward = m_energies_forward.size();
  const int n_e_barrel = m_energies_barrel.size();
  const int n_e_backward = m_energies_backward.size();
  if (n_e_forward != m_number_energies or n_e_barrel != m_number_energies or n_e_backward != m_number_energies) {
    B2FATAL("eclLeakageCollector: length of energy vectors inconsistent with parameter number_energies: " << n_e_forward << " " <<
            n_e_barrel << " " << n_e_backward << " " << m_number_energies);
  }
 
  //..Store generated energies as integers in MeV
  i_energies.resize(nLeakReg, std::vector<int>(m_number_energies, 0));
  for (int ie = 0; ie < m_number_energies; ie++) {
    i_energies[0][ie] = (int)(1000.*m_energies_forward[ie] + 0.5);
    i_energies[1][ie] = (int)(1000.*m_energies_barrel[ie] + 0.5);
    i_energies[2][ie] = (int)(1000.*m_energies_backward[ie] + 0.5);
  }
 
  //..Require all energies are different, and that there are at least two
  if (m_number_energies < 2) {
    B2FATAL("eclLeakageCollector: require at least two energy points. m_number_energies = " << m_number_energies);
  }
  for (int ie = 0; ie < m_number_energies - 1; ie++) {
    for (int ireg = 0; ireg < nLeakReg; ireg++) {
      if (i_energies[ireg][ie] == i_energies[ireg][ie + 1]) {
        B2FATAL("eclLeakageCollector: identical energies, ireg = " << ireg << ", " << i_energies[ireg][ie] << " MeV");
      }
    }
  }
 
  //-----------------------------------------------------------------
  //..Write out the input parameters
  B2INFO("eclLeakageCollector parameters: ");
  B2INFO("position_bins " << m_position_bins);
  B2INFO("number_energies " << m_number_energies);
  std::cout << "energies_forward ";
  for (int ie = 0; ie < m_number_energies; ie++) {std::cout << m_energies_forward[ie] << " ";}
  std::cout << std::endl;
  std::cout << "energies_barrel ";
  for (int ie = 0; ie < m_number_energies; ie++) {std::cout << m_energies_barrel[ie] << " ";}
  std::cout << std::endl;
  std::cout << "energies_backward ";
  for (int ie = 0; ie < m_number_energies; ie++) {std::cout << m_energies_backward[ie] << " ";}
  std::cout << std::endl;
  B2INFO("showerArrayName " << m_showerArrayName);
 
  //-----------------------------------------------------------------
  //..Define histogram to store parameters
  const int nBinX = 3 + nLeakReg * m_number_energies;
  auto inputParameters = new TH1F("inputParameters", "eclLeakageCollector job parameters", nBinX, 0, nBinX);
  registerObject<TH1F>("inputParameters", inputParameters);
 
  //..TTree stores required quantities for each photon
  auto tree = new TTree("single_photon_leakage", "");
  tree->Branch("cellID", &t_cellID, "cellID/I");
  tree->Branch("thetaID", &t_thetaID, "thetaID/I");
  tree->Branch("region", &t_region, "region/I");
  tree->Branch("thetaBin", &t_thetaBin, "thetaBin/I");
  tree->Branch("phiBin", &t_phiBin, "phiBin/I");
  tree->Branch("phiMech", &t_phiMech, "phiMech/I");
  tree->Branch("energyBin", &t_energyBin, "energyBin/I");
  tree->Branch("nCrys", &t_nCrys, "nCrys/I");
  tree->Branch("energyFrac", &t_energyFrac, "energyFrac/F");
  tree->Branch("origEnergyFrac", &t_origEnergyFrac, "origEnergyFrac/F");
  tree->Branch("locationError", &t_locationError, "locationError/F");
  registerObject<TTree>("tree", tree);
 
 
  //-----------------------------------------------------------------
  //..Class to find cellID and position within crystal from theta and phi
  std::cout << "creating leakagePosition object " << std::endl;
  leakagePosition = new ECLLeakagePosition();
 
  //-----------------------------------------------------------------
  //..Required arrays
  m_eclShowerArray.isRequired(m_showerArrayName);
  m_mcParticleArray.isRequired();
 
  //-----------------------------------------------------------------
  //..nOptimal payload. Get optimal number of crystals, and
  //  corresponding correction factors.
  m_nOptimal2D = m_eclNOptimal->getNOptimal();
  m_peakFracEnergy = m_eclNOptimal->getPeakFracEnergy();
  m_bias = m_eclNOptimal->getBias();
  m_logPeakEnergy = m_eclNOptimal->getLogPeakEnergy();
  m_groupNumber = m_eclNOptimal->getGroupNumber();
 
  //..Vectors of energy boundaries for each region
  std::vector<float> eBoundariesFwd = m_eclNOptimal->getUpperBoundariesFwd();
  std::vector<float> eBoundariesBrl = m_eclNOptimal->getUpperBoundariesBrl();
  std::vector<float> eBoundariesBwd = m_eclNOptimal->getUpperBoundariesBwd();
  m_nEnergyBins = eBoundariesBrl.size();
 
  //..Copy values to m_eBoundaries
  m_eBoundaries.resize(m_nLeakReg, std::vector<float>(m_nEnergyBins, 0.));
  for (int ie = 0; ie < m_nEnergyBins; ie++) {
    m_eBoundaries[0][ie] = eBoundariesFwd[ie];
    m_eBoundaries[1][ie] = eBoundariesBrl[ie];
    m_eBoundaries[2][ie] = eBoundariesBwd[ie];
    B2INFO(" nOptimal upper boundaries for energy point " << ie << " " << m_eBoundaries[0][ie] << " " << m_eBoundaries[1][ie] << " " <<
           m_eBoundaries[2][ie]);
  }
 
}
 
//-----------------------------------------------------------------
void eclLeakageCollectorModule::collect()
{
 
  //-----------------------------------------------------------------
  //..First time, store the job parameters
  if (storeCalib) {
    getObjectPtr<TH1F>("inputParameters")->Fill(0.01, m_position_bins);
    getObjectPtr<TH1F>("inputParameters")->Fill(1.01, m_number_energies);
    double firstBin = 2.01;
    for (int ie = 0; ie < m_number_energies; ie++) {
      getObjectPtr<TH1F>("inputParameters")->Fill(firstBin + ie, m_energies_forward[ie]);
    }
    firstBin += m_number_energies;
    for (int ie = 0; ie < m_number_energies; ie++) {
      getObjectPtr<TH1F>("inputParameters")->Fill(firstBin + ie, m_energies_barrel[ie]);
    }
    firstBin += m_number_energies;
    for (int ie = 0; ie < m_number_energies; ie++) {
      getObjectPtr<TH1F>("inputParameters")->Fill(firstBin + ie, m_energies_backward[ie]);
    }
 
    //..Keep track of how many times inputParameters was filled
    int lastBin = getObjectPtr<TH1F>("inputParameters")->GetNbinsX();
    getObjectPtr<TH1F>("inputParameters")->SetBinContent(lastBin, 1.);
    storeCalib = false;
  }
 
  //-----------------------------------------------------------------
  //..Generated MC particle. Should only be one entry, but check.
  const int nMC = m_mcParticleArray.getEntries();
  if (nMC != 1) {return;}
  double mcLabE = m_mcParticleArray[0]->getEnergy();
  ROOT::Math::XYZVector mcp3 = m_mcParticleArray[0]->getMomentum();
  ROOT::Math::XYZVector vertex = m_mcParticleArray[0]->getProductionVertex();
 
  //-----------------------------------------------------------------
  //..Find the ECLShower (should only be one when using trimmed data object)
  const int nShower = m_eclShowerArray.getEntries();
  double minAngle = 999.;
  int minShower = -1;
  for (int is = 0; is < nShower; is++) {
 
    //..Only interested in photon hypothesis showers
    if (m_eclShowerArray[is]->getHypothesisId() == ECLShower::c_nPhotons) {
 
      //..Make a position vector from theta, phi, and R
      ROOT::Math::XYZVector position;
      VectorUtil::setMagThetaPhi(
        position, m_eclShowerArray[is]->getR(),
        m_eclShowerArray[is]->getTheta(), m_eclShowerArray[is]->getPhi());
 
      //..Direction is difference between position and vertex
      ROOT::Math::XYZVector direction = ROOT::Math::XYZVector(position) - vertex;
 
      double angle = ROOT::Math::VectorUtil::Angle(direction, mcp3);
      if (angle < minAngle) {
        minAngle = angle;
        minShower = is;
      }
    }
  }
  if (minShower == -1) {return;}
 
  //-----------------------------------------------------------------
  //..Location of selected shower.
  const int maxECellId = m_eclShowerArray[minShower]->getCentralCellId();
  const float thetaLocation = m_eclShowerArray[minShower]->getTheta();
  const float phiLocation = m_eclShowerArray[minShower]->getPhi();
  std::vector<int> positionVector = leakagePosition->getLeakagePosition(maxECellId, thetaLocation, phiLocation, m_position_bins);
 
  //..TTree items
  t_cellID = positionVector[0];
  t_thetaID = positionVector[1];
  t_region = positionVector[2];
  t_thetaBin = positionVector[3];
  t_phiBin = positionVector[4];
  t_phiMech = positionVector[5];
 
  //-----------------------------------------------------------------
  //..Generated and reconstructed energy quantities
 
  //..Find the generated energy bin by requiring it be close enough to expected value
  const float genEnergyMeV = 1000.*mcLabE;
  const float tolerance = std::max(0.002 * genEnergyMeV, 1.0);
  t_energyBin = -1;
  for (int ie = 0; ie < m_number_energies; ie++) {
    if (std::abs(genEnergyMeV - i_energies[t_region][ie]) < tolerance) {
      t_energyBin = ie;
      break;
    }
  }
 
  //..Quit if the true energy is not equal to a generated one.
  //  This can happen if the cluster is reconstructed in the wrong region.
  if (t_energyBin == -1) {return;}
 
  //..Reconstructed energy after existing leakage correction, normalized to generated
  t_origEnergyFrac = m_eclShowerArray[minShower]->getEnergy() / mcLabE;
 
  //..Sum of nOptimal crystals (without leakage correction), when events were generated
  const double eRaw = m_eclShowerArray[minShower]->getEnergyRaw();
 
  //-----------------------------------------------------------------
  //..Find nOptimal from cellID and 3x3 energy found by ECLSplitterN1Module.
  //  Note that payload may have been updated since events were generated, so
  //  we need to redo the sum of energies of the nOptimal crystals.
  const int ig = m_groupNumber[maxECellId - 1];
  const double e3x3Orig = m_eclShowerArray[minShower]->getNOptimalEnergy();
  double e3x3 = e3x3Orig;
 
  //..Alternate e3x3, for samples produced before nOptimal was introduced
  const double eHighestCorr = m_eclShowerArray[minShower]->getEnergyHighestCrystal();
  const double correction = m_eclShowerArray[minShower]->getEnergy() / m_eclShowerArray[minShower]->getEnergyRaw();
  const double eHighestRaw = eHighestCorr / correction;
  const double e3x3Alt = eHighestRaw / m_eclShowerArray[minShower]->getE1oE9();
  if (e3x3 < 0.001) {e3x3 = e3x3Alt;}
 
  //..Need the detector region to get the energy bin boundaries
  int iRegion = 1; // barrel
  if (ECLElementNumbers::isForward(maxECellId)) {iRegion = 0;}
  if (ECLElementNumbers::isBackward(maxECellId)) {iRegion = 2;}
 
  //..nOptimal energy bin for this energy.
  int iEnergy = 0;
  while (e3x3 > m_eBoundaries[iRegion][iEnergy] and iEnergy < m_nEnergyBins - 1) {iEnergy++;}
 
  //..nOptimal
  t_nCrys = m_nOptimal2D.GetBinContent(ig + 1, iEnergy + 1);
 
  //-----------------------------------------------------------------
  //..Find the sum of the nOptimal most-energetic digits
 
  //..Get the ECLCalDigits and rank them by energy
  std::vector<double> digitEnergies;
  const auto showerDigitRelations = m_eclShowerArray[minShower]->getRelationsWith<ECLCalDigit>("ECLTrimmedDigits");
  unsigned int nRelatedDigits = showerDigitRelations.size();
  for (unsigned int ir = 0; ir < nRelatedDigits; ir++) {
    const auto calDigit = showerDigitRelations.object(ir);
    const auto weight = showerDigitRelations.weight(ir);
    digitEnergies.push_back(calDigit->getEnergy() * weight);
  }
 
  //..Rank from lowest to highest
  std::sort(digitEnergies.begin(), digitEnergies.end());
 
  //..Sum the highest nOptimal digit energies (if there are that many)
  double eSumOfN = 1.e-10; // cpp does not like 0
  for (int isum = 0; isum < t_nCrys; isum++) {
    const int i = (int)nRelatedDigits - 1 - isum;
    if (i >= 0) {eSumOfN +=  digitEnergies[i];}
  }
 
  //-----------------------------------------------------------------
  //..Correct the sum of nOptimal crystals for bias and nCrystal peak energy
  //  We need to do this because the nOptimal payload may have changed
  //  since the events were generated.
 
  //..To allow for energy interpolation, there are three bins per group and energy:
  //  iy = iEnergy + 1 in all three cases
  //  ix = 3*ig + 1 = value for nominal energy, i.e logPeakEnergy(3*ig+1, iEnergy+1)
  //  ix = 3*ig + 2 = value for lower energy, i.e logPeakEnergy(3*ig+2, iEnergy+1)
  //  ix = 3*ig + 3 = value for higher energy, i.e logPeakEnergy(3*ig+3, iEnergy+1)
  const int iy = iEnergy + 1;
 
  const int ixNom = 3 * ig + 1;
  const int ixLowerE = ixNom + 1;
  const int ixHigherE = ixNom + 2;
 
  const double logENom = m_logPeakEnergy.GetBinContent(ixNom, iy);
  const double logELower = m_logPeakEnergy.GetBinContent(ixLowerE, iy);
  const double logEHigher = m_logPeakEnergy.GetBinContent(ixHigherE, iy);
 
  const double biasNom = m_bias.GetBinContent(ixNom, iy);
  const double biasLower = m_bias.GetBinContent(ixLowerE, iy);
  const double biasHigher = m_bias.GetBinContent(ixHigherE, iy);
 
  const double peakNom = m_peakFracEnergy.GetBinContent(ixNom, iy);
  const double peakLower = m_peakFracEnergy.GetBinContent(ixLowerE, iy);
  const double peakHigher = m_peakFracEnergy.GetBinContent(ixHigherE, iy);
 
  //..Interpolate in log energy
  const double logESumN = log(eSumOfN);
 
  double logEOther = logELower;
  double biasOther = biasLower;
  double peakOther = peakLower;
  if (logESumN > logENom) {
    logEOther = logEHigher;
    biasOther = biasHigher;
    peakOther = peakHigher;
  }
 
  //..The nominal and "other" energies may be identical if this is the first or last energy
  double bias = biasNom;
  double peak = peakNom;
  if (std::abs(logEOther - logENom) > 0.0001) {
    bias = biasNom + (biasOther - biasNom) * (logESumN - logENom) / (logEOther - logENom);
    peak = peakNom + (peakOther - peakNom) * (logESumN - logENom) / (logEOther - logENom);
  }
 
  //..Normalized reconstructed energy after bias and nCrystal correction
  t_energyFrac = (eSumOfN - bias) / peak / mcLabE;
 
  //-----------------------------------------------------------------
  //..Distance between generated and reconstructed positions
  const double radius = m_eclShowerArray[minShower]->getR();
  ROOT::Math::XYZVector measuredLocation;
  VectorUtil::setMagThetaPhi(
    measuredLocation, radius, thetaLocation, phiLocation);
  ROOT::Math::XYZVector measuredDirection = ROOT::Math::XYZVector(measuredLocation) - vertex;
  t_locationError = radius * ROOT::Math::VectorUtil::Angle(measuredDirection, mcp3);
 
 
  //-----------------------------------------------------------------
  //..Debug: dump some events
  if (m_nDump < 100) {
    m_nDump++;
    B2INFO(" ");
    B2INFO("cellID " << t_cellID << " ig " << ig << " iEnergy " << iEnergy << " ie " << t_energyBin << " nOpt " << t_nCrys);
    B2INFO(" e3x3Orig " << e3x3Orig << " e3x3Alt " << e3x3Alt << " Eraw " << eRaw << " ESum " << eSumOfN << " eFrac " <<
           t_energyFrac);
    B2INFO(" 3 log E " << logELower << " " << logENom << " " << logEHigher << " log E " << logESumN);
    B2INFO(" 3 biases " << biasLower << " " << biasNom << " " << biasHigher << " bias " << bias);
    B2INFO(" 3 peaks " << peakLower << " " << peakNom << " " << peakHigher << " peak " << peak);
  }
 
  //-----------------------------------------------------------------
  //..Done
  getObjectPtr<TTree>("tree")->Fill();
}