JROOT Namespace Reference

Auxiliary classes and methods for ROOT I/O. More...

Classes
class	JAbstractStreamer
	Forward declaration of writer object. More...
class	JChainReader
	Auxiliary class for template TChain reading. More...
class	JClassDef
	Test ROOT ClassDef. More...
struct	JClassStreamer
	Auxiliary class to add the I/O capabilities of the given template class to the general JRootDictionary class. More...
struct	JRootAddress
	Auxiliary classd for address handling within TTree or TChain. More...
struct	JRootClass
	Auxiliary class to manage access to base classes and data members of ROOT class. More...
struct	JRootAddressableClass
	Auxiliary class to manage access to base classes and data members of ROOT class objects. More...
struct	JRootClassReader
	ROOT class for reading object. More...
struct	JRootClassWriter
	ROOT class for writing object. More...
struct	JROOTClassSelector
	Auxiliary class to select ROOT class based on class name. More...
struct	JROOTClassSelection
	Auxiliary class for ROOT class selection. More...
class	JRootFile
	ROOT file. More...
class	JRootInputFile
	ROOT input file. More...
class	JRootOutputFile
	ROOT output file. More...
class	JRootFileReader
	ROOT file reader. More...
class	JRootFileReader< T, false >
	Tempate specialisation of JRootFileReader for TTree incompatible iteration. More...
class	JRootFileReader< T, true >
	Tempate specialisation of JRootFileReader for TTree compatible iteration. More...
class	JRootObjectOutput
	Template definition of ROOT object output. More...
class	JRootObjectOutput< T, false >
	Implementation of object output using TDirectory::WriteTObject method. More...
class	JRootObjectOutput< T, true >
	Implementation of object output using TTree. More...
class	JRootFileObjectOutput
	Implementation of object output to ROOT file for single data type. More...
class	JRootFileObjectOutput< JTypeList< JHead_t, JTail_t > >
	Implementation of object output to ROOT file for multiple data types. More...
class	JRootFileObjectOutput< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JRootObjectOutput class. More...
class	JRootFileWriter
	ROOT file object output. More...
struct	JRootLabel
	Replica of structure JLANG::JLabel for data types with ROOT I/O. More...
class	JRootReader
	Implementation for ASCII input of objects with ROOT dictionary. More...
class	JRootWriter
	Implementation for ASCII output of objects with ROOT dictionary. More...
class	JObjectStreamer
	JObjectStreamer class. More...
class	JActionAtFileOpen
	Auxiliary class to handle version management of given class at opening of a ROOT file. More...
class	JActionAtFileRead
	Auxiliary class to handle version management of given class at reading from a ROOT file. More...
struct	JFitParameter_t
	Auxiliary data structure for a parameter index and its value. More...
class	JTreeParameters
	Data structure for TTree parameters. More...
class	JTreeParametersAvailable
	Test availability of TTree parameters for given class. More...
struct	JAbstractTreeReader
	Interface for TTree reading. More...
class	JTreeReader
	Auxiliary class for template TTree reading. More...
class	JTreeReaderObjectIterator
	JTreeReader object iterator. More...
class	JTreeReaderAccessibleObjectIterator
	JTemplateTreeReader object iterator. More...
class	JTreeWriter
	Auxiliary class for template TTree writing. More...
struct	JTreeCopyWriterInterface
	Interface for template TTree writing and copying. More...
class	JTreeCopyWriter
	Implementation for template TTree writing and copying. More...
class	JTreeWriterObjectOutput
	JTreeWriter object output. More...
class	JRootDictionary
	ROOT dictionary. More...

Typedefs
typedef Long64_t	counter_type
	Type definition for counter. More...
typedef std::map< std::string, JSharedPointer < JAbstractStreamer > >	JRootDictionary_t
	Type definition of ROOT dictionary. More...

Functions
counter_type	advance (counter_type &counter, const counter_type value, const counter_type limit=std::numeric_limits< counter_type >::max())
	Advance counter. More...
template<class T >
std::set< JROOTClassSelector >	getROOTClassSelection ()
	Get ROOT class selection. More...
template<class T >
const char *	getName ()
	Get ROOT name of given data type. More...
template<class T >
const char *	getName (const JType< T > &type)
	Get ROOT name of given data type. More...
template<class T >
void	getObject (TFile *file, const char *key, T *&ps)
	Read object from ROOT file. More...
template<class T >
bool	putObject (TDirectory *dir, const T &object)
	Write object to ROOT directory. More...
template<class T >
void	print (std::ostream &out, const T &object, const std::string &key, const JRootDictionary_t &dictionary)
	Write content to output. More...
template<class T >
void	actionAtFileOpen (TFile *file)
	General action method at file open. More...
template<class T >
void	actionAtFileRead (T *object)
	General action method at file read. More...
TFile &	operator<< (TFile &file, const TObject &object)
	Write object to ROOT file. More...
const TStreamerInfo *	getStreamerInfo (TFile *file, const char *name)
	Get ROOT streamer information of class with given name. More...
const TStreamerInfo *	getStreamerInfo (const char *file_name, const char *name)
	Get ROOT streamer information of class with given name. More...
int	getStreamerVersion (TFile *file, const char *name)
	Get ROOT streamer version of class with given name. More...
int	getStreamerVersion (const char *file_name, const char *name)
	Get ROOT streamer version of class with given name. More...
bool	setParameter (TF1 &f1, const JFitParameter_t &parameter)
	Set fit parameter. More...
bool	fixParameter (TF1 &f1, const JFitParameter_t &parameter)
	Fix fit parameter. More...
bool	releaseParameter (TF1 &f1, const Int_t index)
	Release fit parameter. More...
bool	setParLimits (TF1 &f1, const Int_t index, Double_t xmin, Double_t xmax)
	Set fit parameter limits. More...
bool	isParameterFixed (TF1 &f1, const Int_t index)
	Check if fit parameter is fixed. More...
template<class T >
JTreeParameters	getTreeParameters ()
	Template definition for method returning TTree parameters. More...
template<class T >
JNullType	getTreeParameters (const JType< T > &type)
	Method with argument definition for obtaining TTree parameters. More...
template<class T >
JTreeCopyWriter< T > &	getTreeCopyWriter ()
	Get the TTree writer and copy for this type of object. More...

Detailed Description

Auxiliary classes and methods for ROOT I/O.

Author

mdejong

Typedef Documentation

typedef Long64_t JROOT::counter_type

Type definition for counter.

Definition at line 24 of file JCounter.hh.

typedef std::map<std::string, JSharedPointer<JAbstractStreamer> > JROOT::JRootDictionary_t

Type definition of ROOT dictionary.

Definition at line 43 of file JRootStreamer.hh.

Function Documentation

counter_type JROOT::advance ( counter_type &  counter, const counter_type  value, const counter_type  limit = std::numeric_limits<counter_type>::max()  )

inline

Advance counter.

Parameters

counter	counter (I/O)
value	offset
limit	limit

Returns

increment

Definition at line 35 of file JCounter.hh.

  {
    const counter_type previous = counter;
        
    if (counter + value < limit)
      counter += value;
    else 
      counter  = limit;
    
    return counter - previous;
  }

template<class T >

std::set<JROOTClassSelector> JROOT::getROOTClassSelection ( )

inline

Get ROOT class selection.

Returns

ROOT class selection

Definition at line 227 of file JROOTClassSelector.hh.

  {
    return JROOTClassSelection(JType<T>());
  }

template<class T >

const char* JROOT::getName ( )

inline

Get ROOT name of given data type.

Returns

name of object to be read

Definition at line 40 of file JRootFileReader.hh.

  {
    return getName(JType<T>());
  }

template<class T >

const char* JROOT::getName ( const JType< T > &  type )

inline

Get ROOT name of given data type.

Parameters

type

data type

Returns

name of object to be read

Definition at line 53 of file JRootFileReader.hh.

  {
    return T::Class_Name();    
  }

template<class T >

void JROOT::getObject ( TFile *  file, const char *  key, T *&  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 67 of file JRootFileReader.hh.

  {
    if (file != NULL) {
      file->GetObject(key, ps);
    }
  }

template<class T >

bool JROOT::putObject ( TDirectory *  dir, const T &  object  )

inline

Write object to ROOT directory.

Parameters

dir	pointer to directory
object	object

Returns

true if OK; else false

Definition at line 41 of file JRootFileWriter.hh.

  {
    return (dir != NULL && dir->WriteTObject(&object) > 0);
  }

template<class T >

void JROOT::print ( std::ostream &  out, const T &  object, const std::string &  key, const JRootDictionary_t &  dictionary  )

inline

Write content to output.

Parameters

out	output stream
object	object
key	'.' separated list of data member names
dicttionary	dictionary

Definition at line 771 of file JRootStreamer.hh.

  {
    using namespace std;
    using namespace JPP;

    const char separator = '.';

    JRootWriter writer(out, JEquationParameters("=", "\n", ".", ""), dictionary);

    JRootClassWriter cls(object);

    if (key != "") {
      for (string::size_type i = 0, j = 0; j != string::npos && cls.is_valid(); i = j + 1) {
        j   = key.substr(i).find(separator);
        cls = cls.find(key.substr(i, j - i).c_str());
      }
    }

    if (cls.is_valid()) {
      if (writer.getDictionary().find(cls.getTypename()) != writer.getDictionary().end())
        writer.putObject(cls);
      else
        writer.put(cls);
    }
  }

template<class T >

void JROOT::actionAtFileOpen ( TFile *  file )

inline

General action method at file open.

The class T should provide the policy method:

   static void actionAtFileOpen(int version);

whenever an action specific to this data type has to be executed after opening a file.
This method will then be called following each file open operation.

Parameters

file	pointer to file

Definition at line 148 of file JRootSupportkit.hh.

  {
    if (file != NULL) {
      JActionAtFileOpen<T>::execute(file);
    }
  }

template<class T >

void JROOT::actionAtFileRead ( T *  object )

inline

General action method at file read.

The class T should provide the policy method:

   void actionAtFileRead();

whenever an action specific to this data type has to be executed after reading from a file.
This method will then be called following each file read operation.

Parameters

object

pointer to object (I/O)

Definition at line 169 of file JRootSupportkit.hh.

  {
    if (object != NULL) {
      JActionAtFileRead<T>::execute(object);
    }
  }

TFile& JROOT::operator<<	(	TFile &	file,
		const TObject &	object
	)

Write object to ROOT file.

Parameters

file	ROOT file
object	ROOT object

Returns

ROOT file

Definition at line 33 of file JRootToolkit.hh.

  {
    file.WriteTObject(&object);

    return file;
  }

const TStreamerInfo* JROOT::getStreamerInfo ( TFile *  file, const char *  name  )

inline

Get ROOT streamer information of class with given name.

Note that the class name should include the name space, if any.

Parameters

file	pointer to ROOT file
name	class name

Returns

pointer to TStreamerInfo (NULL in case of error)

Definition at line 49 of file JRootToolkit.hh.

  {
    if (file != NULL && file->IsOpen()) {

      const TString buffer(name);
        
      TIter iter(file->GetStreamerInfoList());

      for (const TStreamerInfo* pStreamerInfo; (pStreamerInfo = (TStreamerInfo*) iter.Next()) != NULL; ) {
        if (buffer == TString(pStreamerInfo->GetName())) {
          return pStreamerInfo;
        }
      }
    }

    return NULL;
  }

const TStreamerInfo* JROOT::getStreamerInfo ( const char *  file_name, const char *  name  )

inline

Get ROOT streamer information of class with given name.

Note that the class name should include the name space, if any.

Parameters

file_name	file name
name	class name

Returns

pointer to TStreamerInfo (NULL in case of error)

Definition at line 76 of file JRootToolkit.hh.

  {
    JRootInputFile file(file_name);

    return getStreamerInfo(file.getFile(), name);
  }

int JROOT::getStreamerVersion ( TFile *  file, const char *  name  )

inline

Get ROOT streamer version of class with given name.

Note that the class name should include the name space, if any.

Parameters

file	pointer to ROOT file
name	class name

Returns

streamer version; (-1 in case of error)

Definition at line 92 of file JRootToolkit.hh.

  {
    const TStreamerInfo* pStreamerInfo = getStreamerInfo(file, name);
    
    if (pStreamerInfo != NULL)
      return pStreamerInfo->GetClassVersion();
    else
      return -1;
  }

int JROOT::getStreamerVersion ( const char *  file_name, const char *  name  )

inline

Get ROOT streamer version of class with given name.

Note that the class name should include the name space, if any.

Parameters

file_name	file name
name	class name

Returns

streamer version; (-1 in case of error)

Definition at line 111 of file JRootToolkit.hh.

  {
    JRootInputFile file(file_name);
    
    return getStreamerVersion(file.getFile(), name);
  }

bool JROOT::setParameter ( TF1 &  f1, const JFitParameter_t &  parameter  )

inline

Set fit parameter.

Parameters

f1	fit function
parameter	parameter index and value

Definition at line 168 of file JRootToolkit.hh.

  {
    if (parameter.index >= 0 && parameter.index < f1.GetNpar()) {

      f1.SetParameter(parameter.index, parameter.value);

      return true;

    } else {

      return false;
    }
  }

bool JROOT::fixParameter ( TF1 &  f1, const JFitParameter_t &  parameter  )

inline

Fix fit parameter.

Parameters

f1	fit function
parameter	parameter index and value

Definition at line 189 of file JRootToolkit.hh.

  {
    if (parameter.index >= 0 && parameter.index < f1.GetNpar()) {

      f1.FixParameter(parameter.index, parameter.value);

      return true;

    } else {

      return false;
    }
  }

bool JROOT::releaseParameter ( TF1 &  f1, const Int_t  index  )

inline

Release fit parameter.

Parameters

f1	fit function
index	parameter index

Definition at line 210 of file JRootToolkit.hh.

  {
    if (index >= 0 && index < f1.GetNpar()) {

      f1.ReleaseParameter(index);

      return true;

    } else {

      return false;
    }
  }

bool JROOT::setParLimits ( TF1 &  f1, const Int_t  index, Double_t  xmin, Double_t  xmax  )

inline

Set fit parameter limits.

Parameters

f1	fit function
index	parameter index
xmin	lower limit
xmax	upper limit

Definition at line 233 of file JRootToolkit.hh.

  {
    using namespace std;

    if (index >= 0 && index < f1.GetNpar()) {

      if (xmin == 0.0) { xmin = -numeric_limits<Double_t>::min(); }
      if (xmax == 0.0) { xmax = +numeric_limits<Double_t>::min(); }

      f1.SetParLimits(index, xmin, xmax);

      return true;

    } else {

      return false;
    }
  }

bool JROOT::isParameterFixed ( TF1 &  f1, const Int_t  index  )

inline

Check if fit parameter is fixed.

Parameters

f1	fit function
index	parameter index

Definition at line 259 of file JRootToolkit.hh.

  {
    if (index >= 0 && index < f1.GetNpar()) {

      Double_t xmin;
      Double_t xmax;
    
      f1.GetParLimits(index, xmin, xmax);
    
      return (xmin != 0.0 && xmax != 0.0 && xmin >= xmax);

    } else {
      
      return false;
    }
  }

template<class T >

JTreeParameters JROOT::getTreeParameters ( )

inline

Template definition for method returning TTree parameters.

The template argument refers to the class for which ROOT TTree I/O is desired.

Returns

TTree parameters

Definition at line 149 of file JTreeParameters.hh.

  {
    return getTreeParameters(JType<T>());
  }

template<class T >

JNullType JROOT::getTreeParameters ( const JType< T > &  type )

inline

Method with argument definition for obtaining TTree parameters.

The method argument refers to the class for which ROOT TTree I/O is desired. This method should then be overloaded and the overloaded method should return a JTreeParameters object with the corresponding TTree parameters.

Parameters

type

data type

Returns

TTree parameters

template<class T >

JTreeCopyWriter<T>& JROOT::getTreeCopyWriter ( )

inline

Get the TTree writer and copy for this type of object.

Returns

TTree writer and copy for this type of object

Definition at line 168 of file JTreeWriter.hh.

  {
    return JTreeCopyWriter<T>::getInstance();
  }