The class for the one-dimensional histogram binning. More...
#include <Bins1DHist.h>
Public Member Functions | |
virtual void | accumulate (double x, double w=1.0, double i1=0.0, double i2=0.0) |
Accumulates a data point x into a bin with weight w. | |
int | binNumber (double x) |
Returns the number of the bin in which the x value is situated. | |
Bins1DHist () | |
The default constructor. | |
Bins1DHist (const Bins1DHist &binner) | |
The copy constructor. | |
double | binWidth (int i) const |
Returns the width of each bin. | |
virtual double | binWidth (hippodraw::Axes::Type axis) const |
Returns the bin width parameter on the specified axis. | |
double | calcBinWidth (hippodraw::Axes::Type axis, int parm, bool dragging) const |
Calculates the bin width from dragging slider. | |
virtual double | calcOffset (const std::string &, int parm, bool dragging) const |
Calculates and returns a new range from dragging slider. | |
BinsBase * | clone () const |
The clone function returns an object of its own kind which is a copy of this object at this moment. | |
virtual NTuple * | createNTuple () const |
Creates a NTuple. | |
virtual void | fillDataSource (DataSource *ntuple) const |
Fills the DataSource. | |
virtual const BinnerAxis * | getBinnerOn (hippodraw::Axes::Type axis) const |
Returns the BinnerAxis object used by this object. | |
double | getHigh () const |
Returns the lower edge of the last + 1 bin through binner_axis. | |
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 |
implementation from pure base | |
virtual int | getNumberOfEntries (int i) const |
implementation from pure base | |
virtual double | getOffset (hippodraw::Axes::Type axis) const |
Returns the offset parameter on specific axis. | |
virtual int | getOverflow () const |
implementation from pure base | |
virtual const Range & | getRange (hippodraw::Axes::Type axis) |
Returns range from binner axis. | |
virtual int | getUnderflow () const |
implementation from pure base | |
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 . | |
double | maxBin () |
Returns the value of the bin with the largest value. | |
double | minBin () |
Returns the value of the bin with the smallest value. | |
const std::string & | name () const |
Returns the name of the Bins container object. | |
virtual int | numberOfBins (hippodraw::Axes::Type axis) const |
Returns the number of bins on specified axis. | |
virtual void | reset () |
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) |
virtual void | setBinnerOn (BinnerAxis *, hippodraw::Axes::Type axis) |
Sets a new BinnerAxis 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 | setNumberOfBins (hippodraw::Axes::Type axis, int num_bins) |
Sets the number of bins on the the specified axis. | |
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. | |
virtual | ~Bins1DHist () |
The destructor. |
Protected Member Functions | |
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. |
Protected Attributes | |
BinnerAxis * | binner_axis |
The binner axis object. | |
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. | |
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 Member Functions | |
virtual void | resize (int size) |
Resizes the internal arrays. |
Private Attributes | |
std::vector< double > | m_data |
The array of binned data. | |
int | m_min_entries |
The minimum number of entries/bin. | |
double | m_moments [3] |
The moments. | |
std::vector< double > | m_variance |
The accumulated square of the weights. |
The class for the one-dimensional histogram binning.
Definition at line 38 of file Bins1DHist.h.
Bins1DHist | ( | ) |
The default constructor.
Definition at line 38 of file Bins1DHist.cxx.
References Bins1DHist::m_min_entries.
Referenced by Bins1DHist::clone().
Bins1DHist | ( | const Bins1DHist & | binner | ) |
The copy constructor.
Definition at line 44 of file Bins1DHist.cxx.
References Bins1DHist::m_moments.
|
virtual |
The destructor.
Definition at line 59 of file Bins1DHist.cxx.
|
virtual |
Accumulates a data point x into a bin with weight w.
The remaining arguments are ignored.
Implements BinsBase.
Definition at line 115 of file Bins1DHist.cxx.
References Bins1DBase::binNumber(), Bins1DHist::m_data, BinsBase::m_empty, Bins1DHist::m_moments, and Bins1DHist::m_variance.
Referenced by Bins1DHist::fillDataSource(), and Bins1DHist::getNumberOfEntries().
|
inlineinherited |
Returns the number of the bin in which the x value is situated.
Definition at line 137 of file Bins1DBase.h.
References BinnerAxis::axisBinNumber(), and Bins1DBase::binner_axis.
Referenced by Bins1DHist::accumulate(), and Bins1DProfile::accumulate().
|
inherited |
Returns the width of each bin.
Returns the width of the bin with index i. The first bin has index 0 and the last bin has index of number of bins minus 1.
Definition at line 113 of file Bins1DBase.cxx.
References BinnerAxis::axisBinWidth(), and Bins1DBase::binner_axis.
Referenced by Bins1DProfile::fillDataSource(), and Bins1DHist::fillDataSource().
|
virtualinherited |
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 125 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, BinnerAxis::getConstWid(), and hippodraw::Axes::X.
|
virtualinherited |
Calculates the bin width from dragging slider.
Implements BinsBase.
Definition at line 146 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, BinnerAxis::calcBinWidth(), and hippodraw::Axes::X.
|
virtualinherited |
Calculates and returns a new range from dragging slider.
Implements BinsBase.
Definition at line 155 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, and BinnerAxis::calcOffset().
|
virtual |
The clone function returns an object of its own kind which is a copy of this object at this moment.
Implements BinsBase.
Definition at line 54 of file Bins1DHist.cxx.
References Bins1DHist::Bins1DHist().
|
virtual |
Creates a NTuple.
Creates and returns an NTuple based on the contents of the bins. The receiver takes possession of the NTuple object. The columns in the NTuple are in order: X position, value, X width, and error on value.
Implements BinsBase.
Definition at line 131 of file Bins1DHist.cxx.
References Bins1DHist::fillDataSource(), Bins1DHist::m_data, Bins1DBase::prepareNTuple(), and num_util::size().
|
virtual |
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.
Implements BinsBase.
Definition at line 145 of file Bins1DHist.cxx.
References Bins1DHist::accumulate(), Bins1DBase::binWidth(), Bins1DBase::getLow(), Bins1DHist::m_data, BinsBase::m_is_scaling, Bins1DHist::m_min_entries, BinsBase::m_scale_factor, Bins1DHist::m_variance, DataSource::rows(), hippodraw::DataPoint2DTuple::SIZE, hippodraw::Axes::X, hippodraw::DataPoint2DTuple::XERR, hippodraw::Axes::Y, and hippodraw::DataPoint2DTuple::YERR.
Referenced by Bins1DHist::createNTuple().
|
virtualinherited |
Returns the BinnerAxis object used by this object.
Implements BinsBase.
Definition at line 59 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, and hippodraw::Axes::X.
|
inherited |
Returns the lower edge of the last + 1 bin through binner_axis.
Definition at line 85 of file Bins1DBase.cxx.
References BinnerAxis::axisGetHigh(), and Bins1DBase::binner_axis.
|
protectedvirtualinherited |
Returns the low value of the bins on the specified axis.
Implements BinsBase.
Definition at line 78 of file Bins1DBase.cxx.
References BinnerAxis::axisGetLow(), Bins1DBase::binner_axis, and hippodraw::Axes::X.
Referenced by Bins1DProfile::fillDataSource(), and Bins1DHist::fillDataSource().
|
virtual |
Get the minimum entries/bin.
Reimplemented from BinsBase.
Definition at line 306 of file Bins1DHist.cxx.
References Bins1DHist::m_min_entries.
|
virtualinherited |
Returns the number of axes handled by the BinsBase derived class.
Implements BinsBase.
Definition at line 53 of file Bins1DBase.cxx.
|
virtual |
implementation from pure base
Implements BinsBase.
Definition at line 92 of file Bins1DHist.cxx.
References Bins1DHist::accumulate(), and Bins1DHist::m_data.
|
virtual |
implementation from pure base
Implements Bins1DBase.
Definition at line 98 of file Bins1DHist.cxx.
References Bins1DHist::m_data.
|
virtualinherited |
Returns the offset parameter on specific axis.
Implements BinsBase.
Definition at line 165 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, BinnerAxis::getOffset(), and hippodraw::Axes::X.
|
virtual |
implementation from pure base
Implements BinsBase.
Definition at line 110 of file Bins1DHist.cxx.
References Bins1DHist::m_data.
|
virtualinherited |
Returns range from binner axis.
Implements BinsBase.
Definition at line 195 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, BinnerAxis::getRange(), and hippodraw::Axes::X.
|
virtual |
implementation from pure base
Implements BinsBase.
Definition at line 105 of file Bins1DHist.cxx.
References Bins1DHist::m_data.
|
virtualinherited |
Get the z value at the specified point (x,y).
Reimplemented in Bins2DProfile, and Bins2DHist.
Definition at line 74 of file BinsBase.cxx.
Referenced by BinningProjector::getZValue().
|
virtualinherited |
Returns true
if all bins have the same width.
Implements BinsBase.
Definition at line 107 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, and BinnerAxis::hasEqualWidths().
|
inherited |
Returns true
if the re-accumulation is needed.
Definition at line 59 of file BinsBase.cxx.
References BinsBase::m_values_dirty.
|
inherited |
Returns true
if no accumulation has yet occurred, otherwise returns false
.
Definition at line 81 of file BinsBase.cxx.
References BinsBase::m_empty.
double maxBin | ( | ) |
Returns the value of the bin with the largest value.
Definition at line 77 of file Bins1DHist.cxx.
References Bins1DHist::m_data.
double minBin | ( | ) |
Returns the value of the bin with the smallest value.
Definition at line 72 of file Bins1DHist.cxx.
References Bins1DHist::m_data.
|
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().
|
virtualinherited |
Returns the number of bins on specified axis.
If a BinnerAxis object does not exist, returns 0.
Implements BinsBase.
Definition at line 90 of file Bins1DBase.cxx.
References BinnerAxis::axisNumberOfBins(), Bins1DBase::binner_axis, and hippodraw::Axes::X.
Referenced by Bins1DProfile::fillDataSource(), and Bins1DBase::resize().
|
protectedvirtualinherited |
Prepares the NTuple.
Creates and returns the NTuple that will be filled from the binner's values. The NTuple will have rows rows and 4 columns.
Implements BinsBase.
Definition at line 212 of file Bins1DBase.cxx.
References hippodraw::DataPoint2DTuple::ERROR, NTuple::setLabels(), and hippodraw::DataPoint2DTuple::WIDTH.
Referenced by Bins1DProfile::createNTuple(), and Bins1DHist::createNTuple().
|
virtual |
Resets the accumulation to zero.
Implements BinsBase.
Definition at line 82 of file Bins1DHist.cxx.
References Bins1DHist::m_data, BinsBase::m_empty, Bins1DHist::m_moments, BinsBase::m_values_dirty, and Bins1DHist::m_variance.
Referenced by Bins1DHist::resize().
|
privatevirtual |
Resizes the internal arrays.
Definition at line 63 of file Bins1DHist.cxx.
References Bins1DHist::m_data, BinsBase::m_values_dirty, Bins1DHist::m_variance, and Bins1DHist::reset().
|
virtualinherited |
Returns the scale factor.
Used to convert the projected values to number of entries in a bin.
Reimplemented from BinsBase.
Definition at line 119 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, and BinnerAxis::scaleFactorWid().
|
virtualinherited |
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 |
Implements BinsBase.
Definition at line 283 of file Bins1DHist.cxx.
References Bins1DHist::m_data, Bins1DHist::m_variance, num_util::size(), hippodraw::DataPoint2DTuple::XERR, hippodraw::Axes::Y, and hippodraw::DataPoint2DTuple::YERR.
|
virtualinherited |
Sets a new BinnerAxis for the binner to use.
The old one, if any, will be destroyed.
Implements BinsBase.
Definition at line 66 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, BinsBase::m_values_dirty, Bins1DBase::resize(), and hippodraw::Axes::X.
|
virtualinherited |
Sets the bin width parameter on the specified axis.
Implements BinsBase.
Definition at line 133 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, Bins1DBase::resize(), BinnerAxis::setBinWidth(), and hippodraw::Axes::X.
|
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().
|
virtualinherited |
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.
|
virtual |
Set the minimum entries/bin.
Reimplemented from BinsBase.
Definition at line 299 of file Bins1DHist.cxx.
References Bins1DHist::m_min_entries.
|
virtualinherited |
Sets the number of bins on the the specified axis.
Implements BinsBase.
Definition at line 97 of file Bins1DBase.cxx.
References BinnerAxis::axisSetNumberOfBins(), Bins1DBase::binner_axis, Bins1DBase::resize(), and hippodraw::Axes::X.
|
virtualinherited |
Sets the offset parameter on the specified axis.
Implements BinsBase.
Definition at line 174 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, BinnerAxis::setOffset(), and hippodraw::Axes::X.
|
virtualinherited |
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 183 of file Bins1DBase.cxx.
References Bins1DBase::binner_axis, Bins1DBase::resize(), BinnerAxis::setRange(), and hippodraw::Axes::X.
|
protectedinherited |
The binner axis object.
Definition at line 40 of file Bins1DBase.h.
Referenced by Bins1DBase::binNumber(), Bins1DBase::Bins1DBase(), Bins1DBase::binWidth(), Bins1DBase::calcBinWidth(), Bins1DBase::calcOffset(), Bins1DBase::getBinnerOn(), Bins1DBase::getHigh(), Bins1DBase::getLow(), Bins1DBase::getOffset(), Bins1DBase::getRange(), Bins1DBase::hasEqualWidths(), Bins1DBase::numberOfBins(), Bins1DBase::scaleFactor(), Bins1DBase::setBinnerOn(), Bins1DBase::setBinWidth(), Bins1DBase::setNumberOfBins(), Bins1DBase::setOffset(), Bins1DBase::setRange(), and Bins1DBase::~Bins1DBase().
|
private |
The array of binned data.
The range of the index is 1 to m_num_bins.( 0 refers to underflow while m_num_bins + 1 refers to overflow )
Definition at line 45 of file Bins1DHist.h.
Referenced by Bins1DHist::accumulate(), Bins1DHist::createNTuple(), Bins1DHist::fillDataSource(), Bins1DHist::getNumberOfEntries(), Bins1DHist::getOverflow(), Bins1DHist::getUnderflow(), Bins1DHist::maxBin(), Bins1DHist::minBin(), Bins1DHist::reset(), Bins1DHist::resize(), and Bins1DHist::setBinContents().
|
protectedinherited |
A flag set to true
, when no accumulation has yet occurred, otherwise is set false
.
Definition at line 58 of file BinsBase.h.
Referenced by Bins2DHist::accumulate(), Bins2DProfile::accumulate(), Bins1DHist::accumulate(), Bins1DProfile::accumulate(), BinsBase::isEmpty(), Bins2DHist::reset(), Bins2DProfile::reset(), Bins1DHist::reset(), and Bins1DProfile::reset().
|
protectedinherited |
A flag which is set true
to enable scaling the output.
Definition at line 50 of file BinsBase.h.
Referenced by Bins2DHist::fillDataSource(), Bins1DHist::fillDataSource(), and BinsBase::setEntriesScaling().
|
private |
The minimum number of entries/bin.
Definition at line 54 of file Bins1DHist.h.
Referenced by Bins1DHist::Bins1DHist(), Bins1DHist::fillDataSource(), Bins1DHist::getMinEntries(), and Bins1DHist::setMinEntries().
|
private |
The moments.
Definition at line 51 of file Bins1DHist.h.
Referenced by Bins1DHist::accumulate(), Bins1DHist::Bins1DHist(), and Bins1DHist::reset().
|
protectedinherited |
The scale factor.
This data member is used to scale the output so that the total number of entries has this value.
Definition at line 46 of file BinsBase.h.
Referenced by Bins2DHist::fillDataSource(), Bins1DHist::fillDataSource(), and BinsBase::scaleNumberOfEntries().
|
mutableprotectedinherited |
A flag to indicate that the objects in m_values are not correct.
Definition at line 53 of file BinsBase.h.
Referenced by Bins1DBase::Bins1DBase(), Bins2DBase::Bins2DBase(), BinsBase::isDirty(), Bins1DHist::reset(), Bins1DProfile::resize(), Bins1DHist::resize(), Bins2DBase::resize(), Bins1DBase::setBinnerOn(), Bins2DBase::setBinnerOn(), Bins2DBase::setBinWidth(), BinsBase::setDirty(), and Bins2DBase::setOffset().
|
private |
The accumulated square of the weights.
Definition at line 48 of file Bins1DHist.h.
Referenced by Bins1DHist::accumulate(), Bins1DHist::fillDataSource(), Bins1DHist::reset(), Bins1DHist::resize(), and Bins1DHist::setBinContents().