TFoamSampler class class implementing the ROOT::Math::DistSampler interface using FOAM for sampling arbitrary distributions.

Definition at line 48 of file TFoamSampler.h.

Public Member Functions
	TFoamSampler ()
	default constructor More...

virtual	~TFoamSampler ()
	virtual destructor More...

TRandom *	GetRandom ()
	Get the random engine used by the sampler. More...

bool	Init (const char *="")
	initialize the generators with the default options More...

bool	Init (const ROOT::Math::DistSamplerOptions &opt)
	initialize the generators with the fiven options More...

bool	Sample (double *x)
	sample one event in multi-dimension by filling the given array return false if sampling failed More...

bool	SampleBin (double prob, double &value, double *error=0)
	sample one bin given an estimated of the pdf in the bin (this can be function value at the center or its integral in the bin divided by the bin width) By default do not do random sample, just return the function values More...

void	SetFunction (const ROOT::Math::IGenFunction &func)
	set the parent function distribution to use for random sampling (one dim case) More...

void	SetFunction (TF1 *pdf)
	set the Function using a TF1 pointer More...

void	SetRandom (TRandom *r)
	Set the random engine to be used Needs to be called before Init to have effect. More...

void	SetSeed (unsigned int seed)
	Set the random seed for the TRandom instances used by the sampler classes Needs to be called before Init to have effect. More...

Public Member Functions inherited from ROOT::Math::DistSampler
	DistSampler ()
	default constructor More...

virtual	~DistSampler ()
	virtual destructor More...

virtual bool	Generate (unsigned int nevt, ROOT::Fit::UnBinData &data)
	generate a un-binned data sets (fill the given data set) if dataset has already data append to it More...

virtual bool	Generate (unsigned int nevt, const int *nbins, ROOT::Fit::BinData &data, bool extend=true)
	generate a bin data set . More...

bool	Generate (unsigned int nevt, int nbins, double xmin, double xmax, ROOT::Fit::BinData &data, bool extend=true)
	same as before but passing the range in case of 1 dim data More...

unsigned int	NDim () const
	return the dimension of the parent distribution (and the data) More...

const ROOT::Math::IMultiGenFunction &	ParentPdf () const
	get the parent distribution function (must be called after setting the function) More...

const double *	Sample ()
	sample one event and rerturning array x with coordinates More...

virtual double	Sample1D ()
	sample one event in one dimension better implementation could be provided by the derived classes More...

virtual bool	SampleBins (unsigned int n, const double prob, double values, double *errors=0)
	sample a set of bins given a vector of probabilities Typically multinomial statistics will be used and the sum of the probabilities will be equal to the total number of events to be generated For sampling the bins indipendently, SampleBin should be used More...

virtual void	SetArea (double)
	set the normalization area of distribution implemented by derived classes if needed More...

template<class Function >
void	SetFunction (Function &func, unsigned int dim)
	set the parent function distribution to use for sampling (generic case) More...

virtual void	SetFunction (const ROOT::Math::IMultiGenFunction &func)
	set the parent function distribution to use for random sampling (multi-dim case) More...

virtual void	SetMode (double)
	set the mode of the distribution (could be useful to some methods) implemented by derived classes if needed More...

void	SetRange (double xmin, double xmax, int icoord=0)
	set range in a given dimension More...

void	SetRange (const double xmin, const double xmax)
	set range for all dimensions More...

void	SetRange (const ROOT::Fit::DataRange &range)
	set range using DataRange class More...

Private Attributes
TFoam *	fFoam

TFoamIntegrand *	fFoamDist

const ROOT::Math::IGenFunction *	fFunc1D

Additional Inherited Members
Protected Member Functions inherited from ROOT::Math::DistSampler
virtual void	DoSetFunction (const ROOT::Math::IMultiGenFunction &func, bool copy)

bool	IsInitialized ()

const ROOT::Fit::DataRange &	PdfRange () const
	return the data range of the Pdf . Must be called after setting the function More...

#include <TFoamSampler.h>

Inheritance diagram for TFoamSampler:

[legend]

Constructor & Destructor Documentation

◆ TFoamSampler()

TFoamSampler::TFoamSampler ( )

default constructor

TFoamSampler class class implementing the ROOT::Math::DistSampler interface using FOAM for sampling arbitrary distributions.

Definition at line 88 of file TFoamSampler.cxx.

◆ ~TFoamSampler()

TFoamSampler::~TFoamSampler ( )

virtual

virtual destructor

Definition at line 98 of file TFoamSampler.cxx.

Member Function Documentation

◆ GetRandom()

TRandom * TFoamSampler::GetRandom ( )

virtual

Get the random engine used by the sampler.

Reimplemented from ROOT::Math::DistSampler.

Definition at line 178 of file TFoamSampler.cxx.

◆ Init() [1/2]

bool TFoamSampler::Init ( const char * = "" )

virtual

initialize the generators with the default options

Reimplemented from ROOT::Math::DistSampler.

Definition at line 104 of file TFoamSampler.cxx.

◆ Init() [2/2]

bool TFoamSampler::Init ( const ROOT::Math::DistSamplerOptions & opt )

virtual

initialize the generators with the fiven options

Reimplemented from ROOT::Math::DistSampler.

Definition at line 113 of file TFoamSampler.cxx.

◆ Sample()

bool TFoamSampler::Sample ( double * x )

virtual

sample one event in multi-dimension by filling the given array return false if sampling failed

Implements ROOT::Math::DistSampler.

Definition at line 188 of file TFoamSampler.cxx.

◆ SampleBin()

bool TFoamSampler::SampleBin	(	double	prob,
		double &	value,
		double *	error = `0`
	)

virtual

sample one bin given an estimated of the pdf in the bin (this can be function value at the center or its integral in the bin divided by the bin width) By default do not do random sample, just return the function values

Reimplemented from ROOT::Math::DistSampler.

Definition at line 201 of file TFoamSampler.cxx.

◆ SetFunction() [1/2]

void TFoamSampler::SetFunction ( const ROOT::Math::IGenFunction & func )

inlinevirtual

set the parent function distribution to use for random sampling (one dim case)

Reimplemented from ROOT::Math::DistSampler.

Definition at line 63 of file TFoamSampler.h.

◆ SetFunction() [2/2]

void TFoamSampler::SetFunction ( TF1 * pdf )

set the Function using a TF1 pointer

Definition at line 162 of file TFoamSampler.cxx.

◆ SetRandom()

void TFoamSampler::SetRandom ( TRandom * r )

virtual

Set the random engine to be used Needs to be called before Init to have effect.

Reimplemented from ROOT::Math::DistSampler.

Definition at line 167 of file TFoamSampler.cxx.

◆ SetSeed()

void TFoamSampler::SetSeed ( unsigned int seed )

virtual

Set the random seed for the TRandom instances used by the sampler classes Needs to be called before Init to have effect.

Reimplemented from ROOT::Math::DistSampler.

Definition at line 172 of file TFoamSampler.cxx.

Member Data Documentation

◆ fFoam

TFoam* TFoamSampler::fFoam

private

Definition at line 130 of file TFoamSampler.h.

◆ fFoamDist

TFoamIntegrand* TFoamSampler::fFoamDist

private

Definition at line 131 of file TFoamSampler.h.

◆ fFunc1D

const ROOT::Math::IGenFunction* TFoamSampler::fFunc1D

private

Definition at line 129 of file TFoamSampler.h.

Libraries for TFoamSampler:

[legend]

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

math/foam/inc/TFoamSampler.h
math/foam/src/TFoamSampler.cxx

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ TFoamSampler()

◆ ~TFoamSampler()

Member Function Documentation

◆ GetRandom()

◆ Init() [1/2]

◆ Init() [2/2]

◆ Sample()

◆ SampleBin()

◆ SetFunction() [1/2]

◆ SetFunction() [2/2]

◆ SetRandom()

◆ SetSeed()

Member Data Documentation

◆ fFoam

◆ fFoamDist

◆ fFunc1D