JEnergy.cc

Go to the documentation of this file.

#include <string>
#include <iostream>
#include <iomanip>
#include <vector>
#include <set>
#include <algorithm>
#include <limits>

#include "TMath.h"

#include "evt/Head.hh"
#include "evt/Evt.hh"
#include "JDAQ/JDAQEvent.hh"
#include "JDAQ/JDAQTimeslice.hh"
#include "JDAQ/JDAQSummaryslice.hh"

#include "JDetector/JDetector.hh"
#include "JDetector/JDetectorSubset.hh"
#include "JDetector/JDetectorToolkit.hh"
#include "JDetector/JModuleRouter.hh"
#include "JDetector/JK40Rates.hh"

#include "JTrigger/JHit.hh"
#include "JTrigger/JFrame.hh"
#include "JTrigger/JTimeslice.hh"
#include "JTrigger/JHitL0.hh"
#include "JTrigger/JHitR1.hh"
#include "JTrigger/JBuildL0.hh"
#include "JTrigger/JTriggerParameters.hh"

#include "JSupport/JMultipleFileScanner.hh"
#include "JSupport/JParallelFileScanner.hh"
#include "JSupport/JFileRecorder.hh"
#include "JSupport/JSupport.hh"
#include "JSupport/JMeta.hh"

#include "JFit/JLine1Z.hh"
#include "JFit/JEnergy.hh"
#include "JFit/JEnergyRegressor.hh"
#include "JFit/JFitToolkit.hh"
#include "JFit/JFitParameters.hh"
#include "JFit/JEvt.hh"
#include "JFit/JEvtToolkit.hh"
#include "JFit/JEnergyCorrection.hh"
#include "JFit/JNPEHit.hh"
#include "JFit/JStart.hh"
#include "JFit/JMEstimator.hh"
#include "JFit/JTimeRange.hh"
#include "JFit/JModel.hh"

#include "JTools/JConstants.hh"
#include "JTools/JFunction1D_t.hh"
#include "JTools/JFunctionalMap_t.hh"

#include "JPhysics/JPDFTable.hh"
#include "JPhysics/JPDFToolkit.hh"
#include "JPhysics/JNPETable.hh"

#include "JLang/JComparator.hh"

#include "Jeep/JParser.hh"
#include "Jeep/JMessage.hh"


namespace {

  using namespace JPP;
  
  
  /**
   * Auxiliary class for energy estimation.
   */
  struct JResult {
    /**
     * Constructor.
     *
     * \param  x               Energy [log(E/GeV)]
     * \param  chi2            chi2  
     */
    JResult(const JEnergy& x    = 0.0,
            const double   chi2 = std::numeric_limits<double>::max())
    {
      this->x    = x;
      this->chi2 = chi2;
    }

    
    /**
     * Type conversion.
     *
     * \return                 true if valid chi2; else false
     */
    operator bool() const
    {
      return chi2 != std::numeric_limits<double>::max();
    }
    
    JEnergy x;      //!< Energy
    double  chi2;   //!< chi2
  };

  
  /**
   * Type definition of energy range.
   */
  typedef JTOOLS::JRange<JEnergy>     JEnergyRange;


  /**
   * Definition of the various M-Estimators available to use
   */
  enum JMEstimator_t {
    EM_NORMAL      = 0,
    EM_LORENTZIAN  = 1,
    EM_LINEAR      = 2,
    EM_NULL        = 3
  };
}


/**
 * \file
 *
 * Program to perform JFIT::JRegressor<JEnergy, JGandalf> fit using I/O of JFIT::JEvt data.
 * \author mdejong
 */
int main(int argc, char **argv)
{
  using namespace std;
  using namespace JPP;
  using namespace KM3NETDAQ;

  typedef JParallelFileScanner< JTypeList<JDAQEvent, JEvt> >       JParallelFileScanner_t;
  typedef JParallelFileScanner_t::multi_pointer_type               multi_pointer_type;
  typedef JTYPELIST<JAllTypes_t, JEvt>::typelist                   typelist;

  JParallelFileScanner_t  inputFile;
  JFileRecorder<typelist> outputFile;
  JLimit_t&         numberOfEvents = inputFile.getLimit();
  string            detectorFile;
  string            pdfFile;
  double            roadWidth_m;
  JTimeRange        T_ns;
  JK40Rates         rates_Hz;
  size_t            numberOfPrefits;
  JEnergyCorrection correct;
  JEnergyRange      X;
  JStart            start;  
  bool              reprocess;
  int               mestimator;
  int               debug;

  try { 

    JParser<> zap("Program to perform fit of muon energy to data.");
    
    zap['f'] = make_field(inputFile);
    zap['o'] = make_field(outputFile)          = "energy.root";
    zap['a'] = make_field(detectorFile);
    zap['n'] = make_field(numberOfEvents)      = JLimit::max();
    zap['P'] = make_field(pdfFile);
    zap['R'] = make_field(roadWidth_m)         = numeric_limits<double>::max();
    zap['T'] = make_field(T_ns)                = JTimeRange(-50.0, +450.0);      // ns
    zap['B'] = make_field(rates_Hz)            = JK40Rates::getInstance();
    zap['N'] = make_field(numberOfPrefits)     = 1;
    zap['E'] = make_field(correct)             = JEnergyCorrection();            // off
    zap['x'] = make_field(X)                   = JEnergyRange(1.0, 8.0);         // log10(E/GeV)
    zap['s'] = make_field(start)               = JStart();                       // off
    zap['r'] = make_field(reprocess);
    zap['M'] = make_field(mestimator)          = EM_NORMAL, EM_LORENTZIAN, EM_LINEAR, EM_NULL;
    zap['d'] = make_field(debug)               = 1;
    
    zap(argc, argv);
  }
  catch(const exception& error) {
    FATAL(error.what() << endl);
  }



  cout.tie(&cerr);


  JDetector detector;

  try {
    load(detectorFile, detector);
  }
  catch(const JException& error) {
    FATAL(error);
  }

  const JModuleRouter moduleRouter(detector);

  typedef vector<JHitL0>  JDataL0_t;
  const JBuildL0<JHitL0>  buildL0;
  

  typedef JRegressor<JEnergy>      JRegressor_t;

  JRegressor_t::debug = debug;
  JRegressor_t::T_ns  = T_ns;

  const JEnergy ENERGY_RESOLUTION(0.01);         // Energy resolution log10(E/GeV)

  
  JRegressor_t fit(pdfFile);

  switch (mestimator) {

  case EM_NORMAL:
    NOTICE("Using the normal M-Estimator." << endl);
    fit.estimator.reset(new JMEstimatorNormal());
    break;

  case EM_LORENTZIAN:
    NOTICE("Using the Lorentzian M-Estimator." << endl);
    fit.estimator.reset(new JMEstimatorLorentzian());
    break;

  case EM_LINEAR:
    NOTICE("Using the linear M-Estimator." << endl);
    fit.estimator.reset(new JMEstimatorNormal());
    break;

  case EM_NULL:
    NOTICE("Using the JEnergy likelihood directly." << endl);
    fit.estimator.reset(new JMEstimatorNull());
    break;

  default:
    FATAL("Invalid M-Estimator." << endl);
  }


  if (fit.getRmax() < roadWidth_m) {
    roadWidth_m = fit.getRmax();
  }


  outputFile.open();

  outputFile.put(JMeta(argc, argv));

  while (inputFile.hasNext()) {

    STATUS("event: " << setw(10) << inputFile.getCounter() << '\r'); DEBUG(endl);

    multi_pointer_type ps = inputFile.next();

    JDAQEvent* tev = ps;
    JEvt*      evt = ps;
    JEvt       out;

    JEvt::iterator __end = evt->end();

    if (reprocess) {
      __end = partition(evt->begin(), __end, JHistory::is_not_event(JMUONENERGY));
    }

    if (evt->begin() != __end) {

      copy(evt->begin(), __end, back_inserter(out));
    
      if (numberOfPrefits > 0) {
        advance(__end = evt->begin(), min(numberOfPrefits, out.size()));
      }

      partial_sort(evt->begin(), __end, evt->end(), qualitySorter);
      
      __end = partition(evt->begin(), __end, JHistory::is_event(evt->begin()->getHistory()));


      JDataL0_t dataL0;

      buildL0(*tev, moduleRouter, true, back_inserter(dataL0));

      
      for (JEvt::const_iterator track = evt->begin(); track != __end; ++track) {

        const JRotation3D     R (getDirection(*track));
        const JLine1Z         tz(getPosition (*track).rotate(R), track->getT());
        const JModel<JLine1Z> match(tz, roadWidth_m, JRegressor_t::T_ns);
        

        multiset<JDAQPMTIdentifier> top;
        
        for (JDataL0_t::const_iterator i = dataL0.begin(); i != dataL0.end(); ++i) {
            
          JHitR1 hit(*i);

          hit.rotate(R);

          if (match(hit)) {
            top.insert(i->getPMTIdentifier());
          }
        }

        
        vector<JNPEHit> data;
        vector<JNPEHit> buffer;

        const JDetectorSubset_t subdetector(detector, getAxis(*track), roadWidth_m);

        for (JDetector::const_iterator module = subdetector.begin(); module != subdetector.end(); ++module) {

          size_t total = 0;
          
          for (size_t i = 0; i != module->size(); ++i) {

            size_t count = top.count(JDAQPMTIdentifier(module->getID(), i));
            
            data.push_back(JNPEHit(fit.getNPE(module->getPMT(i), rates_Hz.getSinglesRate()), count));

            total += count;
          }

          if (total != 0) {
            buffer.push_back(JNPEHit(fit.getNPE(*module, rates_Hz), total));
          }
        }
        
        // start position of track

        vector<JNPEHit>::iterator __begin = data.begin();

        if (start.is_valid() && !buffer.empty()) {

          sort(buffer.begin(), buffer.end(), make_comparator(&JNPEHit::getZ));
          
          vector<JNPEHit>::const_iterator track_start = start.find(buffer.begin(), buffer.end());
          
          if (track_start != buffer.end()) {

            sort(data.begin(), data.end(), make_comparator(&JNPEHit::getZ));

            __begin = lower_bound(data.begin(), data.end(), track_start->getZ(), make_comparator(&JNPEHit::getZ));
          }
        }

        
        const int NDF = distance(__begin, data.end()) - 1;

        if (NDF >= 0) {


          // 5-point search between given limits

          const int      N  =  5;

          JResult result[N];

          for (int i = 0; i != N; ++i) {
            result[i].x = X.getLowerLimit() + i * (X.getUpperLimit() - X.getLowerLimit()) / (N-1);
          }
          
          do {

            int j = 0;

            for (int i = 0; i != N; ++i) {

              if (!result[i]) {
                result[i].chi2 = fit(result[i].x, __begin, data.end());
              }

              if (result[i].chi2 < result[j].chi2) {
                j = i;
              }
            }

            // squeeze range

            switch (j) {

            case 0:
              result[4] = result[1];
              result[2] = JResult(0.5 * (result[0].x + result[4].x));
              break;

            case 1:
              result[4] = result[2];
              result[2] = result[1];
              break;

            case 2:
              result[0] = result[1];
              result[4] = result[3];
              break;

            case 3:
              result[0] = result[2];
              result[2] = result[3];
              break;

            case 4:
              result[0] = result[3];
              result[2] = JResult(0.5 * (result[0].x + result[4].x));
              break;
            }

            result[1] = JResult(0.5 * (result[0].x + result[2].x));
            result[3] = JResult(0.5 * (result[2].x + result[4].x));

          } while (result[4].x - result[0].x > ENERGY_RESOLUTION);


          if (result[1].chi2 != result[3].chi2) {

            result[2].x    += 0.25 * (result[3].x - result[1].x) * (result[1].chi2 - result[3].chi2) / (result[1].chi2 + result[3].chi2 - 2*result[2].chi2);
            result[2].chi2  = fit(result[2].x, __begin, data.end());
          }
          
          const double chi2 = result[2].chi2;
          const double E    = result[2].x.getE();

          // Calculate additional variables
          const double muRange = JPHYSICS::gWater(E); // The range of a muon with the reconstructed energy

          double noise_likelihood = 0.0;              // The log likelihood of every hit being from K40
          int    nhits            = 0;                // The number of hits selected for JEnergy

          for (vector<JNPEHit>::const_iterator dom = data.begin(); dom != data.end(); ++dom) {

            noise_likelihood += log10(dom->getP());   // The probability of getting the observed multiplicity with K40
            nhits += dom->getN();                     // DOM multiplicity
          }


          out.push_back(JFit(*track).add(JMUONENERGY));

          // set corrected energy

          out.rbegin()->setE(correct(E));

          // set additional values          

          out.rbegin()->setW(JENERGY_ENERGY,            E);
          out.rbegin()->setW(JENERGY_CHI2,              chi2);
          out.rbegin()->setW(JENERGY_MUON_RANGE_METRES, muRange);
          out.rbegin()->setW(JENERGY_NOISE_LIKELIHOOD,  noise_likelihood);
          out.rbegin()->setW(JENERGY_NDF,               NDF);
          out.rbegin()->setW(JENERGY_NUMBER_OF_HITS,    nhits);
        }
      }
 
      // apply default sorter

      sort(out.begin(), out.end(), qualitySorter);
    }

    outputFile.put(out);
  }
  STATUS(endl);

  JSingleFileScanner<JRemove<typelist, JEvt>::typelist> io(inputFile);

  io >> outputFile;

  outputFile.close();
}