RBase.hh

Go to the documentation of this file.

//======================================================================
/*! \file RBase.hh
 *
 *  Base include file, and general documentation.
 */
//======================================================================

#ifndef R_BASE_HH
#define R_BASE_HH

//----------------------------------------------------------------------
// base functions includes
#include "RBaseFunctions.hh"
#include "RHistoFunctions.hh"
#include "RGraphFunctions.hh"

#include "RMathConstants.hh"

//----------------------------------------------------------------------
/*! \page jg_RBase General purpose functions and classes for use with ROOT
 *
 *  - \ref jg_RBase_histo
 *
 *  - \ref jg_RBase_graph
 */


//----------------------------------------------------------------------
/*! \page jg_RBase_histo ROOT histograms related functions
 *
 *  - reading histograms in a ROOT file: \ref RReadHisto
 *
 *  - 1D / 2D histogram smoothing: \ref RSmoothHisto (\ref RSmoothHisto1D or
 *    \ref RSmoothHisto2D)
 *
 *  - correlation calculation for a 2D histogram:
 *    \ref RGetHistoCorrelation
 *
 *  - 1D histogram plotting with error: \ref RDrawHistoError
 *    et \ref RGetHistoErrorLimits
 */

//----------------------------------------------------------------------
/*! \page jg_RBase_graph ROOT graphs related functions
 *
 *  - extracting a serie of graphs \b (x,y) with a constant \b p value from a
 *    (p,x,y) table: \ref RGetGraphSeries
 *
 *  - extracting a serie of 2D lines \b (x,y)  or 3D lines \b (x,y,z) with
 *    a constant \b p value from a (p,x,y) or a (p,x,y,z) table:
 *    (p,x,y) tables: \ref RGetPolyLineSeries et \ref RGetPolyLine3DSeries
 *
 */

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