JSUPPORT Namespace Reference

Support classes and methods for experiment specific I/O. More...

Classes
struct	JAutoTreeScanner
	Auxiliary class to select JTreeScanner based on ROOT class name. More...
class	JAutoTreeWriter
	Auxiliary class to copy input data to corresponding TTree. More...
class	JDAQFileReader
	DAQ object reading from binary file (i.e. .dat). More...
class	JDAQFileReader< T, true >
	Template specialisation of JDAQFileReader for DAQ compatible data types. More...
class	JDAQFileReader< T, false >
	Template specialisation of JDAQFileReader for DAQ incompatible data types. More...
class	JDAQWriterObjectOutput
	Auxiliary class for DAQ object writing to binary stream. More...
class	JDAQWriterObjectOutput< T, true >
	Implementation of object output for DAQ compatible data types. More...
class	JDAQWriterObjectOutput< T, false >
	Implementation of object output for DAQ incompatible data types. More...
class	JDAQWriter
	Implementation of object output to binary file for single data type. More...
class	JDAQWriter< JTypeList< JHead_t, JTail_t > >
	Implementation of object output to binary file for multiple data types. More...
class	JDAQWriter< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JDAQWriter class. More...
class	JDAQFileWriter
	Object(s) writing to binary file (i.e. .dat). More...
struct	JEvtWeightFileScanner
	Template event-weighter-associated file scanner. More...
struct	JEvtWeightFileScannerSet
	Auxiliary class for organising Monte Carlo file scanners associated with event weighters. More...
class	JFileRecorder
	Object writing to file. More...
class	JFileScanner
	Object reading from file. More...
struct	JHeadSet
	Auxiliary class for organising Monte Carlo run headers. More...
struct	JLimit
	Auxiliary class for defining the range of iterations of objects. More...
struct	JMeta
	Auxiliary class for ROOT I/O of application specific meta data. More...
struct	JMetaOld_t
	Type definition of old meta data. More...
class	JMonteCarloASCIIFileReader
	Template definition of Monte Carlo object reader for ASCII formatted file (i.e. '.evt') More...
class	JMonteCarloGZFileReader
	Template definition of Monte Carlo object reader for gzipped ASCII formatted file (i.e. '.gz') More...
class	JMonteCarloFileReader
	Template definition of Monte Carlo object reader. More...
class	JMonteCarloFileReader< Head, JFileReader_t >
	Template specialisation of JMonteCarloFileReader for Head. More...
class	JMonteCarloFileReader< Evt, JFileReader_t >
	Template specialisation of JMonteCarloFileReader for Event. More...
class	JMonteCarloASCIIFileReader< Head >
	Template implementation of Monte Carlo object reader for ASCII formatted file (i.e. '.evt') More...
class	JMonteCarloASCIIFileReader< Evt >
	Template implementation of Monte Carlo object reader for ASCII formatted file (i.e. '.evt') More...
class	JMonteCarloGZFileReader< Head >
	Template implementation of Monte Carlo object reader for gzipped ASCII formatted file (i.e. '.gz') More...
class	JMonteCarloGZFileReader< Evt >
	Template implementation of Monte Carlo object reader for gzipped ASCII formatted file (i.e. '.gz') More...
class	JMonteCarloStreamObjectOutput< Head >
	Template specialisation of JMonteCarloStreamObjectOutput for Head. More...
class	JMonteCarloStreamObjectOutput< Evt >
	Template specialisation of JMonteCarloStreamObjectOutput for Evt. More...
class	JMultipleFileScanner< Head >
	Template specialisation of JMultipleFileScanner for Monte Carlo header. More...
class	JMonteCarloStreamObjectOutput
	Template definition of Monte Carlo stream output for single data type. More...
class	JMonteCarloStreamObjectOutput< JTypeList< JHead_t, JTail_t > >
	Template specialisation of Monte Carlo stream object output for multiple data types. More...
class	JMonteCarloStreamObjectOutput< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JMonteCarloStreamObjectOutput class. More...
class	JMonteCarloFileWriter
	Object(s) writing to Monte Carlo ASCII file (i.e. .evt) More...
struct	JMultipleFileSampler_t
	Auxiliary base class to sample from a list of files. More...
struct	JMultipleFileSampler
	Auxiliary class to sample from a list of files. More...
struct	JMultipleFileScanner_t
	Auxiliary base class for list of file names. More...
class	JMultipleFileScanner
	General purpose class for object reading from a list of file names. More...
class	JMultipleFileScanner< JNullType >
	Template specialisation of JMultipleFileScanner for undefined type. More...
class	JMultipleFileScanner< JTypeList< JHead_t, JTail_t > >
	Implementation of object reading for multiple data types from a list of file names. More...
class	JMultipleFileScanner< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JMultipleFileScanner class. More...
class	JParallelFileScanner
	General purpose class for parallel reading of objects from a single file or multiple files. More...
class	JParallelFileScanner< JTypeList< JHead_t, JTail_t >, JFileScanner_t >
	Template specialisation of JParallelFileScanner for multiple data types. More...
class	JParallelFileScanner< JTypeList< JHead_t, JNullType >, JFileScanner_t >
	Terminator class of recursive JParallelFileScanner class. More...
struct	JRandomSampler
	Template class for randomly sampling from a JLANG::JRewindableObjectIterator using a JLANG::JObjectSampler. More...
struct	JRunByRun
	Auxiliary class to select summary data (KM3NETDAQ::JDAQSummaryslice) from the specified raw data file(s). More...
struct	JSingleFileScanner_t
	Auxiliary base class for file name. More...
class	JSingleFileScanner
	Object reading from a list of files. More...
class	JSingleFileScanner< JNullType >
	Template specialisation of JSingleFileScanner for undefined type. More...
class	JSingleFileScanner< JTypeList< JHead_t, JTail_t > >
	Template specialisation of JSingleFileScanner for single data types. More...
class	JSingleFileScanner< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JSingleFileScanner class. More...
class	JSummaryFileRouter
	File router for fast addressing of summary data. More...
class	JSummaryRouter
	Router for fast addressing of summary data in KM3NETDAQ::JDAQSummaryslice data structure as a function of the optical module identifier and PMT address. More...
class	JTreeRecorder
	ROOT TTree object output. More...
struct	JTreeSampler
	Auxiliary class to sample from a list of files. More...
class	JTreeScanner_t
	Base class for JTreeScanner. More...
class	JTreeScanner
	Template definition for direct access of elements in ROOT TChain. More...
class	JTreeScanner< JNullType, JNullType >
	Auxiliary base class for reporting messages. More...
class	JTreeScanner< JAssertConversion< JDerived_t, JBase_t >, JNullType >
	Specialiation of class JTreeScanner for unordered direct access of elements in ROOT TChain. More...
class	JTreeScanner< JClass_t, JNullType >
	Specialiation of class JTreeScanner for unordered direct access of elements in ROOT TChain. More...
class	JTreeScanner< JAssertConversion< JDerived_t, JBase_t >, JEvaluator_t >
	Specialisation of class JTreeScanner for ordered direct access of elements in ROOT TChain. More...
class	JTreeScannerInterface
	Auxiliary interface for direct access of elements in ROOT TChain. More...
class	JTreeScannerInterface< JClass_t, JNullType >
	Specialiation of interface JTreeScannerInterface for unordered direct access of elements in ROOT TChain. More...
struct	JTriggeredFileScanner
	Auxiliary class to synchronously read DAQ events and Monte Carlo events (and optionally other events). More...
class	JMultipleFileScanner< JTriggerParameters >
	Template specialisation of JMultipleFileScanner for trigger parameters. More...

Typedefs
typedef JLimit	JLimit_t
	Type definition of limit. More...
typedef JTOOLS::JRange< int >	JFrameIndexRange
	Type definition for frame index range. More...
typedef JTOOLS::JRange< JDAQUTCExtended >	JDAQUTCTimeRange
	Type definition for DAQ UTC time range. More...

Functions
bool	isROOTFile (const char *file_name)
	Check file format. More...
bool	isJSONFile (const char *file_name)
	Check file format. More...
bool	isDAQFile (const char *file_name)
	Check file format. More...
bool	isJppFile (const char *file_name)
	Check file format. More...
bool	isMonteCarloFile (const char *file_name)
	Check file format. More...
bool	isGzipFile (const char *file_name)
	Check file format. More...
const char *	getName (const JType< JMeta > &type)
	Get ROOT name of given data type. More...
int	getNumberOfCycles (TFile *file, const TString &key)
	Get number of cycles of named objects with same title as given key. More...
void	getObject (TFile *file, const TString &key, JMeta *&ps)
	Read object from ROOT file. More...
bool	putMeta (TDirectory &dir, const std::string &key, const std::string &buffer)
	Write meta data as ROOT TNamed object. More...
bool	putObject (TDirectory &dir, const JMeta &meta)
	Write meta data to ROOT directory. More...
bool	putObject (TDirectory *dir, const JMeta &meta)
	Write meta data to ROOT directory. More...
TFile &	operator<< (TFile &file, const JMeta &meta)
	Write meta data to ROOT file. More...
const char *	getName (const JType< JMetaOld_t > &type)
	Get ROOT name of given data type. More...
void	getObject (TFile *file, const TString &key, JMetaOld_t *&ps)
	Read object from ROOT file. More...
bool	putObject (TDirectory &dir, const JMetaOld_t &meta)
	Write old meta data to ROOT directory in new format. More...
Head	getHeader (const JMultipleFileScanner_t &file_list)
	Get Monte Carlo header. More...
Head	getCommonHeader (const JMultipleFileScanner_t &file_list)
	Get common Monte Carlo header. More...
JMultiHead	getMultiHeader (const JMultipleFileScanner_t &file_list)
	Get multi-header corresponding to a given file list. More...
template<class JFunction_t >
JMultipleFileScanner_t	getAAnetFiles (const JMultipleFileScanner_t &input, JFunction_t test)
	Get list of files compatible with geven header. More...
JAANET::JEvtCategorySet	getCategories (const JMultipleFileScanner_t &file_list)
	Get the unique event categories corresponding to a given list of MC files. More...
double	getTimeDuration (const JDAQUTCTimeRange &utc)
	Get time duration of given UTC time range. More...
template<class T >
int	getRunNumber (const std::string &file_name)
	Get run number for given file name of data taking run. More...
template<class T >
JFrameIndexRange	getFrameIndexRange (JTreeScannerInterface< T, KM3NETDAQ::JDAQEvaluator > &in)
	Get range of frame indices. More...
template<class T >
JFrameIndexRange	getFrameIndexRange (const std::string &file_name)
	Get range of frame indices for given file name of data taking run. More...
JDAQUTCTimeRange	getUTCTimeRange ()
	Get UTC time range. More...
template<class T >
JDAQUTCTimeRange	getUTCTimeRange (JTreeScannerInterface< T, KM3NETDAQ::JDAQEvaluator > &in)
	Get UTC time range. More...
template<class T >
JDAQUTCTimeRange	getUTCTimeRange (const std::string &file_name)
	Get UTC time range for given file name of data taking run. More...
template<class T >
JDAQUTCTimeRange	getUTCTimeRange (T __begin, T __end)
	Get UTC time range for given file name of data taking run. More...
double	getLivetime (const std::string &file_name)
	Get data taking live time. More...
template<class T >
double	getLivetime (T __begin, T __end)
	Get data taking live time. More...
double	getLivetime (const JMultipleFileScanner_t &file_list)
	Get data taking live time. More...
JTriggerParameters	getTriggerParameters (const JMultipleFileScanner_t &file_list)
	Get trigger parameters. More...

Variables
static const char *const	ROOT_FILE_FORMAT = "root"
	file name extension ROOT format More...
static const char *const	JSON_FILE_FORMAT = "json"
	file name extension JSON format More...
static const char *const	DAQ_FILE_FORMAT = "dat"
	file name extension DAQ binary format More...
static const char *const	JPP_FILE_FORMAT = "jpp"
	file name extension Jpp binary format More...
static const char *const	MONTE_CARLO_FILE_FORMAT = "evt"
	file name extension ASCII format More...
static const char *const	GZIP_FILE_FORMAT = "gz"
	file name extension gzip format More...
static const char *const	ASCII_FILE_FORMAT = "txt"
	file name extension ASCII format More...
static const char *const	FILE_LIST_FORMAT = "files"
	file name extension ASCII format with list of file names More...
static const char *const	META_NAME = "JMeta"
	ROOT name for meta data. More...
static const char *const	META_DIRECTORY = "META"
	ROOT sub-directory for meta data. More...
static const char *const	application_t = "application"
	Definition of meta data parameters. More...
static const char *const	SVNrelease_t = "SVN"
	SVN release. More...
static const char *const	GITrelease_t = "GIT"
	GIT release. More...
static const char *const	ROOTrelease_t = "ROOT"
	ROOT release. More...
static const char *const	namespace_t = "namespace"
	name space More...
static const char *const	command_t = "command"
	Linux command. More...
static const char *const	system_t = "system"
	system information More...
static const char *const	BRANCH_PATTERN = "vector"
	Pattern match for names of sub-branches that will not be read when ordering elements in a TTree. More...

Detailed Description

Support classes and methods for experiment specific I/O.

Author

mdejong

bjung

Typedef Documentation

JLimit_t

typedef JLimit JSUPPORT::JLimit_t

Type definition of limit.

Definition at line 226 of file JLimit.hh.

JFrameIndexRange

typedef JTOOLS::JRange<int> JSUPPORT::JFrameIndexRange

Type definition for frame index range.

Definition at line 41 of file JSupportToolkit.hh.

JDAQUTCTimeRange

typedef JTOOLS::JRange<JDAQUTCExtended> JSUPPORT::JDAQUTCTimeRange

Type definition for DAQ UTC time range.

Definition at line 46 of file JSupportToolkit.hh.

Function Documentation

isROOTFile()

bool JSUPPORT::isROOTFile ( const char *  file_name )

inline

Check file format.

Returns

true if ROOT format; else false

Definition at line 36 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == ROOT_FILE_FORMAT;
  }

isJSONFile()

bool JSUPPORT::isJSONFile ( const char *  file_name )

inline

Check file format.

Returns

true if ROOT format; else false

Definition at line 47 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == JSON_FILE_FORMAT;
  }

isDAQFile()

bool JSUPPORT::isDAQFile ( const char *  file_name )

inline

Check file format.

Returns

true if DAQ format; else false

Definition at line 58 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == DAQ_FILE_FORMAT;
  }

isJppFile()

bool JSUPPORT::isJppFile ( const char *  file_name )

inline

Check file format.

Returns

true if Jpp format; else false

Definition at line 69 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == JPP_FILE_FORMAT;
  }

isMonteCarloFile()

bool JSUPPORT::isMonteCarloFile ( const char *  file_name )

inline

Check file format.

Returns

true if MONTE CARLO format; else false

Definition at line 80 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == MONTE_CARLO_FILE_FORMAT;
  }

isGzipFile()

bool JSUPPORT::isGzipFile ( const char *  file_name )

inline

Check file format.

Returns

true if gzip format; else false

Definition at line 91 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == GZIP_FILE_FORMAT;
  }

getName() [1/2]

const char* JSUPPORT::getName ( const JType< JMeta > &  type )

inline

Get ROOT name of given data type.

Parameters

type	JMeta type

Returns

name of object to be read

Definition at line 236 of file JMeta.hh.

  { 
    return META_NAME;
  }

getNumberOfCycles()

int JSUPPORT::getNumberOfCycles ( TFile *  file, const TString &  key  )

inline

Get number of cycles of named objects with same title as given key.

Parameters

file	pointer to file
key	ROOT key (including possible directory)

Returns

number of cycles

Definition at line 249 of file JMeta.hh.

  {
    using namespace std;
 
    int counter = 0;
 
    if (file != NULL) {
 
      TNamed* __p = NULL;
 
      file->GetObject(key, __p);
 
      if (__p != NULL) {
 
        ++counter;
 
        const TString title = __p->GetTitle();
 
        string buffer(key);
 
        const string::size_type pos = buffer.find(';');
 
        if (pos != string::npos) {
        
          int cycle = -1;
 
          istringstream(buffer.substr(pos + 1)) >> cycle;
 
          buffer = buffer.substr(0, pos);
          
          for (int i = 1; i < cycle; ++i) {
            
            file->GetObject(MAKE_CSTRING(buffer << ';' << i), __p);
            
            if (__p != NULL && __p->GetTitle() == title) {
              ++counter;
            }
          }
        }
      }
    }
 
    return counter;
  }

getObject() [1/2]

void JSUPPORT::getObject ( TFile *  file, const TString &  key, JMeta *&  ps  )

inline

Read object from ROOT file.

Parameters

file	pointer to file
key	key of object to be read
ps	pointer to object

Definition at line 302 of file JMeta.hh.

  {
    using namespace std;
    using namespace JPP;
 
    if (ps != NULL) {
 
      delete ps;
 
      ps = NULL;
    }
 
    if (file != NULL) {
 
      const int number_of_cycles = getNumberOfCycles(file, MAKE_CSTRING(META_DIRECTORY << '/' << key));
 
      if (number_of_cycles != 0) {
 
        TNamed* __p = NULL;
 
        file->GetObject(MAKE_CSTRING(META_DIRECTORY << '/' << key), __p);
 
        ps = new JMeta();
 
        (*ps)[application_t] = __p->GetTitle();
          
        file->GetObject(MAKE_CSTRING(META_DIRECTORY << '/' << (*ps)[application_t] << ';' << number_of_cycles), __p);
 
        if (__p != NULL) {
          *ps = JMeta::valueOf(__p->GetTitle());
        }
      }
    }
  }

putMeta()

bool JSUPPORT::putMeta ( TDirectory &  dir, const std::string &  key, const std::string &  buffer  )

inline

Write meta data as ROOT TNamed object.

Parameters

dir	directory
key	ROOT key
buffer	user data

Returns

true if OK; else false

Definition at line 346 of file JMeta.hh.

  {
    static TNamed object;
 
    if (dir.GetListOfKeys()->FindObject(META_DIRECTORY) == NULL) {
      dir.mkdir(META_DIRECTORY);
    }
 
    TDirectory* p = dir.GetDirectory(META_DIRECTORY);
 
    object.SetName (key.c_str());       // ROOT key
    object.SetTitle(buffer.c_str());    // user data
 
    return (p->WriteTObject(&object) > 0);
  }

putObject() [1/3]

bool JSUPPORT::putObject ( TDirectory &  dir, const JMeta &  meta  )

inline

Write meta data to ROOT directory.

Parameters

dir	directory
meta	meta data

Returns

true if OK; else false

Definition at line 370 of file JMeta.hh.

  {
    JMeta::const_iterator p = meta.find(application_t);
 
    if (p != meta.end()) { 
      if (putMeta(dir, getName(JType<JMeta>()), p->second)) {
        return putMeta(dir, p->second, meta.toString());
      }
    }
 
    return false;
  }

putObject() [2/3]

bool JSUPPORT::putObject ( TDirectory *  dir, const JMeta &  meta  )

inline

Write meta data to ROOT directory.

Parameters

dir	pointer to directory
meta	meta data

Returns

true if OK; else false

Definition at line 391 of file JMeta.hh.

  {
    if (dir != NULL)
      return putObject(*dir, meta);
    else
      return false;
  }

operator<<()

TFile& JSUPPORT::operator<< ( TFile &  file, const JMeta &  meta  )

inline

Write meta data to ROOT file.

Parameters

file	ROOT file
meta	meta data

Returns

ROOT file

Definition at line 407 of file JMeta.hh.

  {
    putObject(file, meta);
 
    return file;
  }

getName() [2/2]

const char* JSUPPORT::getName ( const JType< JMetaOld_t > &  type )

inline

Get ROOT name of given data type.

Parameters

type	JMetaOld_t type

Returns

name of object to be read

Definition at line 448 of file JMeta.hh.

  { 
    return META_NAME;
  }

getObject() [2/2]

void JSUPPORT::getObject ( TFile *  file, const TString &  key, JMetaOld_t *&  ps  )

inline

Read object from ROOT file.

Parameters

file	pointer to file
key	key of object to be read
ps	pointer to object

< application name

< SVN release

< ROOT release

< name space

< Linux command

< system information

< number of items

Definition at line 461 of file JMeta.hh.

  {
    enum JParameter_t {
      JApplication_t = 0,            //!< application name 
      JSVNRelease_t,                 //!< SVN  release 
      JROOTRelease_t,                //!< ROOT release 
      JNamespace_t,                  //!< name space 
      JCommand_t,                    //!< Linux command 
      JSystem_t,                     //!< system information 
      number_of_items                //!< number of items
    };
 
    const char* buffer[number_of_items] = {
      application_t,
      SVNrelease_t,
      ROOTrelease_t,
      namespace_t,
      command_t,
      system_t
    };
 
    if (ps != NULL) {
 
      delete ps;
 
      ps = NULL;
    }
 
    if (file != NULL) {
 
      const int number_of_cycles = getNumberOfCycles(file, key);
 
      if (number_of_cycles != 0) {
 
        TNamed* __p = NULL;
 
        file->GetObject(key, __p);
        
        ps = new JMetaOld_t();
        
        (*ps)[application_t] = __p->GetTitle();
 
        for (int i = 1; i != number_of_items; ++i) {
 
          file->GetObject(MAKE_CSTRING((*ps)[application_t] << ';' << ((number_of_cycles - 1) * (number_of_items - 1) + i)), __p);
          
          if (__p != NULL)
            (*ps)[buffer[i]] = __p->GetTitle();
          else
            break;
        }
      }
    }
  }

putObject() [3/3]

bool JSUPPORT::putObject ( TDirectory &  dir, const JMetaOld_t &  meta  )

inline

Write old meta data to ROOT directory in new format.

Parameters

dir	directory
meta	meta data

Returns

true if OK; else false

Definition at line 524 of file JMeta.hh.

  {
    return putObject(dir, static_cast<const JMeta&>(meta));
  }

getHeader()

Head JSUPPORT::getHeader ( const JMultipleFileScanner_t &  file_list )

inline

Get Monte Carlo header.

Parameters

file_list

file list

Returns

Monte Carlo header

Definition at line 547 of file JMonteCarloFileSupportkit.hh.

  {
    return JMultipleFileScanner<Head>(file_list).getHeader();
  }

getCommonHeader()

Head JSUPPORT::getCommonHeader ( const JMultipleFileScanner_t &  file_list )

inline

Get common Monte Carlo header.

Parameters

file_list

file list

Returns

Monte Carlo header

Definition at line 559 of file JMonteCarloFileSupportkit.hh.

  {
    Head head;
    
    if (!file_list.empty()) {
 
      JHead buffer = getHeader(file_list[0]);
 
      buffer.createUUID();
      
      for (size_t i = 1; i != file_list.size(); ++i) {
        buffer = buffer.getMatch(getHeader(file_list[i]));
      }
 
      copy(buffer, head);
    }
 
    return head;
  }

getMultiHeader()

JMultiHead JSUPPORT::getMultiHeader ( const JMultipleFileScanner_t &  file_list )

inline

Get multi-header corresponding to a given file list.

Parameters

file_list

file list

Returns

Monte Carlo multi header

Definition at line 586 of file JMonteCarloFileSupportkit.hh.

  {
    using namespace JPP;
 
    JMultiHead multiHeader;
      
    for (JMultipleFileScanner<MultiHead> in(file_list); in.hasNext(); ) {
 
      const MultiHead* p = in.next();
 
      for (MultiHead::const_iterator i = p->cbegin(); i != p->cend(); ++i) {
 
        JHead header = *i;
 
        multiHeader.insert(header);
      }
    }
      
    multiHeader.merge();
 
    return multiHeader;
  }

getAAnetFiles()

template<class JFunction_t >

JMultipleFileScanner_t JSUPPORT::getAAnetFiles	(	const JMultipleFileScanner_t &	input,
		JFunction_t	test
	)

Get list of files compatible with geven header.

Note that the option corresponds to that of method JHead::match.

Parameters

input	file list
test	test function

Returns

file list

Definition at line 621 of file JMonteCarloFileSupportkit.hh.

  {
    using namespace JPP;
    
    JMultipleFileScanner_t result;
 
    for (JMultipleFileScanner_t::const_iterator i = input.begin(); i != input.end(); ++i) {
      if (test(getHeader(*i))) {
        result.push_back(*i);
      }
    }
 
    return result;
  }

getCategories()

JAANET::JEvtCategorySet JSUPPORT::getCategories ( const JMultipleFileScanner_t &  file_list )

inline

Get the unique event categories corresponding to a given list of MC files.

Parameters

file_list

list of MC files

Returns

unique event categories

Definition at line 643 of file JMonteCarloFileSupportkit.hh.

  {
    using namespace std;
    using namespace JPP;
 
    JEvtCategorySet categories;
    
    for (JMultipleFileScanner_t::const_iterator i = file_list.cbegin(); i != file_list.cend(); ++i) {
      const JHead& header = getHeader(*i);
 
      JEvtCategorySet cats = getCategories(header);
 
      categories.insert(cats.begin(), cats.end());
    }
 
    return categories;
  }

getTimeDuration()

double JSUPPORT::getTimeDuration ( const JDAQUTCTimeRange &  utc )

inline

Get time duration of given UTC time range.

Parameters

utc	UTC time range

Returns

time duration [s]

Definition at line 55 of file JSupportToolkit.hh.

  {
    if (utc.is_valid())
      return (utc.getUpperLimit().getTimeNanoSecond() - 
              utc.getLowerLimit().getTimeNanoSecond()) * 1.0e-9;
    else
      return 0.0;
  }

getRunNumber()

template<class T >

int JSUPPORT::getRunNumber ( const std::string &  file_name )

inline

Get run number for given file name of data taking run.

Parameters

file_name

file name

Returns

run number

Definition at line 72 of file JSupportToolkit.hh.

  {
    JFileScanner<T> in(file_name.c_str());
 
    if (in.hasNext())
      return in.next()->getRunNumber();
    else
      return -1;
  }

getFrameIndexRange() [1/2]

template<class T >

JFrameIndexRange JSUPPORT::getFrameIndexRange ( JTreeScannerInterface< T, KM3NETDAQ::JDAQEvaluator > &  in )

inline

Get range of frame indices.

Parameters

in	TTree scanner

Returns

frame index range

Definition at line 90 of file JSupportToolkit.hh.

  {
    if (!in.empty())
      return JFrameIndexRange(in.begin()->getFrameIndex(), in.rbegin()->getFrameIndex());
    else
      return JFrameIndexRange(0,0);
  }

getFrameIndexRange() [2/2]

template<class T >

JFrameIndexRange JSUPPORT::getFrameIndexRange ( const std::string &  file_name )

inline

Get range of frame indices for given file name of data taking run.

Parameters

file_name

file name

Returns

frame index range

Definition at line 106 of file JSupportToolkit.hh.

  {
    JFrameIndexRange result(JFrameIndexRange::DEFAULT_RANGE());
 
    TDirectory* dir = TDirectory::CurrentDirectory();
      
    if (isROOTFile(file_name.c_str())) {
 
      JTreeScanner<T, KM3NETDAQ::JDAQEvaluator> in(file_name);
 
      return getFrameIndexRange(in);
 
    } 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;
  }

getUTCTimeRange() [1/4]

JDAQUTCTimeRange JSUPPORT::getUTCTimeRange ( )

inline

Get UTC time range.

Returns

UTC time range

Definition at line 140 of file JSupportToolkit.hh.

  {
    return JDAQUTCTimeRange(JDAQUTCExtended(), JDAQUTCExtended());
  }

getUTCTimeRange() [2/4]

template<class T >

JDAQUTCTimeRange JSUPPORT::getUTCTimeRange ( JTreeScannerInterface< T, KM3NETDAQ::JDAQEvaluator > &  in )

inline

Get UTC time range.

Parameters

in	TTree scanner

Returns

UTC time range

Definition at line 153 of file JSupportToolkit.hh.

  {
    if (!in.empty())
      return JDAQUTCTimeRange(in.begin()->getTimesliceStart(), in.rbegin()->getTimesliceStart());
    else
      return getUTCTimeRange();
  }

getUTCTimeRange() [3/4]

template<class T >

JDAQUTCTimeRange JSUPPORT::getUTCTimeRange ( const std::string &  file_name )

inline

Get UTC time range for given file name of data taking run.

Parameters

file_name

file name

Returns

UTC time range

Definition at line 169 of file JSupportToolkit.hh.

  {
    JDAQUTCTimeRange result(JDAQUTCTimeRange::DEFAULT_RANGE());
 
    TDirectory* dir = TDirectory::CurrentDirectory();
 
    if (isROOTFile(file_name.c_str())) {
 
      JTreeScanner<T, KM3NETDAQ::JDAQEvaluator> in(file_name);
 
      result = getUTCTimeRange(in);
 
    } else {
 
      for (JFileScanner<T> in(file_name.c_str()); in.hasNext(); ) {
        result.include(in.next()->getTimesliceStart());
      }
    }
      
    if (dir != NULL) {
      dir->cd();        // restore current working directory
    }
      
    return result;
  }

getUTCTimeRange() [4/4]

template<class T >

JDAQUTCTimeRange JSUPPORT::getUTCTimeRange ( T  __begin, T  __end  )

inline

Get UTC time range for given file name of data taking run.

Get data taking live time.

Parameters

__begin	begin of file list
__end	end of file list

Returns

UTC time range

Definition at line 205 of file JSupportToolkit.hh.

  {
    JDAQUTCTimeRange result(JDAQUTCTimeRange::DEFAULT_RANGE());
 
    for (T i = __begin; i != __end; ++i) {
 
      JDAQUTCTimeRange buffer = getUTCTimeRange<KM3NETDAQ::JDAQSummaryslice>(*i);
 
      if (buffer == getUTCTimeRange()) {
        buffer = getUTCTimeRange<KM3NETDAQ::JDAQTimeslice>(*i);
      }
 
      result.combine(buffer);
    }
 
    return result;
  }

getLivetime() [1/3]

double JSUPPORT::getLivetime ( const std::string &  file_name )

inline

Get data taking live time.

Parameters

file_name

file name

Returns

live time [s]

Definition at line 230 of file JSupportToolkit.hh.

  {
    using namespace KM3NETDAQ;
    using namespace JTRIGGER;
    
    TDirectory* dir = TDirectory::CurrentDirectory();
 
    double livetime = 0.0;
 
    try {
 
      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;
      }
    }
    catch(const std::exception& error) {}
      
    if (dir != NULL) {
      dir->cd();        // restore current working directory
    }
 
    return livetime;
  }

getLivetime() [2/3]

template<class T >

double JSUPPORT::getLivetime ( T  __begin, T  __end  )

inline

Get data taking live time.

Parameters

__begin	begin of file list
__end	end of file list

Returns

live time [s]

Definition at line 268 of file JSupportToolkit.hh.

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

getLivetime() [3/3]

double JSUPPORT::getLivetime ( const JMultipleFileScanner_t &  file_list )

inline

Get data taking live time.

Parameters

file_list

file list

Returns

live time [s]

Definition at line 286 of file JSupportToolkit.hh.

  {
    return getLivetime(file_list.begin(), file_list.end());
  }

getTriggerParameters()

JTriggerParameters JSUPPORT::getTriggerParameters ( const JMultipleFileScanner_t &  file_list )

inline

Get trigger parameters.

Parameters

file_list

file list

Returns

trigger parameters

Definition at line 148 of file JTriggerParametersSupportkit.hh.

  {
    return JMultipleFileScanner<JTriggerParameters>(file_list).getTriggerParameters();
  }

Variable Documentation

ROOT_FILE_FORMAT

const char* const JSUPPORT::ROOT_FILE_FORMAT = "root"

static

file name extension ROOT format

Definition at line 21 of file JFilenameSupportkit.hh.

JSON_FILE_FORMAT

const char* const JSUPPORT::JSON_FILE_FORMAT = "json"

static

file name extension JSON format

Definition at line 22 of file JFilenameSupportkit.hh.

DAQ_FILE_FORMAT

const char* const JSUPPORT::DAQ_FILE_FORMAT = "dat"

static

file name extension DAQ binary format

Definition at line 23 of file JFilenameSupportkit.hh.

JPP_FILE_FORMAT

const char* const JSUPPORT::JPP_FILE_FORMAT = "jpp"

static

file name extension Jpp binary format

Definition at line 24 of file JFilenameSupportkit.hh.

MONTE_CARLO_FILE_FORMAT

const char* const JSUPPORT::MONTE_CARLO_FILE_FORMAT = "evt"

static

file name extension ASCII format

Definition at line 25 of file JFilenameSupportkit.hh.

GZIP_FILE_FORMAT

const char* const JSUPPORT::GZIP_FILE_FORMAT = "gz"

static

file name extension gzip format

Definition at line 26 of file JFilenameSupportkit.hh.

ASCII_FILE_FORMAT

const char* const JSUPPORT::ASCII_FILE_FORMAT = "txt"

static

file name extension ASCII format

Definition at line 27 of file JFilenameSupportkit.hh.

FILE_LIST_FORMAT

const char* const JSUPPORT::FILE_LIST_FORMAT = "files"

static

file name extension ASCII format with list of file names

Definition at line 28 of file JFilenameSupportkit.hh.

META_NAME

const char* const JSUPPORT::META_NAME = "JMeta"

static

ROOT name for meta data.

Definition at line 46 of file JMeta.hh.

META_DIRECTORY

const char* const JSUPPORT::META_DIRECTORY = "META"

static

ROOT sub-directory for meta data.

Definition at line 52 of file JMeta.hh.

application_t

const char* const JSUPPORT::application_t = "application"

static

Definition of meta data parameters.

application name

Definition at line 58 of file JMeta.hh.

SVNrelease_t

const char* const JSUPPORT::SVNrelease_t = "SVN"

static

SVN release.

Definition at line 59 of file JMeta.hh.

GITrelease_t

const char* const JSUPPORT::GITrelease_t = "GIT"

static

GIT release.

Definition at line 60 of file JMeta.hh.

ROOTrelease_t

const char* const JSUPPORT::ROOTrelease_t = "ROOT"

static

ROOT release.

Definition at line 61 of file JMeta.hh.

namespace_t

const char* const JSUPPORT::namespace_t = "namespace"

static

name space

Definition at line 62 of file JMeta.hh.

command_t

const char* const JSUPPORT::command_t = "command"

static

Linux command.

Definition at line 63 of file JMeta.hh.

system_t

const char* const JSUPPORT::system_t = "system"

static

system information

Definition at line 64 of file JMeta.hh.

BRANCH_PATTERN

const char* const JSUPPORT::BRANCH_PATTERN = "vector"

static

Pattern match for names of sub-branches that will not be read when ordering elements in a TTree.

Definition at line 44 of file JTreeScanner.hh.