Public Member Functions

ForIA::RootHistogrammer Class Reference

Creates ROOT histograms and stores them in a directory structure by analysis. More...

#include <RootHistogrammer.hh>

Inheritance diagram for ForIA::RootHistogrammer:
ForIA::IHistogrammer

List of all members.

Public Member Functions

 RootHistogrammer (const string &rootFileName="ForIA")
const string & outputName () const
 The name of the output file etc. associated with this histogrammer.
void bookHistogram1D (const string &path, const string &name, const string &title, int nBins, double xMin, double xMax, bool divideBinWidths)
 Book a histogram to be stored at location in the histogram tree.
void bookHistogram1D (const string &path, const string &name, const string &title, const vector< double > &bins, bool divideBinWidths)
 Book a variable bin histogram to be stored at location in the histogram tree.
void bookProfile1D (const string &path, const string &name, const string &title, int nBins, double xMin, double xMax)
 Book a profile to be stored at location in the histogram tree.
void bookHistogram2D (const string &path, const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax, bool divideBinWidths)
 Book a 2D histogram to be stored at location in the histogram tree.
void bookHistogram2D (const string &path, const string &name, const string &title, const vector< double > &xbins, const vector< double > &ybins, bool divideBinWidths)
 Book a variable bin 2D histogram to be stored at location in the histogram tree.
void bookHistogram3D (const string &path, const string &name, const string &title, int nBinsX, double xMin, double xMax, int nBinsY, double yMin, double yMax, int nBinsZ, double zMin, double zMax, bool divideBinWidths)
 Book a 3D histogram to be stored at location in the histogram tree.
void fillHistogram1D (const string &path, const string &name, double value, double weight)
 Book a profile at location "/" in the tree.
void fillProfile1D (const string &path, const string &name, double xVal, double yVal, double weight)
 Fill the profile name at path.
void fillHistogram2D (const string &path, const string &name, double xVal, double yVal, double weight)
 Fill 2D histogram name at path.
void fillHistogram3D (const string &path, const string &name, double xVal, double yVal, double zVal, double weight)
void finalise ()
 Finish the histograms (write them to file etc.)
void normaliseHistogram1D (const string &path, const string &name, double norm=1.)
 Normalise a 1D histogram name at path to a given area (default 1)
void scaleHistogram1D (const string &path, const string &name, double scale=1.)
 Scale a 1D histogram name at path by a given amount.
void normaliseHistogram2D (const string &path, const string &name, double norm=1.)
 Normalise a 2D histogram name at path to a given area (default 1)
void scaleHistogram2D (const string &path, const string &name, double scale=1.)
 Scale a 2D histogram name at path by a given amount.
void showHistograms (std::ostream &out) const
 Print to the screen a list of all of the histograms that exist.

Detailed Description

Creates ROOT histograms and stores them in a directory structure by analysis.

Definition at line 130 of file RootHistogrammer.hh.


Constructor & Destructor Documentation

ForIA::RootHistogrammer::RootHistogrammer ( const string &  rootFileName = "ForIA" )

Constructor

Parameters:
rootFileNamethe name of the ROOT file that will be written to (default = "ForIA")

Definition at line 14 of file RootHistogrammer.cxx.


Member Function Documentation

void ForIA::RootHistogrammer::bookHistogram1D ( const string &  path,
const string &  name,
const string &  title,
int  nBins,
double  xMin,
double  xMax,
bool  divideBinWidths 
) [virtual]

Book a histogram to be stored at location in the histogram tree.

Implements ForIA::IHistogrammer.

Definition at line 25 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::bookHistogram1D ( const string &  path,
const string &  name,
const string &  title,
const vector< double > &  bins,
bool  divideBinWidths 
) [virtual]

Book a variable bin histogram to be stored at location in the histogram tree.

Implements ForIA::IHistogrammer.

Definition at line 50 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::bookHistogram2D ( const string &  path,
const string &  name,
const string &  title,
int  nBinsX,
double  xMin,
double  xMax,
int  nBinsY,
double  yMin,
double  yMax,
bool  divideBinWidths 
) [virtual]

Book a 2D histogram to be stored at location in the histogram tree.

Implements ForIA::IHistogrammer.

Definition at line 87 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::bookHistogram2D ( const string &  path,
const string &  name,
const string &  title,
const vector< double > &  xbins,
const vector< double > &  ybins,
bool  divideBinWidths 
) [virtual]

Book a variable bin 2D histogram to be stored at location in the histogram tree.

Implements ForIA::IHistogrammer.

Definition at line 114 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::bookHistogram3D ( const string &  path,
const string &  name,
const string &  title,
int  nBinsX,
double  xMin,
double  xMax,
int  nBinsY,
double  yMin,
double  yMax,
int  nBinsZ,
double  zMin,
double  zMax,
bool  divideBinWidths 
) [virtual]

Book a 3D histogram to be stored at location in the histogram tree.

Implements ForIA::IHistogrammer.

Definition at line 133 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::bookProfile1D ( const string &  path,
const string &  name,
const string &  title,
int  nBins,
double  xMin,
double  xMax 
) [virtual]

Book a profile to be stored at location in the histogram tree.

Implements ForIA::IHistogrammer.

Definition at line 70 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::fillHistogram1D ( const string &  path,
const string &  name,
double  value,
double  weight 
) [virtual]

Book a profile at location "/" in the tree.

Book a profile at location path in the tree Fill histogram name at path

Implements ForIA::IHistogrammer.

Definition at line 167 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::fillHistogram2D ( const string &  path,
const string &  name,
double  xVal,
double  yVal,
double  weight 
) [virtual]

Fill 2D histogram name at path.

Implements ForIA::IHistogrammer.

Definition at line 201 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::fillHistogram3D ( const string &  path,
const string &  name,
double  xVal,
double  yVal,
double  zVal,
double  weight 
) [virtual]

Implements ForIA::IHistogrammer.

Definition at line 214 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::fillProfile1D ( const string &  path,
const string &  name,
double  xVal,
double  yVal,
double  weight 
) [virtual]

Fill the profile name at path.

Implements ForIA::IHistogrammer.

Definition at line 184 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::finalise (  ) [virtual]

Finish the histograms (write them to file etc.)

Implements ForIA::IHistogrammer.

Definition at line 228 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::normaliseHistogram1D ( const string &  path,
const string &  name,
double  norm = 1. 
) [virtual]

Normalise a 1D histogram name at path to a given area (default 1)

Implements ForIA::IHistogrammer.

Definition at line 336 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::normaliseHistogram2D ( const string &  path,
const string &  name,
double  norm = 1. 
) [virtual]

Normalise a 2D histogram name at path to a given area (default 1)

Implements ForIA::IHistogrammer.

Definition at line 366 of file RootHistogrammer.cxx.

const string & ForIA::RootHistogrammer::outputName (  ) const [virtual]

The name of the output file etc. associated with this histogrammer.

Implements ForIA::IHistogrammer.

Definition at line 20 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::scaleHistogram1D ( const string &  path,
const string &  name,
double  scale = 1. 
) [virtual]

Scale a 1D histogram name at path by a given amount.

Implements ForIA::IHistogrammer.

Definition at line 352 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::scaleHistogram2D ( const string &  path,
const string &  name,
double  scale = 1. 
) [virtual]

Scale a 2D histogram name at path by a given amount.

Implements ForIA::IHistogrammer.

Definition at line 381 of file RootHistogrammer.cxx.

void ForIA::RootHistogrammer::showHistograms ( std::ostream &  out ) const [virtual]

Print to the screen a list of all of the histograms that exist.

Implements ForIA::IHistogrammer.

Definition at line 396 of file RootHistogrammer.cxx.


The documentation for this class was generated from the following files: