software/JReconstruction/JMuonStart.cc

Go to the documentation of this file.

#include <string>
#include <iostream>
#include <iomanip>
#include <vector>
#include <set>
#include <map>
#include <algorithm>
#include <memory>

#include "km3net-dataformat/offline/Head.hh"
#include "km3net-dataformat/offline/Evt.hh"
#include "km3net-dataformat/definitions/fitparameters.hh"
#include "JDAQ/JDAQEventIO.hh"
#include "JDAQ/JDAQTimesliceIO.hh"
#include "JDAQ/JDAQSummarysliceIO.hh"

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

#include "JDynamics/JDynamics.hh"

#include "JTrigger/JHit.hh"
#include "JTrigger/JHitR1.hh"
#include "JTrigger/JBuildL0.hh"
#include "JTrigger/JTriggerParameters.hh"
#include "JTrigger/JTriggerToolkit.hh"

#include "JSupport/JSingleFileScanner.hh"
#include "JSupport/JParallelFileScanner.hh"
#include "JSupport/JFileRecorder.hh"
#include "JSupport/JSummaryFileRouter.hh"
#include "JSupport/JSupport.hh"
#include "JSupport/JMeta.hh"

#include "JFit/JLine1Z.hh"
#include "JFit/JEnergyRegressor.hh"
#include "JFit/JFitToolkit.hh"
#include "JFit/JNPEHit.hh"
#include "JFit/JMEstimator.hh"
#include "JFit/JModel.hh"

#include "JReconstruction/JEvt.hh"
#include "JReconstruction/JEvtToolkit.hh"
#include "JReconstruction/JMuonStartParameters_t.hh"
#include "JReconstruction/JStart.hh"

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

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

#include "JLang/JComparator.hh"
#include "JLang/JPredicate.hh"

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

namespace {

  using namespace JPP;
  using namespace KM3NETDAQ;

  /**
   * Get probability of given response in optical module due to random background.
   *
   * \param  module               module
   * \param  frame                summary frame
   * \param  R_Hz                 multiples rates [Hz]
   * \param  T_ns                 time window [ns]
   * \param  top                  list of indentifiers of PMTs with hit in given module
   * \return                      probability
   */
  inline double getProbability(const JModule&            module,
                               const JDAQSummaryFrame&   frame,
                               const JRateL1_t&          R_Hz,
                               const double              T_ns,
                               const std::multiset<int>& top)
  {
    using namespace std;
    using namespace JPP;
    using namespace KM3NETDAQ;

    size_t N = 0;         // number of active PMTs
    size_t M = 0;         // multiplicity
    double R = 0.0;       // total rate

    for (size_t i = 0; i != module.size(); ++i) {

      if (getDAQStatus(frame, module, i)            &&
          getPMTStatus(frame, module, i)            &&
          !module.getPMT(i).has(PMT_DISABLE)) {

        N += 1;
        M += top.count(i);
        R += frame.getRate(i);
      }
    }

    if (N > 0)
      return JFIT::getProbability(N, M, JK40Rates(R/N, R_Hz), T_ns);
    else
      return (M == 0 ? 1.0 : 0.0);
  }
}


/**
 * \file
 *
 * Program to determine start position of muon trajectory.
 * \author mdejong
 */
int main(int argc, char **argv)
{
  using namespace std;
  using namespace JPP;
  using namespace KM3NETDAQ;

  typedef JTYPELIST<JAllTypes_t, JFIT::JEvt>::typelist             typelist;
  typedef JParallelFileScanner< JTypeList<JDAQEvent, JFIT::JEvt> > JParallelFileScanner_t;
  typedef JParallelFileScanner_t::multi_pointer_type               multi_pointer_type;
  typedef JTYPELIST<JCOMPASS::JOrientation,
                    JACOUSTICS::JEvt>::typelist                    calibration_types;
  typedef JMultipleFileScanner<calibration_types>                  JCalibration_t;

  JParallelFileScanner_t   inputFile;
  JFileRecorder<typelist>  outputFile;
  JLimit_t&                numberOfEvents = inputFile.getLimit();
  string                   detectorFile;
  JCalibration_t           calibrationFile;
  double                   Tmax_s;
  string                   pdfFile;
  JMuonStartParameters_t   parameters;
  JK40Rates                rates_Hz;
  int                      debug;

  try { 

    JParser<> zap("Program to perform PDF fit of muon trajectory to data.");
    
    zap['f'] = make_field(inputFile);
    zap['o'] = make_field(outputFile)          = "start.root";
    zap['a'] = make_field(detectorFile);
    zap['+'] = make_field(calibrationFile)     = JPARSER::initialised();
    zap['T'] = make_field(Tmax_s)              = 100.0;
    zap['n'] = make_field(numberOfEvents)      = JLimit::max();
    zap['P'] = make_field(pdfFile);
    zap['@'] = make_field(parameters)          = JPARSER::initialised();
    zap['B'] = make_field(rates_Hz)            = KM3NET::getK40Rates();
    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);
  }


  getMechanics.load(detector.getID());

  unique_ptr<JDynamics> dynamics;

  try {

    dynamics.reset(new JDynamics(detector, Tmax_s));

    dynamics->load(calibrationFile);
  }
  catch(const exception& error) {
    if (!calibrationFile.empty()) {
      FATAL(error.what());
    }
  }

  const JModuleRouter router(dynamics ? dynamics->getDetector() : detector);

  JSummaryFileRouter  summary(inputFile, parameters.R_Hz);


  typedef JHitL0            hit_type;

  typedef vector<hit_type>  buffer_type;
  const JBuildL0<hit_type>  buildL0;
  

  typedef JRegressor<JEnergy>  JRegressor_t;

  JRegressor_t::debug = debug;
  JRegressor_t::T_ns.setRange(parameters.TMin_ns, parameters.TMax_ns);

  const JStart  start(parameters.Pmin1, parameters.Pmin2, parameters.Nmax2);

  JRegressor_t fit(pdfFile);

  if (fit.getRmax() < parameters.roadWidth_m) {
    parameters.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();

    const JDAQEvent*   tev = ps;
    const JFIT::JEvt*  in  = ps;

    summary.update(*tev);

     if (dynamics) { 
      dynamics->update(*tev);
    }

    // select start values

    JFIT::JEvt cp  = *in;
    JFIT::JEvt out;

    if (parameters.reprocess) {
      cp.select(JHistory::is_not_event(JMUONSTART));
    }

    cp.select(parameters.numberOfPrefits, qualitySorter);

    if (!cp.empty()) {
      cp.select(JHistory::is_event(cp.begin()->getHistory()));
    }


    buffer_type dataL0;

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


    for (JFIT::JEvt::iterator track = cp.begin(); track != cp.end(); ++track) {

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

      map<int, multiset<int> > top;

      for (buffer_type::const_iterator i = dataL0.begin(); i != dataL0.end(); ++i) {

        hit_type hit(*i);

        hit.rotate(R);

        if (match(hit)) {
          top[hit.getModuleID()].insert(hit.getPMTAddress());
        }
      }

      struct JHit_t {

        double getZ() const { return z; }
        double getP() const { return p; }

        double z;
        double p;
      };

      vector<JHit_t> data;

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

        if (summary.hasSummaryFrame(module->getID())) {

          const JDAQSummaryFrame& frame = summary.getSummaryFrame(module->getID());

          JPosition3D pos(module->getPosition());

          pos.transform(R, tz.getPosition());

          if (pos.getX() <= parameters.roadWidth_m) {

            const double z = pos.getZ()  -  pos.getX() / getTanThetaC();
            const double p = getProbability(*module, frame, rates_Hz.getMultiplesRates(), JRegressor_t::T_ns.getLength(), top[module->getID()]);

            data.push_back({ z, p });
          }
        }
      }


      double Zmin      = 0.0;     // relative start position [m]
      double Zmax      = 0.0;     // relative end   position [m]
      double npe       = 0.0;     // npe due to MIP up to barycenter of hits
      double npe_total = 0.0;     // npe due to MIP up to end of track

      if (!data.empty()) {

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

        vector<JHit_t>::const_iterator         track_start = start.find(data. begin(), data. end());
        vector<JHit_t>::const_reverse_iterator track_end   = start.find(data.rbegin(), data.rend());

        if (track_start != data. end()) { Zmin = track_start->getZ(); }
        if (track_end   != data.rend()) { Zmax = track_end  ->getZ(); }

        // additional features
        
        for (JDetector::const_iterator module = detector.begin(); module != detector.end(); ++module) {

          JPosition3D pos(module->getPosition());

          pos.transform(R, tz.getPosition());

          if (pos.getX() <= parameters.roadWidth_m) {

            const double z = pos.getZ()  -  pos.getX() / getTanThetaC();

            if (z >= Zmin && z <= Zmax) {

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

                const JDAQSummaryFrame& frame = summary.getSummaryFrame(module->getID());

                if (getDAQStatus(frame, *module, i)      &&
                    getPMTStatus(frame, *module, i)      &&
                    !module->getPMT(i).has(PMT_DISABLE)) {

                  JPMT pmt = module->getPMT(i);

                  pmt.transform(R, tz.getPosition());

                  const double ya = fit.getNPE(pmt, 0.0).getYA();
            
                  npe_total += ya;

                  if (pmt.getZ() <= 0.0) {
                    npe += ya;
                  }
                }
              }
            }
          }
        }
      }
        
      // move track
        
      track->move(Zmin, getSpeedOfLight());
        
      out.push_back(JFIT::JFit(*track).add(JMUONSTART));
        
      out.rbegin()->setW(track->getW());
      out.rbegin()->setW(JSTART_NPE_MIP,       npe);
      out.rbegin()->setW(JSTART_NPE_MIP_TOTAL, npe_total);
      out.rbegin()->setW(JSTART_LENGTH_METRES, Zmax - Zmin);
    }
 
    if (dynamics) { 

      const JDynamics::coverage_type coverage = dynamics->getCoverage();

      for (JFIT::JEvt::iterator i = out.begin(); i != out.end(); ++i) {
        i->setW(JPP_COVERAGE_ORIENTATION, coverage.orientation);
        i->setW(JPP_COVERAGE_POSITION,    coverage.position);
      }
    }

    // apply default sorter
      
    sort(out.begin(), out.end(), qualitySorter);

    copy(in->begin(), in->end(), back_inserter(out));

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

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

  io >> outputFile;

  outputFile.close();
}