Bins2DBase Class Reference

#include <Bins2DBase.h>

Inheritance diagram for Bins2DBase:

[legend]

Collaboration diagram for Bins2DBase:

[legend]

List of all members.

Detailed Description

The base class for the 2D binner hierarchy.

Author:

Stephane Bonneaud <gandalf@slac.stanford.edu>

Oded Wurman <oded@slac.stanford.edu>

Matan Shacham <matan@slac.stanford.edu>

Paul F. Kunz <Paul_Kunz@slac.stanford.edu>

Definition at line 30 of file Bins2DBase.h.


Public Member Functions
virtual void	accumulate (double x, double w_or_y=1.0, double z=1.0, double w=1.0)=0
	Accumulates the data point with weight w.
	Bins2DBase (const Bins2DBase &binner)
	The copy constructor.
virtual double	binWidth (hippodraw::Axes::Type axis) const
	Returns the bin width parameter on the specified axis.
double	binWidthX (int i) const
	Gets the bin width of the X bin for the i bin.
double	binWidthY (int i) const
	Gets the bin width of the Y bin for the i bin.
double	calcBinWidth (hippodraw::Axes::Type axis, int parm, bool dragging) const
	Calculates the bin width parameter from dragging slider.
virtual double	calcOffset (const std::string &, int parm, bool dragging) const
	Calculates and returns a new range from dragging slider.
virtual BinsBase *	clone () const =0
	The virtual function to make copy of concrete derived class.
virtual NTuple *	createNTuple () const =0
	Creates an NTuple.
virtual void	fillDataSource (DataSource *ntuple) const =0
	Fills the DataSource.
virtual const BinnerAxis *	getBinnerOn (hippodraw::Axes::Type axis) const
	Returns the BinnerAxis object used by this object.
virtual int	getMinEntries ()
	Get the minimum entries/bin.
virtual int	getNumberOfAxes () const
	Returns the number of axes handled by the BinsBase derived class.
virtual int	getNumberOfEntries () const
	Returns the true number of entries.
virtual double	getOffset (hippodraw::Axes::Type axis) const
	Returns the offset parameter on specific axis.
virtual int	getOverflow () const
	Returns the overflow.
virtual const Range &	getRange (hippodraw::Axes::Type axis)
	Returns range from binner axis.
virtual int	getUnderflow () const
	Returns the underflow.
virtual double	getZValue (double x, double y) const
	Get the z value at the specified point (x,y).
virtual bool	hasEqualWidths () const
	Returns `true` if all bins have the same width.
bool	isDirty ()
	Returns `true` if the re-accumulation is needed.
bool	isEmpty () const
	Returns `true` if no accumulation has yet occurred, otherwise returns `false`.
const std::string &	name () const
	Returns the name of the Bins container object.
int	numberOfBins () const
	Returns the number of bins.
virtual int	numberOfBins (hippodraw::Axes::Type axis) const
	Returns the number of bins on specified axis.
virtual void	reset ()=0
	Resets the accumulation to zero.
virtual double	scaleFactor () const
	Returns the scale factor.
virtual void	scaleNumberOfEntries (double number)
	Sets a scale factor on the output so that the number of entries appears to be number.
virtual void	setBinContents (const DataSource *ntuple)=0
	Sets the contents of the bins from the ntuple.
void	setBinnerOn (BinnerAxis *, hippodraw::Axes::Type axis)
	Sets a new BinnerAxis on the axis axis for the binner to use.
virtual const Range &	setBinWidth (hippodraw::Axes::Type axis, double value)
	Sets the bin width parameter on the specified axis.
void	setDirty ()
	Sets a flag to indicate that re-binning needs to be done.
virtual void	setEntriesScaling (bool on)
	Sets the scaling number of entries on if on is `true`, otherwise turns if off.
virtual void	setMinEntries (int entries)
	Set the minimum entries/bin.
virtual void	setOffset (hippodraw::Axes::Type axis, double value)
	Sets the offset parameter on the specified axis.
virtual const Range &	setRange (hippodraw::Axes::Type axis, const Range &, bool hold_width=true)
	Sets the Range on the specified axis.
	~Bins2DBase ()
	The destructor.
Protected Member Functions
int	binNumberX (double x) const
	Returns the number of the bin in which the x value is situated.
int	binNumberY (double y) const
	Returns the number of the bin in which the y value is situated.
	Bins2DBase (const char *name)
	A constructor that takes bins container name as argument.
virtual double	getLow (hippodraw::Axes::Type axis) const
	Returns the low value of the bins on the specified axis.
virtual NTuple *	prepareNTuple (unsigned int rows) const
	Prepares the NTuple.
virtual void	resize (int nx, int ny)
	Resizes the two dimensional arrays.
void	resize ()
	Resizes the internal arrays.
virtual void	setNumberOfBins (hippodraw::Axes::Type axis, int number)
	Sets the number of bins on the the specified axis.
Protected Attributes
std::vector < std::vector < double > >	m_data
	The accumulated sum of weights.
bool	m_empty
	A flag set to `true`, when no accumulation has yet occurred, otherwise is set `false`.
bool	m_is_scaling
	A flag which is set `true` to enable scaling the output.
int	m_num_bins
	Total number of bins not including overflow and underflow.
double	m_scale_factor
	The scale factor.
bool	m_values_dirty
	A flag to indicate that the objects in m_values are not correct.
Private Attributes
BinnerAxis *	binner_axisX
	The binner axis object for the X axis.
BinnerAxis *	binner_axisY
	The binner axis object for the Y axis.

Constructor & Destructor Documentation

Bins2DBase ( const char * name ) [protected]

A constructor that takes bins container name as argument.

Definition at line 34 of file Bins2DBase.cxx.

Bins2DBase ( const Bins2DBase & binner )

The copy constructor.

Definition at line 41 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, BinnerAxis::clone(), and BinsBase::m_values_dirty.

~Bins2DBase ( )

The destructor.

Definition at line 58 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, and Bins2DBase::binner_axisY.

Member Function Documentation

virtual void accumulate	(	double	x,
		double	w_or_y = `1.0`,
		double	z = `1.0`,
		double	w = `1.0`
	)			`[pure virtual, inherited]`

Accumulates the data point with weight w.

Some derived class implementations make take second argument as the weight and ignore the remaining. Similarly for the third and fourth arguments.

Implemented in Bins1DHist, Bins1DProfile, Bins2DHist, and Bins2DProfile.

Referenced by ProfileProjector::execute(), Profile2DProjector::execute(), DyHist2DProjector::execute(), and DyHist1DProjector::execute().

int binNumberX ( double x ) const [protected]

Returns the number of the bin in which the x value is situated.

Definition at line 164 of file Bins2DBase.cxx.

References BinnerAxis::axisBinNumber(), and Bins2DBase::binner_axisX.

Referenced by Bins2DProfile::accumulate(), Bins2DHist::accumulate(), Bins2DProfile::getZValue(), and Bins2DHist::getZValue().

int binNumberY ( double y ) const [protected]

Returns the number of the bin in which the y value is situated.

Definition at line 169 of file Bins2DBase.cxx.

References BinnerAxis::axisBinNumber(), and Bins2DBase::binner_axisY.

Referenced by Bins2DProfile::accumulate(), Bins2DHist::accumulate(), Bins2DProfile::getZValue(), and Bins2DHist::getZValue().

double binWidth ( hippodraw::Axes::Type axis ) const [virtual]

Returns the bin width parameter on the specified axis.

If the bins have all the same width, then returns the bin width. If the bin width are determined by some algorithm, then returns a parameter used to calculate the bin widths.

Implements BinsBase.

Definition at line 176 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, BinnerAxis::getConstWid(), hippodraw::Axes::X, and hippodraw::Axes::Y.

double binWidthX ( int i ) const

Gets the bin width of the X bin for the i bin.

Definition at line 185 of file Bins2DBase.cxx.

References BinnerAxis::axisBinWidth(), and Bins2DBase::binner_axisX.

Referenced by Bins2DProfile::fillDataSource(), Bins2DHist::fillDataSource(), Bins2DHist::getZValue(), and Bins2DHist::setBinContents().

double binWidthY ( int i ) const

Gets the bin width of the Y bin for the i bin.

Definition at line 190 of file Bins2DBase.cxx.

References BinnerAxis::axisBinWidth(), and Bins2DBase::binner_axisY.

Referenced by Bins2DProfile::fillDataSource(), Bins2DHist::fillDataSource(), Bins2DHist::getZValue(), and Bins2DHist::setBinContents().

double calcBinWidth	(	hippodraw::Axes::Type	axis,
		int	parm,
		bool	dragging
	)			const `[virtual]`

Calculates the bin width parameter from dragging slider.

Implements BinsBase.

Definition at line 236 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, BinnerAxis::calcBinWidth(), and hippodraw::Axes::X.

double calcOffset	(	const std::string &	axis,
		int	parm,
		bool	dragging
	)			const `[virtual]`

Calculates and returns a new range from dragging slider.

Implements BinsBase.

Definition at line 251 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, and BinnerAxis::calcOffset().

virtual BinsBase* clone ( ) const [pure virtual, inherited]

The virtual function to make copy of concrete derived class.

Implemented in Bins1DHist, Bins1DProfile, Bins2DHist, and Bins2DProfile.

Referenced by BinningProjector::BinningProjector().

virtual NTuple* createNTuple ( ) const [pure virtual, inherited]

Creates an NTuple.

Derived classes will return an NTuple appropriate to their binned data. They should at least contain the coordinates, error on the coordinates, the value, and error on the value.

Implemented in Bins1DHist, Bins1DProfile, Bins2DHist, and Bins2DProfile.

Referenced by BinningProjector::createNTuple().

virtual void fillDataSource ( DataSource * ntuple ) const [pure virtual, inherited]

Fills the DataSource.

Clears and fills the DataSource based on the contents of the bins. The resulting DataSource is follows the standard defined in hippodraw::DataPoint2DTuple or hippodraw::DataPoint3DTuple.

Implemented in Bins1DHist, Bins1DProfile, Bins2DHist, and Bins2DProfile.

const BinnerAxis * getBinnerOn ( hippodraw::Axes::Type axis ) const [virtual]

Returns the BinnerAxis object used by this object.

Implements BinsBase.

Definition at line 84 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, hippodraw::Axes::X, and hippodraw::Axes::Y.

double getLow ( hippodraw::Axes::Type axis ) const [protected, virtual]

Returns the low value of the bins on the specified axis.

Implements BinsBase.

Definition at line 116 of file Bins2DBase.cxx.

References BinnerAxis::axisGetLow(), Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, hippodraw::Axes::X, and hippodraw::Axes::Y.

Referenced by Bins2DProfile::fillDataSource(), and Bins2DHist::fillDataSource().

int getMinEntries ( ) [virtual, inherited]

Get the minimum entries/bin.

Reimplemented in Bins1DHist.

Definition at line 109 of file BinsBase.cxx.

int getNumberOfAxes ( ) const [virtual]

Returns the number of axes handled by the BinsBase derived class.

Implements BinsBase.

Definition at line 66 of file Bins2DBase.cxx.

int getNumberOfEntries ( ) const [virtual]

Returns the true number of entries.

Returns the sum of the weight parameter of the accumulate member function.

Implements BinsBase.

Definition at line 341 of file Bins2DBase.cxx.

References Bins2DBase::m_data.

Referenced by Bins2DHist::fillDataSource().

double getOffset ( hippodraw::Axes::Type axis ) const [virtual]

Returns the offset parameter on specific axis.

Implements BinsBase.

Definition at line 264 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, BinnerAxis::getOffset(), hippodraw::Axes::X, and hippodraw::Axes::Y.

int getOverflow ( ) const [virtual]

Returns the overflow.

Implements BinsBase.

Definition at line 356 of file Bins2DBase.cxx.

const Range & getRange ( hippodraw::Axes::Type axis ) [virtual]

Returns range from binner axis.

Implements BinsBase.

Definition at line 309 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, BinnerAxis::getRange(), hippodraw::Axes::X, and hippodraw::Axes::Y.

int getUnderflow ( ) const [virtual]

Returns the underflow.

Implements BinsBase.

Definition at line 351 of file Bins2DBase.cxx.

double getZValue	(	double	x,
		double	y
	)			const `[virtual, inherited]`

Get the z value at the specified point (x,y).

Reimplemented in Bins2DHist, and Bins2DProfile.

Definition at line 74 of file BinsBase.cxx.

Referenced by BinningProjector::getZValue().

bool hasEqualWidths ( ) const [virtual]

Returns true if all bins have the same width.

See also:: BinnerAxis::hasEqualWidths.

Implements BinsBase.

Definition at line 196 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, and BinnerAxis::hasEqualWidths().

bool isDirty ( ) [inherited]

Returns true if the re-accumulation is needed.

Definition at line 59 of file BinsBase.cxx.

References BinsBase::m_values_dirty.

bool isEmpty ( ) const [inherited]

Returns true if no accumulation has yet occurred, otherwise returns false.

Definition at line 81 of file BinsBase.cxx.

References BinsBase::m_empty.

const string & name ( ) const [inherited]

Returns the name of the Bins container object.

Definition at line 54 of file BinsBase.cxx.

References BinsBase::m_name.

Referenced by BinsBaseXML::createElement().

int numberOfBins ( ) const

Returns the number of bins.

Definition at line 145 of file Bins2DBase.cxx.

References Bins2DBase::m_num_bins.

Referenced by Bins2DProfile::accumulate(), Bins2DHist::accumulate(), Bins2DProfile::createNTuple(), Bins2DHist::createNTuple(), Bins2DProfile::fillDataSource(), Bins2DHist::fillDataSource(), Bins2DBase::resize(), Bins2DHist::setBinContents(), Bins2DProfile::setNumberOfBins(), Bins2DHist::setNumberOfBins(), and Bins2DBase::setNumberOfBins().

int numberOfBins ( hippodraw::Axes::Type axis ) const [virtual]

Returns the number of bins on specified axis.

If a BinnerAxis object does not exist, returns 0.

Implements BinsBase.

Definition at line 152 of file Bins2DBase.cxx.

References BinnerAxis::axisNumberOfBins(), Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, hippodraw::Axes::X, and hippodraw::Axes::Y.

NTuple * prepareNTuple ( unsigned int rows ) const [protected, virtual]

Prepares the NTuple.

Creates and returns the NTuple that will be filled from the binner's values. The NTuple will have rows rows and 6 columns.

Implements BinsBase.

Definition at line 364 of file Bins2DBase.cxx.

Referenced by Bins2DProfile::createNTuple(), and Bins2DHist::createNTuple().

virtual void reset ( ) [pure virtual, inherited]

Resets the accumulation to zero.

Implemented in Bins1DHist, Bins1DProfile, Bins2DHist, and Bins2DProfile.

Referenced by ProfileProjector::execute(), Profile2DProjector::execute(), DyHist2DProjector::execute(), and DyHist1DProjector::execute().

void resize	(	int	nx,
		int	ny
	)			`[protected, virtual]`

Resizes the two dimensional arrays.

Todo:: It is possible that this method will get called before both the range and the bin width are final and therefore the number of bins could be excessive. Thus it would be better to postpone the resizing until needed.

Definition at line 330 of file Bins2DBase.cxx.

References BinsBase::m_values_dirty, Bins2DBase::setNumberOfBins(), hippodraw::Axes::X, and hippodraw::Axes::Y.

void resize ( ) [protected]

Resizes the internal arrays.

Takes the size in each dimension from the BinnerAxis objects. If either size is 0, then does nothing.

Definition at line 71 of file Bins2DBase.cxx.

References Bins2DBase::numberOfBins(), hippodraw::Axes::X, and hippodraw::Axes::Y.

Referenced by Bins2DBase::setBinnerOn(), Bins2DBase::setBinWidth(), and Bins2DBase::setRange().

double scaleFactor ( ) const [virtual]

Returns the scale factor.

Used to convert the projected value to number of entries in a bin. The default, implemented here, is to return 1.0. Derived class, such as those that do binning, may return a value to reflect their binning algorithm.

Reimplemented from BinsBase.

Definition at line 202 of file Bins2DBase.cxx.

References BinnerAxis::axisBinWidth(), Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, and BinnerAxis::hasEqualWidths().

void scaleNumberOfEntries ( double number ) [virtual, inherited]

Sets a scale factor on the output so that the number of entries appears to be number.

This feature might be used, for example, to compare two histograms that have different number of entires by normalizing one to the other.

Definition at line 88 of file BinsBase.cxx.

References BinsBase::m_scale_factor.

virtual void setBinContents ( const DataSource * ntuple ) [pure virtual, inherited]

Sets the contents of the bins from the ntuple.

Sets the contents of the bins from the ntuple. The purpose of this method is to restore a histogram from archived file. The ntuple should be cone filled by the fillDataSource method.

Implemented in Bins1DHist, Bins1DProfile, Bins2DHist, and Bins2DProfile.

void setBinnerOn	(	BinnerAxis *	binner,
		hippodraw::Axes::Type	axis
	)			`[virtual]`

Sets a new BinnerAxis on the axis axis for the binner to use.

The old one, if any, will be destroyed. Raises an assertion if axis is not X or Y.

Implements BinsBase.

Definition at line 97 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, BinsBase::m_values_dirty, Bins2DBase::resize(), hippodraw::Axes::X, and hippodraw::Axes::Y.

const Range & setBinWidth	(	hippodraw::Axes::Type	axis,
		double	value
	)			`[virtual]`

Sets the bin width parameter on the specified axis.

Implements BinsBase.

Definition at line 217 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, BinsBase::m_values_dirty, Bins2DBase::resize(), BinnerAxis::setBinWidth(), hippodraw::Axes::X, and hippodraw::Axes::Y.

void setDirty ( ) [inherited]

Sets a flag to indicate that re-binning needs to be done.

Definition at line 64 of file BinsBase.cxx.

References BinsBase::m_values_dirty.

Referenced by ProfileProjector::changedNTuple(), Profile2DProjector::changedNTuple(), DyHist2DProjector::changedNTuple(), and DyHist1DProjector::changedNTuple().

void setEntriesScaling ( bool on ) [virtual, inherited]

Sets the scaling number of entries on if on is true, otherwise turns if off.

Definition at line 95 of file BinsBase.cxx.

References BinsBase::m_is_scaling.

void setMinEntries ( int entries ) [virtual, inherited]

Set the minimum entries/bin.

Reimplemented in Bins1DHist.

Definition at line 103 of file BinsBase.cxx.

void setNumberOfBins	(	hippodraw::Axes::Type	axis,
		int	number
	)			`[protected, virtual]`

Sets the number of bins on the the specified axis.

Implements BinsBase.

Reimplemented in Bins2DHist, and Bins2DProfile.

Definition at line 127 of file Bins2DBase.cxx.

References BinnerAxis::axisSetNumberOfBins(), Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, Bins2DBase::m_num_bins, Bins2DBase::numberOfBins(), hippodraw::Axes::X, and hippodraw::Axes::Y.

Referenced by Bins2DBase::resize(), Bins2DProfile::setNumberOfBins(), and Bins2DHist::setNumberOfBins().

void setOffset	(	hippodraw::Axes::Type	axis,
		double	value
	)			`[virtual]`

Sets the offset parameter on the specified axis.

Implements BinsBase.

Definition at line 275 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, BinsBase::m_values_dirty, BinnerAxis::setOffset(), hippodraw::Axes::X, and hippodraw::Axes::Y.

const Range & setRange	(	hippodraw::Axes::Type	axis,
		const Range &	,
		bool	hold_width = `true`
	)			`[virtual]`

Sets the Range on the specified axis.

If hold_width is true, the bin width parameter will be held constant, otherwise it is adjusted to keep the same number of bins for the new range.

Implements BinsBase.

Definition at line 290 of file Bins2DBase.cxx.

References Bins2DBase::binner_axisX, Bins2DBase::binner_axisY, Bins2DBase::resize(), BinnerAxis::setRange(), hippodraw::Axes::X, and hippodraw::Axes::Y.

Member Data Documentation

BinnerAxis* binner_axisX [private]

The binner axis object for the X axis.

Definition at line 36 of file Bins2DBase.h.

Referenced by Bins2DBase::binNumberX(), Bins2DBase::Bins2DBase(), Bins2DBase::binWidth(), Bins2DBase::binWidthX(), Bins2DBase::calcBinWidth(), Bins2DBase::calcOffset(), Bins2DBase::getBinnerOn(), Bins2DBase::getLow(), Bins2DBase::getOffset(), Bins2DBase::getRange(), Bins2DBase::hasEqualWidths(), Bins2DBase::numberOfBins(), Bins2DBase::scaleFactor(), Bins2DBase::setBinnerOn(), Bins2DBase::setBinWidth(), Bins2DBase::setNumberOfBins(), Bins2DBase::setOffset(), Bins2DBase::setRange(), and Bins2DBase::~Bins2DBase().

BinnerAxis* binner_axisY [private]

The binner axis object for the Y axis.

Definition at line 39 of file Bins2DBase.h.

Referenced by Bins2DBase::binNumberY(), Bins2DBase::Bins2DBase(), Bins2DBase::binWidth(), Bins2DBase::binWidthY(), Bins2DBase::calcBinWidth(), Bins2DBase::calcOffset(), Bins2DBase::getBinnerOn(), Bins2DBase::getLow(), Bins2DBase::getOffset(), Bins2DBase::getRange(), Bins2DBase::hasEqualWidths(), Bins2DBase::numberOfBins(), Bins2DBase::scaleFactor(), Bins2DBase::setBinnerOn(), Bins2DBase::setBinWidth(), Bins2DBase::setNumberOfBins(), Bins2DBase::setOffset(), Bins2DBase::setRange(), and Bins2DBase::~Bins2DBase().

std::vector<std::vector<double> > m_data [protected]

The accumulated sum of weights.

If all calls to accumulate have weight of 1.0, the default, then will be number of entries. For each vector, index 0 is the underflow, while the last element is the overflow.

Definition at line 48 of file Bins2DBase.h.

Referenced by Bins2DProfile::accumulate(), Bins2DHist::accumulate(), Bins2DProfile::fillDataSource(), Bins2DHist::fillDataSource(), Bins2DBase::getNumberOfEntries(), Bins2DProfile::getZValue(), Bins2DHist::getZValue(), Bins2DProfile::reset(), Bins2DHist::reset(), Bins2DHist::setBinContents(), Bins2DProfile::setNumberOfBins(), and Bins2DHist::setNumberOfBins().