RunAnalyzer.hh

Go to the documentation of this file.

#ifndef __NEWRUNANALYZER__
#define __NEWRUNANALYZER__

#include "JSupport/JSupport.hh"
#include "JSupport/JSupportToolkit.hh"
#include "JSupport/JMultipleFileScanner.hh"

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


#include "JGizmo/JManager.hh"


#include "JTools/JQuantile.hh"
#include "TFile.h"
#include "TH1D.h"

#include "JRunHistograms.hh"

using namespace std ;

using namespace KM3NETDAQ ;
using namespace JDETECTOR ;
using namespace JLANG ;   
using namespace JPP ;

/**
 * \author rgruiz
 */


/**
 * Class dedicated to the analysis of KM3NeT runs. 
 *
 */
class RunAnalyzer {

  string inputfile ;
  
  JDetector detector ;

  JModuleRouter* module_router ;

  JModuleLocation default_module_location ;

  JRA_Histograms histograms ;
  
  std::set<int> DU_IDs ;

  int modules_per_string ;

public :

  /**
   * Default constructor.
   */
  RunAnalyzer(){}



  /**
   * Constructor.
   *
   * \param file Path to the file to be analyzed
   * \param detector_file path to a detector file
   */
  RunAnalyzer (string file , string detector_file):

    inputfile (file),

    module_router (NULL)

  {
    
    try {
      
      load (detector_file, detector);
      
    }
    
    catch(const JException & error) {
      
      cerr << "FATAL ERROR. Could not open detector file '" << detector_file << "'." << endl ;
      
      exit(1) ;
      
    }
    
    histograms = JRA_Histograms (detector) ;
    
    module_router = new JModuleRouter(detector) ;

    DU_IDs = getStringIDs(detector) ;

    modules_per_string = JDETECTOR::getNumberOfModules (detector) / getNumberOfStrings (detector) ;

  } 



  /**
   * Destructor.
   */
  ~RunAnalyzer(){

  }



  /*
   * Function template used to read time ordered events from a tree.
   *
   * \param scanner A JTreeScanner
   */
  void iterate_daqevent_tree (JTreeScanner < JDAQEvent , JDAQEvaluator > & scanner , JFrameIndexRange frame_index_range){
 
    while (scanner.hasNext()){

      JDAQEvent event = *(scanner.next()) ;

      int starting_frame_index = event.getFrameIndex () ;

      histograms.h_trigger.h_Snapshot_hits -> Fill((Double_t) event.size<JDAQSnapshotHit> ()) ;
      
      histograms.h_trigger.h_Triggered_hits -> Fill((Double_t) event.size<JDAQTriggeredHit> ()) ;
      
      for (unsigned int i = 0; i != NUMBER_OF_TRIGGER_BITS; ++i) {

        if (event.hasTriggerBit(i)) {

          histograms.h_trigger.h_Trigger_bit_event->Fill((Double_t) i);

          (*histograms.h_trigger.m_trigger_rates)[getTriggerName(i)] -> Fill (starting_frame_index - frame_index_range.first) ;
          
        }

      }

      histograms.h_trigger.h_n_triggered_hits_distribution -> Fill (event.size<JDAQTriggeredHit>()) ;
      
      for (JDAQEvent::const_iterator<JDAQTriggeredHit> hit = event.begin<JDAQTriggeredHit>(); hit != event.end<JDAQTriggeredHit>(); ++hit) {
    
        histograms.h_trigger.h_pmt_distribution_triggered_hits -> Fill (hit -> getPMT()) ;
        
        histograms.h_trigger.h_tot_distribution_triggered_hits -> Fill (hit -> getToT()) ;

        int String = module_router -> getModule (hit -> getModuleID()).getString() ;

        int Floor = module_router -> getModule (hit -> getModuleID()).getFloor() ;

        (*histograms.h_trigger.m_Trigger_map)[MAKE_STRING("Detector/DU" + to_string(String))] -> Fill (starting_frame_index , Floor) ;

        histograms.h_trigger.h_Triggered_hits_per_module -> Fill (String , Floor) ;
        
        for (unsigned int i = 0; i != NUMBER_OF_TRIGGER_BITS; ++i) {
          
          if (hit -> hasTriggerBit(i)) {

            histograms.h_trigger.h_Trigger_bit_hit->Fill((Double_t) i);

          }

        }

      }

      for (JDAQEvent::const_iterator<JDAQSnapshotHit> hit = event.begin<JDAQSnapshotHit>() ; hit != event.end<JDAQSnapshotHit>() ; ++hit){

        int String = module_router -> getModule (hit -> getModuleID()).getString() ;

        int Floor = module_router -> getModule (hit -> getModuleID()).getFloor() ;

        int pmt = hit -> getPMT() ;

        histograms.h_trigger.h_Snapshot_hits_per_module -> Fill (String , Floor) ;

        (*histograms.h_trigger.m_Snapshot_hits_per_pmt)[MAKE_STRING("Detector/DU" + to_string(String))] -> Fill (pmt , Floor) ;

        histograms.h_trigger.h_pmt_distribution_snapshot_hits -> Fill (hit -> getPMT()) ;
        
        histograms.h_trigger.h_tot_distribution_snapshot_hits -> Fill (hit -> getToT()) ;
        
      }
      
    }

  }


   /*
   * Function template to read and process time ordered summary slices.
   * 
   * \param scanner A JTreeScanner from which time ordered summary slices are accessed. 
   * \param frame_index_range the range of the indices of the frames to be accessed.
   */
  void iterate_summaryslice_tree (JTreeScanner < JDAQSummaryslice , JDAQEvaluator > & scanner , JFrameIndexRange frame_index_range ){

    std::map < int , vector < vector < JQuantile > > > PMT_rate_quantiles ;
    
    std::map < int , vector <JQuantile> > DOM_rate_quantiles;
    
    while (scanner.hasNext()){

      JDAQSummaryslice slice = *(scanner.next()) ;

      double time_since_run_start = (slice.getFrameIndex() - frame_index_range.first) * getFrameTime() * 1.0e-9 ;
      
      JQuantile HRV_quantile ;
      
      JQuantile FIFO_quantile ;

      for (JDAQSummaryslice::const_iterator s_frame = slice.begin() ; s_frame != slice.end() ; ++ s_frame){
        
        PMT_rate_quantiles[module_router -> getModule (s_frame->getModuleID()).getString()].resize(modules_per_string , vector < JQuantile > (NUMBER_OF_PMTS)) ; 

        JDAQFrameStatus status = s_frame -> getDAQFrameStatus() ;
        
        int nFIFOcount = status.countFIFOStatus() ;

        int nHRVcount = status.countHighRateVeto() ;

        HRV_quantile.put ( nHRVcount ) ;

        FIFO_quantile.put ( nFIFOcount ) ;

        int string = module_router -> getModule (s_frame->getModuleID()).getString() ;

        int floor = module_router -> getModule (s_frame->getModuleID()).getFloor() ;

        if ( nHRVcount > 0 ){

          histograms.h_summary.h_hrv_per_dom -> Fill (module_router -> getModule (s_frame->getModuleID()).getString() , module_router -> getModule (s_frame->getModuleID()).getFloor() ) ;

        }
        
        if (status.testDAQStatus() == false){

          histograms.h_summary.h_daq_status -> Fill(slice.getFrameIndex() - frame_index_range.first) ;
          
          histograms.h_summary.h_daq_status_per_dom -> Fill(module_router -> getModule (s_frame->getModuleID()).getString() , module_router -> getModule (s_frame->getModuleID()).getFloor()) ;
          
        }
        
        histograms.h_summary.h_fifo_per_dom -> Fill (module_router -> getModule (s_frame->getModuleID()).getString() , module_router -> getModule (s_frame->getModuleID()).getFloor() , nFIFOcount ) ; 

        double rate = 0 ;
        
        for (int i = 0 ; i < NUMBER_OF_PMTS ; i++){

          (*histograms.h_summary.m_summary_rate_vs_time)[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill(time_since_run_start , i , s_frame -> getRate(i)) ;
          
          (*histograms.h_summary.m_summary_rate_distribution)[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill(s_frame -> getRate(i) * 1e-3 , i) ;

          (*histograms.h_summary.m_fifo_full)[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill(time_since_run_start , i , status.testFIFOStatus(i)) ;

          (*histograms.h_summary.m_hrv)[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill(time_since_run_start , i , status.testHighRateVeto(i)) ;

          rate += s_frame -> getRate(i) ;

          histograms.h_summary.h_pmt_rate_distribution -> Fill (s_frame -> getRate(i) * 1e-3) ;

          PMT_rate_quantiles[module_router -> getModule (s_frame->getModuleID()).getString()][module_router -> getModule (s_frame->getModuleID()).getFloor()-1][i].put(s_frame ->getRate(i) * 1e-3) ; 

        }

        DOM_rate_quantiles[module_router -> getModule (s_frame->getModuleID()).getString()].resize(modules_per_string) ;

        DOM_rate_quantiles[module_router -> getModule (s_frame->getModuleID()).getString()][module_router -> getModule (s_frame->getModuleID()).getFloor()-1].put(rate * 1e-3) ;
        
        (*histograms.h_summary.m_module_rates_vs_time)[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill(time_since_run_start , rate ) ;
        
      }
      
      histograms.h_summary.h_fifo -> Fill ( slice.getFrameIndex() - frame_index_range.first , FIFO_quantile.getMean() ) ;
      
      histograms.h_summary.h_hrv -> Fill ( slice.getFrameIndex() - frame_index_range.first , HRV_quantile.getMean() ) ;

    }
    
    for (std::map<int , vector<JQuantile> >::const_iterator i = DOM_rate_quantiles.begin() ; i!= DOM_rate_quantiles.end() ; ++i){
      
      for (int j=1 ; j < modules_per_string + 1 ; j++){
      
        if (i -> second[j-1].getCount() > 0) histograms.h_summary.h_rate_summary ->Fill (i -> first , j , i -> second[j-1].getMean() ) ;
        
      }
                                        
    }
    
    for (std::map<int , vector < vector<JQuantile> > >::const_iterator i = PMT_rate_quantiles.begin() ; i!= PMT_rate_quantiles.end() ; ++i){
    
      for (int j = 0 ; j < modules_per_string ; j++){
      
        for (int k = 0 ; k < NUMBER_OF_PMTS ; k++){

          if (i -> second[j][k].getCount() > 0){

            (*histograms.h_summary.m_mean_summary_rate)[MAKE_STRING("Detector/DU" + to_string(i->first))] -> Fill(k , j+1 , i -> second[j][k].getMean()) ;
          
          }

        }
        
      }
    
    }

  }

  
  
  /*
   * Checks through the use of a JTreeScanner, if summary slices are present in the run file.
   * In case they are, the corresponding tree is iterated. 
   *
   */
  void read_summaryslices_from_file (){

    JFrameIndexRange range ;

    JTreeScanner < JDAQSummaryslice , JDAQEvaluator > scanner(inputfile) ;

    if( scanner.hasNext() ){
      
      range = JFrameIndexRange (scanner.begin()->getFrameIndex() , scanner.rbegin()->getFrameIndex()) ;

      histograms.initialize_summary_histograms (range) ;
      
      scanner.rewind () ;

      iterate_summaryslice_tree (scanner , range) ;

    }

  }


  
  /*
   * Function template to read and process time ordered timeslices.
   * 
   * \param scanner A JTreeScanner from which time ordered timeslices are accessed. 
   * \param frame_index_range the range of the indices of the frames to be accessed.
   */
  template <class T>
  void iterate_timeslice_tree (JTreeScanner < T , JDAQEvaluator > & scanner , JFrameIndexRange frame_index_range){

    int ts_type = JIndexOf<JDAQTimesliceTypes_t , T>::value ;
    
    std::map < int , std::map <int , JQuantile> > DOM_rate_quantiles ;

    while (scanner.hasNext()){

      T slice = *(scanner.next()) ;

      double time_since_run_start = (slice.getFrameIndex() - frame_index_range.first) * getFrameTime() * 1.0e-9 ;

      JQuantile detector_rate_quantile ;

      std::map < int , JQuantile > active_DOM_DU_quantiles ;
      
      JQuantile active_DOM_quantile ;

      for(auto & s_frame : slice){
          
        JModule module = module_router -> getModule (s_frame.getModuleID()) ;

        double rate = s_frame.numberOfHits / (1.0e-9 * getFrameTime()) ;

        int string = module.getString() ;

        int floor = module.getFloor() ;

        DOM_rate_quantiles[string][floor].put(rate) ;
    
        detector_rate_quantile.put (rate) ;

        (*histograms.h_timeslice.m_module_rates_vs_time[ts_type])[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill(time_since_run_start , rate ) ;
            
        if ( rate > 0 ) {

          active_DOM_quantile.put ( 1 ) ;

          active_DOM_DU_quantiles [string].put(1) ;
      
        }       

        std::map <int , vector < double > > hit_time_buffers ; 

        std::map < int , JQuantile > tot_quantiles ;

        std::vector < JQuantile > pmt_rate_quantiles ;

        pmt_rate_quantiles.resize(NUMBER_OF_PMTS);
        
        for (JDAQSuperFrame::const_iterator hit = s_frame.begin() ; hit != s_frame.end() ; ++hit){

          (*histograms.h_timeslice.m_pmt_tot_distributions[ts_type])[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor) + "/" + to_string(s_frame.getModuleID()))] -> Fill(hit->getPMT() , hit->getToT()) ;

          hit_time_buffers[hit->getPMT()].push_back (hit->getT()) ;

          tot_quantiles[hit->getPMT()].put (hit->getToT()) ;

          pmt_rate_quantiles[hit->getPMT()].put (1) ;
          
          if (hit->getToT() == 255) {

            (*histograms.h_timeslice.m_ToT_255[ts_type])[MAKE_STRING("Detector/DU" + to_string(string))] -> Fill(floor , hit->getPMT()) ;

            histograms.h_timeslice.h_ToT_255_vs_time[ts_type] -> Fill(hit -> getT()) ;

            histograms.h_timeslice.h_ToT_255_Floor_vs_time[ts_type] -> Fill(hit -> getT() , floor) ;
            
            histograms.h_timeslice.h_ToT_255_Floor_vs_time_2[ts_type] -> Fill(hit -> getT() , floor) ;
            
          }

        }

        for (std::vector<JQuantile>::const_iterator pmt = pmt_rate_quantiles.begin() ; pmt != pmt_rate_quantiles.end() ; pmt++){

          (*histograms.h_timeslice.m_pmt_rates_vs_time[ts_type])[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill(time_since_run_start , pmt - pmt_rate_quantiles.begin() , pmt->getCount()/getFrameTime()/1.0e-9 ) ;

        }
        
        for(std::map<int,JQuantile>::const_iterator pmt = tot_quantiles.begin() ; pmt != tot_quantiles.end() ; pmt++){

          if (pmt->second.getCount() > 0){
            
            (*histograms.h_timeslice.m_pmt_rate_distributions[ts_type])[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill(1e-3 * pmt->second.getCount()/getFrameTime()/1.0e-9 , pmt->first ) ;
          
            (*histograms.h_timeslice.m_pmt_tot_vs_time[ts_type])[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill (time_since_run_start , pmt->first , pmt->second.getMean() ) ;

          }
            
          for (int i=1 ; i < (int)hit_time_buffers[pmt->first].size() ; i++){
                      
            (*histograms.h_timeslice.m_pmt_dt_consecutive_hits[ts_type])[MAKE_STRING("Detector/DU" + to_string(string) + "/F" + to_string(floor))] -> Fill ( log10(hit_time_buffers[pmt->first][i] - hit_time_buffers[pmt->first][i-1]) , pmt->first) ;
              
          }
          
        }
        
      }
      
      histograms.h_timeslice.h_rate[ts_type] -> Fill ( slice.getFrameIndex() - frame_index_range.first , detector_rate_quantile.getMean() ) ;

      histograms.h_timeslice.h_slice_start_time[ts_type] -> Fill ( slice.getFrameIndex() - frame_index_range.first , time_since_run_start ) ;

      histograms.h_timeslice.h_active_modules[ts_type] -> Fill ( slice.getFrameIndex() - frame_index_range.first , double(active_DOM_quantile.getCount()) / JDETECTOR::getNumberOfModules (detector) ) ;

      for ( std::map <int , JQuantile>::const_iterator i = active_DOM_DU_quantiles.begin() ; i != active_DOM_DU_quantiles.end() ; i++){
      
        histograms.h_timeslice.h_du_active_modules[ts_type] -> Fill(slice.getFrameIndex() - frame_index_range.first , i->first , i->second.getCount() ) ;

      }

    }

    for (std::map< int , std::map<int,JQuantile>>::const_iterator i = DOM_rate_quantiles.begin() ; i != DOM_rate_quantiles.end() ; i++){

      for (std::map<int , JQuantile>::const_iterator j = i->second.begin() ; j != i->second.end() ; j++){

        if (j->second.getCount() > 0) histograms.h_timeslice.h_dom_mean_rates[ts_type] -> Fill (i->first , j->first , j->second.getMean() ) ;

      }

    }
    
  }

  /*
   * Function template that checks through the use of a JTreeScanner, if objects of different timeslice classes are present in the run file.
   * In case they are, the corresponding tree is iterated. 
   *
   */
  template <class T>
  void read_timeslices_from_file (){

    JFrameIndexRange range ;

    JTreeScanner < T , JDAQEvaluator > scanner(inputfile) ;

    if( scanner.hasNext() ){

      range = JFrameIndexRange (scanner.begin()->getFrameIndex() , scanner.rbegin()->getFrameIndex()) ;

      histograms.initialize_timeslice_histograms < T > (range) ;
      
      scanner.rewind () ;
      
      iterate_timeslice_tree (scanner , range) ;

    }

  }


  
  /*
   * Function template that checks through the use of a JTreeScanner, if JDAQEvent objects are present in the run file.
   * In case they are, the corresponding tree is read. 
   *
   */
  void read_daqevents_from_file (){

    JFrameIndexRange range ;
    
    JTreeScanner < JDAQEvent , JDAQEvaluator > scanner(inputfile) ;

    if( scanner.hasNext() ){

      range = JFrameIndexRange (scanner.begin()->getFrameIndex() , scanner.rbegin()->getFrameIndex()) ;
      
      histograms.initialize_trigger_histograms (range) ;

      scanner.rewind() ;
      
      iterate_daqevent_tree (scanner , range) ;

    }

  }

  /*
   * Returns the histograms produced from the data in the file.
   */
  JRA_Histograms getHistograms(){

    return histograms ;

  }

  
};

#endif