NamedBinning Class Reference

#include <NamedBinning.h>

Inheritance diagram for NamedBinning:

[legend]Collaboration diagram for NamedBinning:

[legend]List of all members.

Detailed Description

Abstract base class for function objects that sort events into bins.

A NamedBinning is a Binning with a name, which is entered into the list of named objects

Author: Jenny Böhme, Benno List

Date: 2005/08/23 12:05:44

Author: blist

Changelog:

7.6.05 BL: First version (from BinningFun)
23.8.05 BL: Cosmetic changes

Definition at line 26 of file NamedBinning.h.

Public Member Functions

NamedBinning ()

Default: Create an empty binning.

NamedBinning (int nbins, float xlow, float xup, const char *name=0)

Create an equidistant binning.

NamedBinning (int nbins, float xlow, float xup, const std::string &name)

Create an equidistant binning.

NamedBinning (int nbins, const float binedges_[], const char *name=0)

Create an nonequidistant binning, taking floats.

NamedBinning (int nbins, const float binedges_[], const std::string &name)

Create an nonequidistant binning, taking floats.

NamedBinning (int nbins, const double binedges_[], const char *name=0)

Create an nonequidistant binning, taking doubles.

NamedBinning (int nbins, const double binedges_[], const std::string &name)

Create an nonequidistant binning, taking doubles.

NamedBinning (const Binning &binning_, const char *name=0)

Create a binning from a Binning object.

NamedBinning (const Binning &binning_, const std::string &name)

Create a binning from a Binning object.

virtual int getMaxBins () const

Gets the maximal return value of operator() plus 1, or the higest "sensible" value for a bin number.

Static Public Member Functions

NamedBinning * getObject (const std::string &name)

Access function that returns a pointer to an FloatFun object with this name.

NamedBinning * getObject (const char *name)

Access function that returns a pointer to an NamedO object with this name.

Protected Member Functions

virtual ~NamedBinning ()

Protected destructor to ensure creation on the heap.

Constructor & Destructor Documentation

NamedBinning::NamedBinning ( int nbins,

float xlow,

float xup,

const char * name = 0

) [inline]

Create an equidistant binning.
The binning will have nbins bins between xlow and xup.
Parameters:

nbins The number of bins

xlow The lowest bin edge

xup The highest bin edge

name The object name

Definition at line 34 of file NamedBinning.h.
References NamedO::str().

NamedBinning::NamedBinning ( int nbins,

float xlow,

float xup,

const std::string & name

) [inline]

Create an equidistant binning.
The binning will have nbins bins between xlow and xup.
Parameters:

nbins The number of bins

xlow The lowest bin edge

xup The highest bin edge

name The object name

Definition at line 46 of file NamedBinning.h.

NamedBinning::NamedBinning ( int nbins,

const float binedges_[],

const char * name = 0

) [inline]

Create an nonequidistant binning, taking floats.
The binning will have nbins bins with bin edges given by binedges_. binedges_[i] and binedges_[i+1] are the lower and upper edges of bin i. It is assumed that the binedge values are monotonically increasing.
Parameters:

nbins The number of bins

binedges_ An array with bin edges

name The object name

Definition at line 63 of file NamedBinning.h.
References NamedO::str().

NamedBinning::NamedBinning ( int nbins,

const float binedges_[],

const std::string & name

) [inline]

Create an nonequidistant binning, taking floats.
The binning will have nbins bins with bin edges given by binedges_. binedges_[i] and binedges_[i+1] are the lower and upper edges of bin i. It is assumed that the binedge values are monotonically increasing.
Parameters:

nbins The number of bins

binedges_ An array with bin edges

name The object name

Definition at line 80 of file NamedBinning.h.

NamedBinning::NamedBinning ( int nbins,

const double binedges_[],

const char * name = 0

) [inline]

Create an nonequidistant binning, taking doubles.
The binning will have nbins bins with binedges given by binedges_. binedges_[i] and binedges_[i+1] are the lower and upper edges of bin i. It is assumed that the binedge values are monotonically increasing.
Parameters:

nbins The number of bins

binedges_ An array with bin edges

name The object name

Definition at line 97 of file NamedBinning.h.
References NamedO::str().

NamedBinning::NamedBinning ( int nbins,

const double binedges_[],

const std::string & name

) [inline]

Create an nonequidistant binning, taking doubles.
The binning will have nbins bins with bin edges given by binedges. binedges_[i] and binedges_[i+1] are the lower and upper edges of bin i. It is assumed that the binedge values are monotonically increasing.
Parameters:

nbins The number of bins

binedges_ An array with bin edges

name The object name

Definition at line 115 of file NamedBinning.h.

NamedBinning::NamedBinning ( const Binning & binning_,

const char * name = 0

) [inline]

Create a binning from a Binning object.

Parameters:

binning_ The binning

name The object name

Definition at line 124 of file NamedBinning.h.
References NamedO::str().

NamedBinning::NamedBinning ( const Binning & binning_,

const std::string & name

) [inline]

Create a binning from a Binning object.

Parameters:

binning_ The binning

name The object name

Definition at line 136 of file NamedBinning.h.

Member Function Documentation

NamedBinning* NamedBinning::getObject ( const std::string & name ) [inline, static]

Access function that returns a pointer to an FloatFun object with this name.
This access function must never be called within the constructor of any class that is derived from NamedBinning!
Parameters:

name The name

Reimplemented from NamedO.
Definition at line 156 of file NamedBinning.h.

NamedBinning* NamedBinning::getObject ( const char * name ) [inline, static]

Access function that returns a pointer to an NamedO object with this name.
This access function must never be called within the constructor of any class that is derived from NamedBinning!
Parameters:

name The name

Reimplemented from NamedO.
Definition at line 166 of file NamedBinning.h.

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

NamedBinning.h

Generated on Thu Oct 26 12:54:53 2006 for SFH by

1.3.2


Public Member Functions
	NamedBinning ()
	Default: Create an empty binning.
	NamedBinning (int nbins, float xlow, float xup, const char *name=0)
	Create an equidistant binning.
	NamedBinning (int nbins, float xlow, float xup, const std::string &name)
	Create an equidistant binning.
	NamedBinning (int nbins, const float binedges_[], const char *name=0)
	Create an nonequidistant binning, taking floats.
	NamedBinning (int nbins, const float binedges_[], const std::string &name)
	Create an nonequidistant binning, taking floats.
	NamedBinning (int nbins, const double binedges_[], const char *name=0)
	Create an nonequidistant binning, taking doubles.
	NamedBinning (int nbins, const double binedges_[], const std::string &name)
	Create an nonequidistant binning, taking doubles.
	NamedBinning (const Binning &binning_, const char *name=0)
	Create a binning from a Binning object.
	NamedBinning (const Binning &binning_, const std::string &name)
	Create a binning from a Binning object.
virtual int	getMaxBins () const
	Gets the maximal return value of operator() plus 1, or the higest "sensible" value for a bin number.
Static Public Member Functions
NamedBinning *	getObject (const std::string &name)
	Access function that returns a pointer to an FloatFun object with this name.
NamedBinning *	getObject (const char *name)
	Access function that returns a pointer to an NamedO object with this name.
Protected Member Functions
virtual	~NamedBinning ()
	Protected destructor to ensure creation on the heap.