BinnedHistogram Class Template Reference

#include <BinnedHistogram.hh>

Inheritance diagram for BinnedHistogram:

[legend]

Collaboration diagram for BinnedHistogram:

[legend]

List of all members.

---

Detailed Description

template<typename T>
class Rivet::BinnedHistogram< T >

BinnedHistogram contains a series of histograms of the same quantity each in a different region of a second quantity. For example, a BinnedHistogram may contain histograms of the cross section differential in PT in different eta regions.

Definition at line 16 of file BinnedHistogram.hh.

Public Member Functions
	BinnedHistogram ()
	Create a new empty BinnedHistogram.
const BinnedHistogram< T > &	addHistogram (const T &binMin, const T &binMax, AIDA::IHistogram1D *histo)
AIDA::IHistogram1D *	fill (const T &bin, const T &val, double weight)
const vector < AIDA::IHistogram1D * > &	getHistograms () const
vector< AIDA::IHistogram1D * > &	getHistograms ()
Private Attributes
map< T, AIDA::IHistogram1D * >	_histosByUpperBound
map< T, AIDA::IHistogram1D * >	_histosByLowerBound
vector< AIDA::IHistogram1D * >	_histos

---

Constructor & Destructor Documentation

BinnedHistogram

(

)

[inline]

Create a new empty BinnedHistogram.

Definition at line 20 of file BinnedHistogram.hh.

                      {
      return;
    }

---

Member Function Documentation

const BinnedHistogram< T > & addHistogram	(	const T &	binMin,
		const T &	binMax,
		AIDA::IHistogram1D *	histo
	)			[inline]

Add a histogram in the region between binMin and binMax to this set of BinnedHistograms.

Definition at line 10 of file BinnedHistogram.cc.

References BinnedHistogram::_histos, BinnedHistogram::_histosByLowerBound, and BinnedHistogram::_histosByUpperBound.

Referenced by D0_2010_S8570965::init(), D0_2010_S8566488::init(), D0_2009_S8320160::init(), D0_1996_S3324664::init(), CDF_2008_S7828950::init(), CDF_2007_S7057202::init(), CDF_2001_S4517016::init(), and CDF_1996_S3418421::init().

                                                                                     {
    if (binMin > binMax) {
      throw Error
        ("Cannot add a binned histogram where the lower bin edge is above the upper edge");
    } 
    _histosByUpperBound[binMax] = histo;
    _histosByLowerBound[binMin] = histo;
    bool found = false;
    foreach (AIDA::IHistogram1D* hist, _histos) {
      if (hist == histo) {
        found = true;
        break;
      }
    }
    
    if (!found){
      _histos.push_back(histo);
    }
    
    return *this;
  }

AIDA::IHistogram1D * fill	(	const T &	bin,
		const T &	val,
		double	weight
	)			[inline]

Fill the histogram that lies in the same region as bin with the value val of weight weight.

Definition at line 37 of file BinnedHistogram.cc.

References BinnedHistogram::_histosByLowerBound, and BinnedHistogram::_histosByUpperBound.

Referenced by D0_2010_S8570965::analyze(), D0_2010_S8566488::analyze(), D0_2009_S8320160::analyze(), D0_1996_S3324664::analyze(), CDF_2008_S7828950::analyze(), CDF_2007_S7057202::analyze(), CDF_2001_S4517016::analyze(), and CDF_1996_S3418421::analyze().

                                                                    {

    typename map<T, AIDA::IHistogram1D*>::iterator histIt =
      _histosByUpperBound.upper_bound(bin);
    //check that the bin is not out of range
    if (histIt == _histosByUpperBound.end()) {
      return 0;
    }
 
    AIDA::IHistogram1D* histo = histIt->second;
    histIt = _histosByLowerBound.lower_bound(bin);

    // No need to check going beyond the upper bound if we already passed above
    // (given that upper bound > lower bound is checked)
    // Check it is not before the start of the map
    if (histIt == _histosByLowerBound.begin()) {
      return 0;
    }
    // By-lower-bound actually gives us the iterator one above the nearest element,
    // so decrement it. This is safe because we already checked we're not at the start!
    --histIt;
 
    if (histo != histIt->second) {
      return 0;
    }
    
    histo->fill(val, weight);
    
    return histo;
  }

const vector<AIDA::IHistogram1D*>& getHistograms

(

)

const [inline]

Definition at line 36 of file BinnedHistogram.hh.

Referenced by D0_2010_S8570965::finalize(), D0_2010_S8566488::finalize(), D0_2009_S8320160::finalize(), D0_1996_S3324664::finalize(), CDF_2008_S7828950::finalize(), CDF_2001_S4517016::finalize(), CDF_1996_S3418421::finalize(), CDF_2008_S7828950::init(), and CDF_2007_S7057202::init().

{ return _histos; }

vector<AIDA::IHistogram1D*>& getHistograms

(

)

[inline]

Definition at line 37 of file BinnedHistogram.hh.

{ return _histos; }

---

Member Data Documentation

map<T, AIDA::IHistogram1D*> _histosByUpperBound [private]

Definition at line 42 of file BinnedHistogram.hh.

Referenced by BinnedHistogram::addHistogram(), and BinnedHistogram::fill().

map<T, AIDA::IHistogram1D*> _histosByLowerBound [private]

Definition at line 43 of file BinnedHistogram.hh.

Referenced by BinnedHistogram::addHistogram(), and BinnedHistogram::fill().

vector<AIDA::IHistogram1D*> _histos [private]

Definition at line 44 of file BinnedHistogram.hh.

Referenced by BinnedHistogram::addHistogram(), and BinnedHistogram< double >::getHistograms().

---

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

• BinnedHistogram.hh
• BinnedHistogram.cc