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. 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. More...
class	JFileRecorder
	Object writing to file. More...
class	JFileScanner
	Object reading from file. 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. More...
class	JMonteCarloGZFileReader
	Template definition of Monte Carlo object reader for gzipped ASCII formatted file (i.e. 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. More...
class	JMonteCarloASCIIFileReader< Evt >
	Template implementation of Monte Carlo object reader for ASCII formatted file (i.e. More...
class	JMonteCarloGZFileReader< Head >
	Template implementation of Monte Carlo object reader for gzipped ASCII formatted file (i.e. More...
class	JMonteCarloGZFileReader< Evt >
	Template implementation of Monte Carlo object reader for gzipped ASCII formatted file (i.e. 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
	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 JRewindableObjectIterator. 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...
struct	JSummaryslice
	Auxiliary class to create summary data. More...
class	JTreeScanner_t
	Base class for JTreeScanner. More...
struct	JTreeScanner
	Template definition for direct access of elements in ROOT TChain. More...
struct	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...
struct	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 >
	Specialiation of class JTreeScanner for ordered direct access of elements in ROOT TChain. More...
struct	JTreeScannerInterface
	Auxiliary interface for direct access of elements in ROOT TChain. More...
struct	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...

Functions
bool	isROOTFile (const char *file_name)
	Check file format. More...
bool	isDAQFile (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 char *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...
const char *	getName (const JType< JMetaOld_t > &type)
	Get ROOT name of given data type. More...
void	getObject (TFile *file, const char *key, JMetaOld_t *&ps)
	Read object from ROOT file. More...
bool	putObject (TDirectory *dir, const JMetaOld_t &meta)
	Write meta data to ROOT directory. More...
Head	getHeader (const JMultipleFileScanner_t &file_list)
	Get Monte Carlo header. 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...
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...
JTriggerParameters	getTriggerParameters (const JMultipleFileScanner_t &file_list)
	Get trigger parameters. More...

Variables
static const char *const	ROOT_FILE_FORMAT = "root"
	ROOT file name extension. More...
static const char *const	DAQ_FILE_FORMAT = "dat"
	DAQ binary file name extension. More...
static const char *const	MONTE_CARLO_FILE_FORMAT = "evt"
	ASCII file name extension. More...
static const char *const	GZIP_FILE_FORMAT = "gz"
	gzip file name extension 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

Typedef Documentation

typedef JLimit JSUPPORT::JLimit_t

Type definition of limit.

Definition at line 214 of file JLimit.hh.

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

Type definition for frame index range.

Definition at line 33 of file JSupportToolkit.hh.

Function Documentation

bool JSUPPORT::isROOTFile ( const char *  file_name )

inline

Check file format.

Returns

true if ROOT format; else false

Definition at line 32 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == ROOT_FILE_FORMAT;
  }

bool JSUPPORT::isDAQFile ( const char *  file_name )

inline

Check file format.

Returns

true if DAQ format; else false

Definition at line 43 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == DAQ_FILE_FORMAT;
  }

bool JSUPPORT::isMonteCarloFile ( const char *  file_name )

inline

Check file format.

Returns

true if MONTE CARLO format; else false

Definition at line 54 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == MONTE_CARLO_FILE_FORMAT;
  }

bool JSUPPORT::isGzipFile ( const char *  file_name )

inline

Check file format.

Returns

true if gzip format; else false

Definition at line 65 of file JFilenameSupportkit.hh.

  {
    return getFilenameExtension(file_name) == GZIP_FILE_FORMAT;
  }

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 241 of file JMeta.hh.

  { 
    return META_NAME;
  }

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 254 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;
  }

void JSUPPORT::getObject ( TFile *  file, const char *  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 307 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());
        }
      }
    }
  }

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

inline

Write meta data as ROOT TNamed object.

Parameters

dir	pointer to directory
key	ROOT key
buffer	user data

Returns

true if OK; else false

Definition at line 351 of file JMeta.hh.

  {
    static TNamed object;

    if (dir != NULL) {

      if (dir->GetListOfKeys()->FindObject(META_DIRECTORY) == NULL) {
        dir->mkdir(META_DIRECTORY);
      }

      dir = dir->GetDirectory(META_DIRECTORY);

      object.SetName (key.c_str());       // ROOT key
      object.SetTitle(buffer.c_str());    // user data

      return (dir->WriteTObject(&object) > 0);
    }

    return false;
  }

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 380 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;
  }

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 427 of file JMeta.hh.

  { 
    return META_NAME;
  }

void JSUPPORT::getObject ( TFile *  file, const char *  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 440 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;
        }
      }
    }
  }

bool JSUPPORT::putObject ( TDirectory *  dir, const JMetaOld_t &  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 503 of file JMeta.hh.

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

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 417 of file JMonteCarloFileSupportkit.hh.

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

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 43 of file JSupportToolkit.hh.

  {
    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;
  }

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 80 of file JSupportToolkit.hh.

  {
    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;
  }

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 114 of file JSupportToolkit.hh.

  {
    double livetime = 0.0;

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

    return livetime;
  }

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

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

static

ROOT file name extension.

Definition at line 21 of file JFilenameSupportkit.hh.

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

static

DAQ binary file name extension.

Definition at line 22 of file JFilenameSupportkit.hh.

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

static

ASCII file name extension.

Definition at line 23 of file JFilenameSupportkit.hh.

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

static

gzip file name extension

Definition at line 24 of file JFilenameSupportkit.hh.

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

static

ROOT name for meta data.

Definition at line 47 of file JMeta.hh.

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

static

ROOT sub-directory for meta data.

Definition at line 53 of file JMeta.hh.

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

static

Definition of meta data parameters.

application name

Definition at line 59 of file JMeta.hh.

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

static

SVN release.

Definition at line 60 of file JMeta.hh.

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

static

GIT release.

Definition at line 61 of file JMeta.hh.

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

static

ROOT release.

Definition at line 62 of file JMeta.hh.

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

static

name space

Definition at line 63 of file JMeta.hh.

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

static

Linux command.

Definition at line 64 of file JMeta.hh.

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

static

system information

Definition at line 65 of file JMeta.hh.

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 42 of file JTreeScanner.hh.