JSupportToolkit.hh

Go to the documentation of this file.

#ifndef __JSUPPORT__JSUPPORTTOOLKIT__
#define __JSUPPORT__JSUPPORTTOOLKIT__

#include <string>
#include <vector>

#include "TDirectory.h"

#include "JDAQ/JDAQClock.hh"
#include "JDAQ/JDAQEvaluator.hh"
#include "JDAQ/JDAQSummaryslice.hh"
#include "JTrigger/JTriggerParameters.hh"
#include "JTools/JRange.hh"
#include "JSupport/JFilenameSupportkit.hh"
#include "JSupport/JFileScanner.hh"
#include "JSupport/JTreeScanner.hh"
#include "JSupport/JTriggerParametersSupportkit.hh"


/**
 * \file
 * Support methods.
 * \author mdejong
 */
namespace JSUPPORT {}
namespace JPP { using namespace JSUPPORT; }

namespace JSUPPORT {

  /**
   * Type definition for frame index range.
   */
  typedef JTOOLS::JRange<int> JFrameIndexRange;


  /**
   * Get range of frame indices for given file name of data taking run.
   *
   * \param  file_name         file name
   * \return                   frame index range
   */
  template<class T>
  inline JFrameIndexRange getFrameIndexRange(const std::string& file_name)
  {
    using namespace KM3NETDAQ;

    JFrameIndexRange result(JFrameIndexRange::DEFAULT_RANGE);

    TDirectory*& dir = TDirectory::CurrentDirectory();
      
    if (isROOTFile(file_name.c_str())) {
    
      JTreeScanner<T, JDAQEvaluator> in(file_name);
      
      result = JFrameIndexRange(in.begin()->getFrameIndex(), in.rbegin()->getFrameIndex());

    } else {
      
      JFileScanner<T> in(file_name.c_str());

      while (in.hasNext()) {
        result.include(in.next()->getFrameIndex());
      }
    }
      
    if (dir != NULL) {
      dir->cd();        // restore current working directory
    }
      
    return result;
  }


  /**
   * Get data taking live time.
   *
   * \param  file_name         file name
   * \return                   live time [s]
   */
  inline double getLivetime(const std::string& file_name)
  {
    using namespace KM3NETDAQ;
    using namespace JTRIGGER;
    
    TDirectory*& dir = TDirectory::CurrentDirectory();

    double livetime = 0.0;
    
    const JTriggerParameters parameters = getTriggerParameters(file_name);
    
    if (parameters.writeSummary.prescale != 0) {

      JTreeScanner<JDAQSummaryslice> in(file_name);
      
      livetime = in.getEntries() * getFrameTime() * 1.0e-9 / parameters.writeSummary.prescale;
    }
      
    if (dir != NULL) {
      dir->cd();        // restore current working directory
    }

    return livetime;
  }


  /**
   * Get data taking live time.
   *
   * \param  __begin           begin of file list
   * \param  __end             end   of file list
   * \return                   live time [s]
   */
  template<class T>
  inline double getLivetime(T __begin, T __end)
  {
    double livetime = 0.0;

    for (T i = __begin; i != __end; ++i) {
      livetime += getLivetime(*i);
    }

    return livetime;
  }
}

#endif