BIE::HistogramND Class Reference

General n-dimensional histogram (test). More...

#include <HistogramND.h>

Inheritance diagram for BIE::HistogramND:

Collaboration diagram for BIE::HistogramND:

List of all members.

Public Member Functions

HistogramND ()

Null constructor.

HistogramND (vector< double > *lo_in, vector< double > *hi_in, vector< double > *width_in, RecordType *type)

Construct from lower limits.

HistogramND (vector< double > *lo_in, vector< double > *hi_in, vector< double > *width_in, vector< string > *names)

Construct from lower limits.

~HistogramND ()

Destructor.

HistogramND * New ()

A factory method for cloning.

double PDF (State &x)

Return the value of the partial distribution function at.

double logPDF (State &x)

Return log value of the partial distribution function at.

double CDF (State &x)

Return cumulative distribution function at.

vector< double > lower (void)

Return the low bin values.

vector< double > upper (void)

Return the high bin values.

vector< double > Mean (void)

Return the mean bin value.

vector< double > StdDev (void)

Return the standard deviaton about the mean bin value.

vector< double > Moments (int i)

Return ith moment of bin values.

vector< double > Sample (void)

Sample the histogram.

void ComputeDistribution ()

Compute the statistical summary.

void dumpraw (string file, int i=0, int j=1)

Dump a 2-d cut through the n-dimensional histogram at dimensions i and j.

void dumpsm (string file, int i=0, int j=1)

Dump a 2-d cut through the n-dimensional histogram at dimensions i and j in SM 'ch' format.

void dumpmat (vector< vector< double > > &mat, vector< double > &x, vector< double > &y, int i=0, int j=1)

Dump a 2-d cut through the n-dimensional histogram at dimensions i and j.

int numberData ()

Binned distribution members.

double getValue (int i)

Returns the value of a particular (ith) bin.

vector< double > getLow (int i)

Returns the lower boundary of the ith bin.

vector< double > getHigh (int i)

Returns the upper boundary of the ith bin.

int getdim (int i)

Returns the dimensionality of the histogram - always 1.

Friends

class boost::serialization::access

Detailed Description

General n-dimensional histogram (test).

Constructor & Destructor Documentation

BIE::HistogramND::HistogramND	(	vector< double > *	lo_in,
		vector< double > *	hi_in,
		vector< double > *	width_in,
		RecordType *	type
	)

Construct from lower limits.

Parameters:

	lo_in	and from upper limits
	hi_in	and desired bin widths
	width_in	. The fields are defined by the RecordType
	type	.

BIE::HistogramND::HistogramND	(	vector< double > *	lo_in,
		vector< double > *	hi_in,
		vector< double > *	width_in,
		vector< string > *	names
	)

Construct from lower limits.

Parameters:

	lo_in	and from upper limits
	hi_in	and desired bin widths
	width_in	. The field names are defined by the string vector
	names	and RecordType is computed internally.

Member Function Documentation

double BIE::HistogramND::PDF ( State & x ) [virtual]

Return the value of the partial distribution function at.

Parameters:

x

Reimplemented from BIE::Distribution.

double BIE::HistogramND::logPDF ( State & x ) [virtual]

Return log value of the partial distribution function at.

Parameters:

x

Reimplemented from BIE::Distribution.

double BIE::HistogramND::CDF ( State & x ) [virtual]

Return cumulative distribution function at.

Parameters:

x

Reimplemented from BIE::Distribution.

int BIE::HistogramND::numberData ( ) [inline, virtual]

Binned distribution members.

Returns the number of in-bounds bins

Reimplemented from BIE::SampleDistribution.

void BIE::HistogramND::dumpraw	(	string	file,
		int	i = `0`,
		int	j = `1`
	)

Dump a 2-d cut through the n-dimensional histogram at dimensions i and j.

Written as characters with values between 0 and 255.

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

/home/weinberg/src/BIE/include/HistogramND.h