JROOT Namespace Reference

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

Classes
class	JAbstractStreamer
	Forward declaration of writer object. More...
struct	JASCIIFileReader
	Auxiliary class to read objects with ROOT dictionary from ASCII formatted file. More...
struct	JASCIIFileWriter
	Auxiliary class to write object with ROOT dictionary from ASCII formatted file. More...
class	JCanvas
	Data structure for size of TCanvas. 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	JGraph_t
	Data structure for graph data. More...
struct	JGraph
	Auxiliary data structure to build TGraph. More...
class	JLineAttributes
	Auxiliary class to set line attributes. More...
class	JManager
	Auxiliary class to manage set of compatible ROOT objects (e.g. histograms) using unique keys. More...
class	JMarkerAttributes
	Auxiliary class to set marker attributes. 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	JAddress
	Simple address wrapper. More...
struct	JRootAddressableClass
	Auxiliary class to manage access to base classes and data members of ROOT class objects. More...
struct	JRootReadableClass
	ROOT class for reading object. More...
struct	JRootWritableClass
	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...
struct	JRootDictionary_t
	Type definition of ROOT based dictionary for ASCII I/O. 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...
struct	JRootPrinter
	Auxiliary class for printing objects in ASCII format using JRootWriter. 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...
struct	JRootStreamer
	Auxiliary template class to define default implementation of the ROOT streamer. More...
class	JObjectStreamer
	JObjectStreamer class. More...
class	JRootStreamObjectOutput
	Template implementation of stream output for single data type based on ROOT dictionary. More...
class	JRootStreamObjectOutput< JTypeList< JHead_t, JTail_t > >
	Template specialisationimplementation of stream object output for multiple data types. More...
class	JRootStreamObjectOutput< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JRootStreamObjectOutput 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	JStyle
	Wrapper class around ROOT TStyle. 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	JTreeWriterObjectOutput< JTypeList< JHead_t, JTail_t > >
	Implementation of JTreeWriterObjectOutput for multiple data types. More...
class	JTreeWriterObjectOutput< JTypeList< JHead_t, JNullType > >
	Terminator class of recursive JTreeWriterObjectOutput class. More...
class	JRootDictionary
	Default implementation of ROOT based dictionary for ASCII I/O. More...

Typedefs
typedef Long64_t	counter_type
	Type definition for counter. 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...
TLegend *	getLegend (const Int_t width, const Int_t height, const std::string option="TR")
	Get legend. More...
template<class JKey_t , class JValue_t >
bool	resetObject (JManager< JKey_t, JValue_t > *object, const bool reset=false)
	Reset JManager object. More...
const TDataMember *	getDataMember (const JRootClass &parent, const JRootClass &member)
	Get ROOT data member for given parent and member class. More...
template<class JType_t , class JClass_t >
const TDataMember *	getDataMember (JType_t JClass_t::*pd)
	Get ROOT data member for given C++ data member. More...
template<class T >
std::vector< TDataMember * >	getListOfDataMembers ()
	Get list of ROOT data members for given class. More...
template<class T >
std::set< JROOTClassSelector >	getROOTClassSelection ()
	Get ROOT class selection. More...
template<class T >
void	getObject (TFile *file, const TString &key, T *&ps)
	Read object from ROOT file. More...
bool	putObject (TDirectory &dir, const TObject &object)
	Write object to ROOT directory. More...
template<class T >
JAssert<!JConversion< T, TObject >::is_derived, bool > ::type	putObject (TDirectory &dir, const T &object)
	Write object to ROOT directory. More...
bool	putObject (TDirectory *dir, const TObject &object)
	Write object to ROOT directory. More...
template<class T >
JAssert<!JConversion< T, TObject >::is_derived, bool > ::type	putObject (TDirectory *dir, const T &object)
	Write object to ROOT directory. 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...
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...
bool	resetObject (TH1 *object, const bool reset=false)
	Detach TH1 object and optionally reset contents. More...
bool	resetObject (TGraph *object, const bool reset=false)
	Detach TGraph object and optionally reset contents. More...
bool	resetObject (TGraphErrors *object, const bool reset=false)
	Detach TGraphErrors object and optionally reset contents. More...
bool	resetObject (TGraph2D *object, const bool reset=false)
	Detach TGraph2D object and optionally reset contents. More...
bool	resetObject (TGraph2DErrors *object, const bool reset=false)
	Detach TGraph2DErrors object and optionally reset contents. More...
bool	resetObject (TMultiGraph *object, const bool reset=false)
	Detach TMultiGraph object and optionally reset contents. More...
bool	resetObject (TTree *object, const bool reset=false)
	Detach TTree object and optionally reset contents. More...
void	AddPoint (TGraph *g1, const Double_t x, const Double_t y)
	Add point to TGraph. More...
void	AddPoint (TGraph2D *g1, const Double_t x, const Double_t y, const Double_t z)
	Add point to TGraph2D. More...
void	AddPoint (TGraphErrors *g1, const Double_t x, const Double_t y, const Double_t ex, const Double_t ey)
	Add point to TGraphErrors. More...
void	AddPoint (TGraph2DErrors *g1, const Double_t x, const Double_t y, const Double_t z, const Double_t ex, const Double_t ey, const Double_t ez)
	Add point to TGraph2DErrors. 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...
TString	parse (const TPRegexp &regexp, const TString &string, const int index=1)
	Match a regular expression with given string and return the specified matched parts. 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 (const TF1 &f1, const Int_t index)
	Check if fit parameter is fixed. More...
template<class T >
Double_t	getResult (const TString &text, const T &object, const JRootDictionary_t &dictionary=JRootDictionary::getInstance())
	Get result of given textual formula. More...
TGraph *	histogramToGraph (const TH1 &h1)
	Helper method to convert a 1D histogram to a graph. More...
TH1 *	projectHistogram (const TH2 &h2, const Double_t xmin, const Double_t xmax, const char projection)
	Helper method for ROOT histogram projections. 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...

Variables
static const char *const	ROOT_FILE_RECOVERY_DISABLE = "ROOT_FILE_RECOVERY_DISABLE"
	Environment variable to disable ROOT file recovery. More...

Detailed Description

Auxiliary classes and methods for ROOT I/O.

Author

mdejong

mdejong, mlincett

Typedef Documentation

typedef Long64_t JROOT::counter_type

Type definition for counter.

Definition at line 24 of file JROOT/JCounter.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 JROOT/JCounter.hh.

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

TLegend* JROOT::getLegend ( const Int_t  width, const Int_t  height, const std::string  option = "TR"  )

inline

Get legend.

Parameters

width	width [characters]
height	height [lines]
option	position [TR TL BL BR]

Returns

legend

Definition at line 28 of file JLegend.hh.

  {
    using namespace std;
      
    gPad->Update();

    const Double_t X1  = 0.0 + gPad->GetLeftMargin();
    const Double_t X2  = 1.0 - gPad->GetRightMargin();
    const Double_t Y1  = 0.0 + gPad->GetBottomMargin();
    const Double_t Y2  = 1.0 - gPad->GetTopMargin();

    const Double_t w   = gPad->XtoPixel(gPad->GetX2());
    const Double_t h   = gPad->YtoPixel(gPad->GetY1());
    const Double_t ch  = gStyle->GetStatFontSize() * (w < h ? w : h);
      
    const Double_t fx  = 0.70 * ch/w;            // estimated font size  [NDC]
    const Double_t fy  = 1.10 * ch/h;            // estimated font size  [NDC]
    const Double_t eps = 0.005;                  // extra space [NDC]
    const Int_t    nc  = 3;                      // number of characters reserved for margin

    Int_t wd = width;
      
    if (wd < 2) {
      wd = 2;
    }
      
    Double_t W  =  (wd + nc) * fx;               // width  [NDC]
    Double_t H  =  (height)  * fy;               // height [NDC]

    Double_t fc = 1.0;                           // scaling factor
      
    if (fc * W > X2 - X1 - 2*eps) {
      fc *= (X2 - X1 - 2*eps) / W;
    }

    if (fc * H > Y2 - Y1 - 2*eps) {
      fc *= (Y2 - Y1 - 2*eps) / H;
    }
      
    W *= fc;
    H *= fc;
      
    // default position is top-right

    Double_t x1  = X2 - W - eps;
    Double_t y1  = Y2 - H - eps;
    Double_t x2  = X2     - eps;
    Double_t y2  = Y2     - eps;

    int halign = 2;
    int valign = 2;
      
    if (option.find('T') != string::npos && option.find('B') == string::npos) {   // top

      y1  = Y2 - H - eps;
      y2  = Y2     - eps;

      //valign = 1;
    }

    if (option.find('B') != string::npos && option.find('T') == string::npos) {   // bottom

      y1  = Y1     + eps;
      y2  = Y1 + H + eps;

      //valign = 3;
    }

    if (option.find('R') != string::npos && option.find('L') == string::npos) {   // right

      x1  = X2 - W - eps;
      x2  = X2     - eps;

      halign = 1;
    }

    if (option.find('L') != string::npos && option.find('R') == string::npos) {   // left

      x1  = X1     + eps;
      x2  = X1 + W + eps;

      halign = 1;
    }

    TLegend* lg = new TLegend(x1, y1, x2, y2);

    lg->SetTextAlign(halign*10 + valign);

    //lg->SetFillStyle(4000);
    lg->SetFillColor(kWhite);
    lg->SetBorderSize(0);
    lg->SetTextAlign(12);
    lg->SetTextFont(gStyle->GetStatFont());
    lg->SetTextSize(gStyle->GetStatFontSize());
    //lg->SetTextSize(lg->GetTextSize() * fc);
    lg->SetMargin((Double_t) nc / (Double_t) (wd + nc));

    return lg;
  }

template<class JKey_t , class JValue_t >

bool JROOT::resetObject ( JManager< JKey_t, JValue_t > *  object, const bool  reset = false  )

inline

Reset JManager object.

Parameters

object	manager
reset	reset contents if true

Returns

true if successful; else false

Definition at line 366 of file JManager.hh.

  {
    if (object->is_valid()) {
      JROOT::resetObject(object->get(), reset);
    }

    for (typename JManager<JKey_t, JValue_t>::iterator i = object->begin(); i != object->end(); ++i) {
      JROOT::resetObject(i->second.get(), reset);
    }

    return true;
  }

const TDataMember* JROOT::getDataMember ( const JRootClass &  parent, const JRootClass &  member  )

inline

Get ROOT data member for given parent and member class.

Parameters

parent	ROOT class
member	ROOT class

Returns

pointer to ROOT data member

Definition at line 637 of file JRootClass.hh.

  {
    if (parent.getClass() != NULL) {

      TIterator* i = NULL;

      i = parent.getClass()->GetListOfDataMembers()->MakeIterator();
    
      for (const TDataMember* p; (p = (const TDataMember*) i->Next()) != NULL; ) {
      
        const JRootClass abc = parent.get(*p);
      
        if (abc == member && abc.getOffset() == member.getOffset()) {
          return p;
        }
      }

      i = parent.getClass()->GetListOfBases()->MakeIterator();
          
      for (const TBaseClass* p; (p = (const TBaseClass*) i->Next()) != NULL; ) {
            
        if (JRootClass::is_class(*p) && !JRootClass::is_STLcontainer(*p)) {
              
          const TDataMember* q = getDataMember(parent.get(*p), member);

          if (q != NULL) {
            return q;
          } 
        }
      }
    }

    return NULL;
  }

template<class JType_t , class JClass_t >

const TDataMember* JROOT::getDataMember ( JType_t JClass_t::*  pd )

inline

Get ROOT data member for given C++ data member.

Parameters

pd	pointer to C++ data member

Returns

pointer to ROOT data member

Definition at line 681 of file JRootClass.hh.

  {
    return getDataMember(JRootClass(getType<JClass_t>()), JRootClass(pd));
  }

template<class T >

std::vector<TDataMember*> JROOT::getListOfDataMembers

(

)

Get list of ROOT data members for given class.

Definition at line 691 of file JRootClass.hh.

  {
    std::vector<TDataMember*> buffer;

    TClass*    rc = (TClass*) TDictionary::GetDictionary(typeid(T));

    TIterator* i  = rc->GetListOfDataMembers()->MakeIterator();

    for (TDataMember* p; (p = (TDataMember*) i->Next()) != NULL; ) {
      if (JRootClass::is_class(p->GetName())) {
        buffer.push_back(p);
      }
    }

    return buffer;
  }

template<class T >

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

inline

Get ROOT class selection.

Returns

ROOT class selection

Definition at line 240 of file JROOTClassSelector.hh.

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

template<class T >

void JROOT::getObject ( TFile *  file, const TString &  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 42 of file JRootFileReader.hh.

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

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

inline

Write object to ROOT directory.

Parameters

dir	directory
object	object

Returns

true if OK; else false

Definition at line 41 of file JRootFileWriter.hh.

  {
    return dir.WriteTObject(&object) > 0;
  }

template<class T >

JAssert<!JConversion<T, TObject>::is_derived, bool>::type JROOT::putObject ( TDirectory &  dir, const T &  object  )

inline

Write object to ROOT directory.

Parameters

dir	directory
object	object

Returns

true if OK; else false

Definition at line 55 of file JRootFileWriter.hh.

  {
    return dir.WriteObject(&object, T::Class_Name()) > 0;
  }

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

inline

Write object to ROOT directory.

Parameters

dir	pointer to directory
object	object

Returns

true if OK; else false

Definition at line 68 of file JRootFileWriter.hh.

  {
    return (dir != NULL && putObject(*dir, object));
  }

template<class T >

JAssert<!JConversion<T, TObject>::is_derived, bool>::type 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 82 of file JRootFileWriter.hh.

  {
    return (dir != NULL && putObject(*dir, object));
  }

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

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 57 of file JRootToolkit.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 70 of file JRootToolkit.hh.

  {
    return T::Class_Name();
  }

bool JROOT::resetObject ( TH1 *  object, const bool  reset = false  )

inline

Detach TH1 object and optionally reset contents.

Parameters

object	ROOT TH1 object
reset	reset contents if true

Returns

true if successful; else false

Definition at line 83 of file JRootToolkit.hh.

  {
    if (object != NULL) {
      
      object->SetDirectory(0);

      if (reset) {
        object->Reset();
      }

      return true;
    }
    
    return false;
  }

bool JROOT::resetObject ( TGraph *  object, const bool  reset = false  )

inline

Detach TGraph object and optionally reset contents.

Parameters

object	ROOT TGraph object
reset	reset contents if true

Returns

true if successful; else false

Definition at line 107 of file JRootToolkit.hh.

  {
    if (object != NULL) {

      if (reset) { 
        for (int i = 0; i != object->GetN(); ++i) {
          object->SetPoint(i, 0.0, 0.0);
        }
      }
        
      return true;
    }
    
    return false;
  }

bool JROOT::resetObject ( TGraphErrors *  object, const bool  reset = false  )

inline

Detach TGraphErrors object and optionally reset contents.

Parameters

object	ROOT TGraphErrors object
reset	reset contents if true

Returns

true if successful; else false

Definition at line 131 of file JRootToolkit.hh.

  {
    if (object != NULL) {

      if (reset) {

        for (int i = 0; i != object->GetN(); ++i) {
          object->SetPoint     (i, 0.0, 0.0);
          object->SetPointError(i, 0.0, 0.0);
        }
      }
        
      return true;
    }
    
    return false;
  }

bool JROOT::resetObject ( TGraph2D *  object, const bool  reset = false  )

inline

Detach TGraph2D object and optionally reset contents.

Parameters

object	ROOT TGraph2D object
reset	reset contents if true

Returns

true if successful; else false

Definition at line 157 of file JRootToolkit.hh.

  {
    if (object != NULL) {

      if (reset) { 
        for (int i = 0; i != object->GetN(); ++i) {
          object->SetPoint(i, 0.0, 0.0, 0.0);
        }
      }
        
      return true;
    }
    
    return false;
  }

bool JROOT::resetObject ( TGraph2DErrors *  object, const bool  reset = false  )

inline

Detach TGraph2DErrors object and optionally reset contents.

Parameters

object	ROOT TGraph2DErrors object
reset	reset contents if true

Returns

true if successful; else false

Definition at line 181 of file JRootToolkit.hh.

  {
    if (object != NULL) {

      if (reset) {
        for (int i = 0; i != object->GetN(); ++i) {
          object->SetPoint     (i, 0.0, 0.0, 0.0);
          object->SetPointError(i, 0.0, 0.0, 0.0);
        }
      }
        
      return true;
    }
    
    return false;
  }

bool JROOT::resetObject ( TMultiGraph *  object, const bool  reset = false  )

inline

Detach TMultiGraph object and optionally reset contents.

Parameters

object	ROOT TMultiGraph object
reset	reset contents if true

Returns

true if successful; else false

Definition at line 206 of file JRootToolkit.hh.

  {
    if (object != NULL) {

      bool status = true;
      
      if (reset) {

        TIter next(object->GetListOfGraphs());

        while (TGraph* graph = (TGraph*)next()) {

          if (!(resetObject(dynamic_cast<TGraph2DErrors*>(graph), reset) ||
                resetObject(dynamic_cast<TGraph2D*>      (graph), reset)) &&
              !(resetObject(dynamic_cast<TGraphErrors*>  (graph), reset) ||
                resetObject                              (graph,  reset)) ) {
            
            status = false;
          }
        }
      }
        
      return status;
    }
    
    return false;
  }

bool JROOT::resetObject ( TTree *  object, const bool  reset = false  )

inline

Detach TTree object and optionally reset contents.

Parameters

object	ROOT TTree object
reset	reset contents if true

Returns

true if successful; else false

Definition at line 242 of file JRootToolkit.hh.

  {
    if (object != NULL) {
      
      object->SetDirectory(0);

      if (reset) {
        object->Reset();
      }

      return true;
    }
    
    return false;
  }

void JROOT::AddPoint ( TGraph *  g1, const Double_t  x, const Double_t  y  )

inline

Add point to TGraph.

Parameters

g1	pointer to valid ROOT TGraph object
x	x value
y	y value

Definition at line 266 of file JRootToolkit.hh.

  {
    const Int_t n = g1->GetN();

    g1->Set(n + 1);
    g1->SetPoint(n, x, y);
  }

void JROOT::AddPoint ( TGraph2D *  g1, const Double_t  x, const Double_t  y, const Double_t  z  )

inline

Add point to TGraph2D.

Parameters

g1	pointer to valid ROOT TGraph object
x	x value
y	y value
z	z value

Definition at line 285 of file JRootToolkit.hh.

  {
    const Int_t n = g1->GetN();

    g1->Set(n + 1);
    g1->SetPoint(n, x, y, z);
  }

void JROOT::AddPoint ( TGraphErrors *  g1, const Double_t  x, const Double_t  y, const Double_t  ex, const Double_t  ey  )

inline

Add point to TGraphErrors.

Parameters

g1	pointer to valid ROOT TGraph object
x	x value
y	y value
ex	x error
ey	y error

Definition at line 306 of file JRootToolkit.hh.

  {
    const Int_t n = g1->GetN();

    g1->Set(n + 1);
    g1->SetPoint(n, x, y);
    g1->SetPointError(n, ex, ey);
  }

void JROOT::AddPoint ( TGraph2DErrors *  g1, const Double_t  x, const Double_t  y, const Double_t  z, const Double_t  ex, const Double_t  ey, const Double_t  ez  )

inline

Add point to TGraph2DErrors.

Parameters

g1	pointer to valid ROOT TGraph object
x	x value
y	y value
z	z value
ex	x error
ey	y error
ez	z error

Definition at line 331 of file JRootToolkit.hh.

  {
    const Int_t n = g1->GetN();

    g1->Set(n + 1);
    g1->SetPoint(n, x, y, z);
    g1->SetPointError(n, ex, ey, ez);
  }

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

inline

Write object to ROOT file.

Parameters

file	ROOT file
object	ROOT object

Returns

ROOT file

Definition at line 354 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 370 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 397 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 413 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 432 of file JRootToolkit.hh.

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

TString JROOT::parse ( const TPRegexp &  regexp, const TString &  string, const int  index = 1  )

inline

Match a regular expression with given string and return the specified matched parts.

If no matches are found corresponding to the specified index, the original string is returned.

Parameters

regexp	regular expression
string	input string
index	index of matched parts (starting at 1)

Returns

matched part of string

Definition at line 450 of file JRootToolkit.hh.

  {
    TPRegexp   buffer = regexp;
    TObjArray* array  = buffer.MatchS(string);

    if (index - 1 < array->GetLast())
      return ((TObjString*) array->At(index))->GetName();
    else
      return string;
  }

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 511 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 532 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 553 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 576 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 ( const TF1 &  f1, const Int_t  index  )

inline

Check if fit parameter is fixed.

Parameters

f1	fit function
index	parameter index

Definition at line 602 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 >

Double_t JROOT::getResult ( const TString &  text, const T &  object, const JRootDictionary_t &  dictionary = JRootDictionary::getInstance()  )

inline

Get result of given textual formula.

The formula may contain names of data members of the given object. For example:

        getResult("a / b.value", object, ..);

In this, the corresponding data type should have (at least) data members a and b and b should have (at least) data member value.

Parameters

text	text
object	object
dictionary	dictionary

Returns

value

Definition at line 637 of file JRootToolkit.hh.

  {
    using namespace std;
    using namespace JPP;

    const TRegexp DOUBLE("[0-9.][eE][+-0-9]");

    string buffer = (const char*) text;

    for (string::size_type pos = 0; pos != buffer.size(); ) {

      if (isalpha(buffer[pos]) || buffer[pos] == '_') {

        string::size_type len = 1;

        while (pos + len != buffer.size() && (isalnum(buffer[pos+len]) || buffer[pos+len] == '_' || buffer[pos+len] == '.')) {
          ++len;
        }

        if (len != 1 || pos == 0 || TString(buffer.substr(pos-1).c_str()).Index(DOUBLE) != 0) {

          ostringstream os;

          os.setf(ios::fixed);
          os.precision(10);

          JRootPrinter::print(os, object, buffer.substr(pos,len), dictionary);

          buffer.replace(pos, len, os.str());

          pos += os.str().size();

          continue;
        }
      }

      pos += 1;
    }

    return TFormula("/tmp", buffer.c_str()).Eval(0.0);
  }

TGraph* JROOT::histogramToGraph ( const TH1 &  h1 )

inline

Helper method to convert a 1D histogram to a graph.

The graph consists of:

• bin centers as x values;
• bin contents as y values.

Note that underflow and overflow bins are ignored.

Parameters

h1	1D histogram

Returns

pointer to newly create graph

Definition at line 694 of file JRootToolkit.hh.

  {
    const int N = h1.GetNbinsX();

    std::vector<double> x(N), y(N);

    for (int i = 0; i < N; i++) {
      x[i] = h1.GetBinCenter (i + 1);
      y[i] = h1.GetBinContent(i + 1);
    }

    return new TGraph(N, &x[0], &y[0]);
  }

TH1* JROOT::projectHistogram ( const TH2 &  h2, const Double_t  xmin, const Double_t  xmax, const char  projection  )

inline

Helper method for ROOT histogram projections.

Parameters

h2	2D histogram
xmin	lower limit
xmax	upper limit
projection	projection (x|X|y|Y)

Returns

pointer to newly created 1D histogram

Definition at line 718 of file JRootToolkit.hh.

  {
    switch (projection) {

    case 'x':
    case 'X':
      return h2.ProjectionX("_px", h2.GetYaxis()->FindBin(xmin), h2.GetYaxis()->FindBin(xmax));

    case 'y':
    case 'Y': 
      return h2.ProjectionY("_py", h2.GetXaxis()->FindBin(xmin), h2.GetXaxis()->FindBin(xmax));

    default:
      return NULL;
    }
  }

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 171 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();
  }

Variable Documentation

const char* const JROOT::ROOT_FILE_RECOVERY_DISABLE = "ROOT_FILE_RECOVERY_DISABLE"

static

Environment variable to disable ROOT file recovery.

If not set or set to 0, allow recovery of ROOT file, else do not.

Definition at line 37 of file JRootFile.hh.