Histogram1D Class Reference

Class for 1D histogram type representation of data. More...

#include <histogram.hpp>

Inheritance diagram for Histogram1D:

Histogram List of all members.

Public Member Functions

 Histogram1D (size_t n, const double range[2])
 Constructor for n bin histogram with ranges.
 Histogram1D (size_t n, const std::vector< double > &xdata)
 Constructor for n bin histogram from scatter data with even weights.
 Histogram1D (size_t n, const std::vector< double > &xdata, const std::vector< double > &wdata)
 Constructor for n bin histogram from scatter data with weights wrom wdata.
virtual ~Histogram1D ()
 Destructor.
size_t n (void) const
 Return the number of bins.
double step (void) const
 Return the step size.
double coord (size_t i) const
 Return the coordinate on bin i.
void accumulate (size_t i, double weight)
 Accumulate weight on bin i.
void accumulate_linear (double x, double weight)
 Accumulate weight on bins around x linearly.
void get_range (double range[2]) const
 Return data range.
void get_bin_range (double &min, double &max) const
 Return bin range.
std::vector< double > & get_data (void)
 Return a reference to the histogram data.
const std::vector< double > & get_data (void) const
 Return a reference to the histogram data.
const double & operator() (size_t i) const
 Return a const reference to the weight on bin i.
double & operator() (size_t i)
 Return a reference to the weight on bin i.

Detailed Description

Class for 1D histogram type representation of data.


Constructor & Destructor Documentation

Histogram1D::Histogram1D ( size_t  n,
const double  range[2] 
)

Constructor for n bin histogram with ranges.

Histogram1D::Histogram1D ( size_t  n,
const std::vector< double > &  xdata 
)

Constructor for n bin histogram from scatter data with even weights.

Histogram1D::Histogram1D ( size_t  n,
const std::vector< double > &  xdata,
const std::vector< double > &  wdata 
)

Constructor for n bin histogram from scatter data with weights wrom wdata.

virtual Histogram1D::~Histogram1D (  )  [virtual]

Destructor.


Member Function Documentation

void Histogram1D::accumulate ( size_t  i,
double  weight 
) [inline]

Accumulate weight on bin i.

Not a safe function. Input not checked.

void Histogram1D::accumulate_linear ( double  x,
double  weight 
)

Accumulate weight on bins around x linearly.

Accumulation is done on two neighbouring bins around point x. The distribution of weight is done using inverse linear interpolation.

This is a safe function. Accumulation outside histogram range is discarded.

double Histogram1D::coord ( size_t  i  )  const [inline]

Return the coordinate on bin i.

void Histogram1D::get_bin_range ( double &  min,
double &  max 
) const

Return bin range.

Returns minimum and maximum values on any bin in histogram.

const std::vector<double>& Histogram1D::get_data ( void   )  const [inline]

Return a reference to the histogram data.

std::vector<double>& Histogram1D::get_data ( void   )  [inline]

Return a reference to the histogram data.

void Histogram1D::get_range ( double  range[2]  )  const [inline]

Return data range.

size_t Histogram1D::n ( void   )  const [inline]

Return the number of bins.

double& Histogram1D::operator() ( size_t  i  )  [inline]

Return a reference to the weight on bin i.

const double& Histogram1D::operator() ( size_t  i  )  const [inline]

Return a const reference to the weight on bin i.

double Histogram1D::step ( void   )  const [inline]

Return the step size.


The documentation for this class was generated from the following file:
Generated on Thu Apr 21 13:39:22 2011 for IBSimu by  doxygen 1.4.7