CHistogram1d Class Reference

#include <histogram1d.h>

Inheritance diagram for CHistogram1d:
[legend]
Collaboration diagram for CHistogram1d:
[legend]

List of all members.

Public Member Functions

 CHistogram1d (int _l=0, int _m=0, bool r=true, int N=1, double _xmin=0., double _xmax=1.)
 Plain constructor, we must initialize the knots explicitly.
 CHistogram1d (const CHistogram1d &h)
 Copy constructor, copying knots taken care of by base class.
bool Read (const parameterMap &m)
 Read from parameterMap.
bool Write (parameterMap &m)
 write to parameter map
void CopyState (const CHistogram1d &a)
double getValue (double r) const
 Main interface to value at a point.
double getError (double r) const
 Main interface to uncertainty at a point.
double basisFunction (double x, int i, int jderiv=0) const
void setFixedWidthBins (double dx, double xoffset)
bool inThisBin (int i, double xx) const
int whatBin (double x, bool graceful=true) const
double binWidth (int i) const
double leftBinEdge (int i) const
double rightBinEdge (int i) const
double midBin (int i) const
double getLeftSupport (int i) const
double getRightSupport (int i) const
bool setDefaultKnots (void)
 Default knot initialization.

Public Attributes

bool fixed_width_bins


Detailed Description

Definition at line 13 of file histogram1d.h.


Constructor & Destructor Documentation

CHistogram1d::CHistogram1d ( int  _l = 0,
int  _m = 0,
bool  r = true,
int  N = 1,
double  _xmin = 0.,
double  _xmax = 1. 
) [inline]

Plain constructor, we must initialize the knots explicitly.

Definition at line 20 of file histogram1d.h.

CHistogram1d::CHistogram1d ( const CHistogram1d h  )  [inline]

Copy constructor, copying knots taken care of by base class.

Definition at line 25 of file histogram1d.h.


Member Function Documentation

double CHistogram1d::basisFunction ( double  x,
int  i,
int  jderiv = 0 
) const [virtual]

Reimplemented from CGenericSpline1d.

Definition at line 38 of file histogram1d.cc.

double CHistogram1d::binWidth ( int  i  )  const [inline]

Definition at line 45 of file histogram1d.h.

void CHistogram1d::CopyState ( const CHistogram1d a  )  [inline]

Definition at line 33 of file histogram1d.h.

double CHistogram1d::getError ( double  x  )  const [inline, virtual]

Main interface to uncertainty at a point.

Reimplemented from CBasisFunctionExpansion1d.

Definition at line 38 of file histogram1d.h.

double CHistogram1d::getLeftSupport ( int  i  )  const [inline, virtual]

Reimplemented from CGenericSpline1d.

Definition at line 51 of file histogram1d.h.

double CHistogram1d::getRightSupport ( int  i  )  const [inline, virtual]

Reimplemented from CGenericSpline1d.

Definition at line 52 of file histogram1d.h.

double CHistogram1d::getValue ( double  x  )  const [inline, virtual]

Main interface to value at a point.

Reimplemented from CBasisFunctionExpansion1d.

Definition at line 37 of file histogram1d.h.

bool CHistogram1d::inThisBin ( int  i,
double  xx 
) const

Definition at line 14 of file histogram1d.cc.

double CHistogram1d::leftBinEdge ( int  i  )  const [inline]

Definition at line 46 of file histogram1d.h.

double CHistogram1d::midBin ( int  i  )  const [inline]

Definition at line 48 of file histogram1d.h.

bool CHistogram1d::Read ( const parameterMap m  ) 

Read from parameterMap.

Reimplemented from CGenericSpline1d.

Reimplemented in CCorrFtn1dHisto, CPairDistribution1dHisto, and CSourceFtn1dHisto.

Definition at line 48 of file histogram1d.cc.

double CHistogram1d::rightBinEdge ( int  i  )  const [inline]

Definition at line 47 of file histogram1d.h.

bool CHistogram1d::setDefaultKnots ( void   ) 

Default knot initialization.

Reimplemented from CGenericSpline1d.

Definition at line 138 of file histogram1d.cc.

void CHistogram1d::setFixedWidthBins ( double  dx,
double  xoffset 
)

Definition at line 5 of file histogram1d.cc.

int CHistogram1d::whatBin ( double  x,
bool  graceful = true 
) const

Computes which bin x lies in The graceful flag determines what happens if x is off grid: If graceful==true, give the nearest on-grid bin If graceful==false, give the nearest off-grid "bin". You must check for this as it mostlikely will cause an assertion error if bounds checking is on or a segfault if bounds checking is off.

Definition at line 23 of file histogram1d.cc.

bool CHistogram1d::Write ( parameterMap com  ) 

write to parameter map

Reimplemented from CGenericSpline1d.

Reimplemented in CCorrFtn1dHisto, CPairDistribution1dHisto, and CSourceFtn1dHisto.

Definition at line 126 of file histogram1d.cc.


Member Data Documentation

Definition at line 17 of file histogram1d.h.


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

Generated on Fri Feb 6 13:30:18 2009 for CorAL by  doxygen 1.5.8