TUnuranEmpDist Class Reference

#include <TUnuranEmpDist.h>

Inheritance diagram for TUnuranEmpDist:


Public Member Functions
	TUnuranEmpDist (const TH1 *h1=0, bool useBuffer=true)
template<class Iterator>
	TUnuranEmpDist (Iterator begin, Iterator end, unsigned int dim=1)
	TUnuranEmpDist (unsigned int n, double *x)
	TUnuranEmpDist (unsigned int n, double x, double y)
	TUnuranEmpDist (unsigned int n, double x, double y, double *z)
virtual	~TUnuranEmpDist ()
	TUnuranEmpDist (const TUnuranEmpDist &)
TUnuranEmpDist &	operator= (const TUnuranEmpDist &rhs)
TUnuranEmpDist *	Clone () const
const std::vector< double > &	Data () const
bool	IsBinned () const
double	LowerBin () const
double	UpperBin () const
unsigned int	NDim () const
Private Attributes
std::vector< double >	fData
unsigned int	fDim
double	fMin
double	fMax
bool	fBinned

Detailed Description

TUnuranEmpDist class for describing empiral distributions. It is used by TUnuran to generate double random number according to this distribution via TUnuran::Sample() or TUnuran::Sample(double *) in case of multi-dimensional empirical distributions.

An empirical distribution can be one or multi-dimension constructed from a set of unbinned data, (the class can be constructed from an iterator to a vector of data) or by using an histogram (with apointer to the TH1 class). If the histogram contains a buffer with the original data they are used by default to estimate the empirical distribution, othewise the bins information is used. In this binned case only one dimension is now supported.

In the case of unbinned data the density distribution is estimated by UNURAN using kernel smoothing and then random numbers are generated. In the case of bin data (which can only be one dimension) the probability density is estimated directly from the histograms and the random numbers are generated according to the histogram (like in TH1::GetRandom). This method requires some initialization time but it is faster in generating the random numbers than TH1::GetRandom and it becomes convenient to use when generating a large amount of data.

Definition at line 48 of file TUnuranEmpDist.h.

Constructor & Destructor Documentation

TUnuranEmpDist::TUnuranEmpDist	(	const TH1 *	h1 = `0`,
		bool	useBuffer = `true`
	)

Constructor from a TH1 objects. If the histogram has a buffer by default the unbinned data are used

Definition at line 20 of file TUnuranEmpDist.cxx.

References fBinned, fData, fDim, fMax, fMin, TH2D::GetBinContent(), TH1::GetBuffer(), TH1::GetBufferLength(), TH1::GetDimension(), TH1::GetNbinsX(), TH1::GetXaxis(), TAxis::GetXmax(), TAxis::GetXmin(), h1, i, n, and nbins.

Referenced by Clone().

template<class Iterator>

TUnuranEmpDist::TUnuranEmpDist	(	Iterator	begin,
		Iterator	end,
		unsigned int	dim = `1`
	)			`[inline]`

Constructor from a set of data using an iterator to specify begin/end of the data In the case of multi-dimension the data are assumed to be passed in this order x0,y0,...x1,y1,..x2,y2,...

Definition at line 65 of file TUnuranEmpDist.h.