RRootFilesFunctions.hh

Go to the documentation of this file.

//======================================================================
/*! \file RRootFilesFunctions.hh
 *
 *  Include file for functions related to ROOT files.
 */
//======================================================================

#ifndef R_ROOT_FILE_FUNCTIONS_HH
#define R_ROOT_FILE_FUNCTIONS_HH

#include <TH1.h>

#include "RBaseFunctions.hh"
#include "RObject.hh"

#include "GTreeNodeT.hh"

//----------------------------------------------------------------------
// Reading objects in a ROOT file
extern  TH1     * RGetFileHisto   ( TDirectory * dir,       const char histo_name[], bool recur = true );
extern  TH1     * RGetFileHisto   ( const char file_name[], const char histo_name[] );

//----------------------------------------------------------------------
// Functions related to histograms in a ROOT file
extern  Int_t   RGetHistoNames ( const char file_name[],
                                 string  *& histo_names,
                                 Int_t   *& histo_dim,
                                 Int_t      dmin = 1,
                                 Int_t      dmax = 3);

extern  Int_t   RGetHistoNames ( const char file_name[],
                                 string  *& histo_names,
                                 Int_t      dmin = 1,
                                 Int_t      dmax = 3);

//----------------------------------------------------------------------
// Creating an arborescence of selected ROOT objects from a ROOT file

extern bool   RCheckDirObjects ( TDirectory * dir, const string & obj_class, bool recur = true );
extern u_int  RCountDirObjects ( TDirectory * dir, const string & obj_class, bool recur = true );

extern RTreeBranchTObject * RGetObjectTree ( TDirectory * dir, const string & obj_class );

//----------------------------------------------------------------------

extern bool   RCheckDirHisto   ( TDirectory * dir, bool recur = true );   // inline
extern u_int  RCountDirHisto   ( TDirectory * dir, bool recur = true );   // inline

extern RTreeBranchTObject * RGetHistoTree  ( TDirectory * dir, bool local = true );


//======================================================================
// inline functions

/*! This function returns "true" if the ROOT directory contains one or
 *  more histograms.
 *  \param  dir     ROOT directory
 *  \param  recur   recursive search in sub-directories
 */
inline bool RCheckDirHisto ( TDirectory * dir, bool recur )
  { return ( RCheckDirObjects ( dir, "TH1", recur ) ); }

/*! This function returns the number of ROOT histograms in the directory.
 *  If several versions of the histograms exist, they are counted only once.
 *  \param  dir         ROOT directory
 *  \param  recur       recursive search in sub-directories
 */
inline u_int RCountDirHisto ( TDirectory * dir, bool recur )
  { return ( RCountDirObjects ( dir, "TH1", recur ) ); }

//======================================================================
#endif