Class RooFoamGenerator is a generic toy monte carlo generator that implement the TFOAM sampling technique on any positively valued function.

The RooFoamGenerator generator is used by the various generator context classes to take care of generation of observables for which p.d.fs do not define internal methods.

The foam generator reacts to the following config options:

nCell[123N]D
nSample
chatLevel Access those using: myPdf->specialGeneratorConfig()->getConfigSection("RooFoamGenerator").setRealValue("nSample",1e4);

See also: rf902_numgenconfig.C

Definition at line 31 of file RooFoamGenerator.h.

Public Member Functions
	RooFoamGenerator ()

	RooFoamGenerator (const RooAbsReal &func, const RooArgSet &genVars, const RooNumGenConfig &config, Bool_t verbose=kFALSE, const RooAbsReal *maxFuncVal=0)

virtual	~RooFoamGenerator ()
	Destructor.

virtual Bool_t	canSampleCategories () const

virtual Bool_t	canSampleConditional () const

RooAbsNumGenerator *	clone (const RooAbsReal &func, const RooArgSet &genVars, const RooArgSet &, const RooNumGenConfig &config, Bool_t verbose=kFALSE, const RooAbsReal *maxFuncVal=0) const

TFoam &	engine ()

const RooArgSet *	generateEvent (UInt_t remaining, Double_t &resampleRatio)
	are we actually generating anything? (the cache always contains at least our function value)

Public Member Functions inherited from RooAbsNumGenerator
	RooAbsNumGenerator ()

	RooAbsNumGenerator (const RooAbsReal &func, const RooArgSet &genVars, Bool_t verbose=kFALSE, const RooAbsReal *maxFuncVal=0)
	Initialize an accept-reject generator for the specified distribution function, which must be non-negative but does not need to be normalized over the variables to be generated, genVars.

virtual	~RooAbsNumGenerator ()
	Destructor.

void	attachParameters (const RooArgSet &vars)
	Reattach original parameters to function clone.

virtual Double_t	getFuncMax ()

Bool_t	isValid () const

Bool_t	isVerbose () const

virtual void	Print (Option_t *options=0) const
	Print TNamed name and title.

virtual void	printArgs (std::ostream &os) const
	Print the arguments of the generator.

virtual void	printClassName (std::ostream &os) const
	Print the class name of the generator.

virtual void	printName (std::ostream &os) const
	Print name of the generator.

virtual void	printTitle (std::ostream &os) const
	Print the title of the generator.

void	setVerbose (Bool_t verbose=kTRUE)

Public Member Functions inherited from TNamed
	TNamed ()

	TNamed (const char name, const char title)

	TNamed (const TNamed &named)
	TNamed copy ctor.

	TNamed (const TString &name, const TString &title)

virtual	~TNamed ()
	TNamed destructor.

virtual void	Clear (Option_t *option="")
	Set name and title to empty strings ("").

virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility.

virtual Int_t	Compare (const TObject *obj) const
	Compare two TNamed objects.

virtual void	Copy (TObject &named) const
	Copy this to obj.

virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer.

virtual const char *	GetName () const
	Returns name of object.

virtual const char *	GetTitle () const
	Returns title of object.

virtual ULong_t	Hash () const
	Return hash value for this object.

virtual Bool_t	IsSortable () const

virtual void	ls (Option_t *option="") const
	List TNamed name and title.

TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator.

virtual void	SetName (const char *name)
	Set the name of the TNamed.

virtual void	SetNameTitle (const char name, const char title)
	Set all the TNamed parameters (name and title).

virtual void	SetTitle (const char *title="")
	Set the title of the TNamed.

virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject.

Public Member Functions inherited from TObject
	TObject ()
	TObject constructor.

	TObject (const TObject &object)
	TObject copy ctor.

virtual	~TObject ()
	TObject destructor.

void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract.

virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad.

virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action.

ULong_t	CheckedHash ()
	Check and record whether this class has a consistent Hash/RecursiveRemove setup (*) and then return the regular Hash value for this object.

virtual const char *	ClassName () const
	Returns name of class to which the object belongs.

virtual void	Delete (Option_t *option="")
	Delete this object.

virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object.

virtual void	Draw (Option_t *option="")
	Default Draw method for all objects.

virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs.

virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad for instance with: `gROOT->SetSelectedPad(gPad)`.

virtual void	Dump () const
	Dump contents of object on stdout.

virtual void	Error (const char method, const char msgfmt,...) const
	Issue error message.

virtual void	Execute (const char method, const char params, Int_t *error=0)
	Execute method on this object with the given parameter string, e.g.

virtual void	Execute (TMethod method, TObjArray params, Int_t *error=0)
	Execute method on this object with parameters stored in the TObjArray.

virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py).

virtual void	Fatal (const char method, const char msgfmt,...) const
	Issue fatal error message.

virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes.

virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes.

virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object.

virtual const char *	GetIconName () const
	Returns mime type name of object.

virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py).

virtual Option_t *	GetOption () const

virtual UInt_t	GetUniqueID () const
	Return the unique object id.

virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out.

Bool_t	HasInconsistentHash () const
	Return true is the type of this object is known to have an inconsistent setup for Hash and RecursiveRemove (i.e.

virtual void	Info (const char method, const char msgfmt,...) const
	Issue info message.

virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname".

virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl.

virtual void	Inspect () const
	Dump contents of this object in a graphics canvas.

void	InvertBit (UInt_t f)

virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory).

virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects).

R__ALWAYS_INLINE Bool_t	IsOnHeap () const

R__ALWAYS_INLINE Bool_t	IsZombie () const

void	MayNotUse (const char *method) const
	Use this method to signal that a method (defined in a base class) may not be called in a derived class (in principle against good design since a child class should not provide less functionality than its parent, however, sometimes it is necessary).

virtual Bool_t	Notify ()
	This method must be overridden to handle object notification.

void	Obsolete (const char method, const char asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete.

void	operator delete (void *ptr)
	Operator delete.

void	operator delete[] (void *ptr)
	Operator delete [].

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *vp)

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, void *vp)

TObject &	operator= (const TObject &rhs)
	TObject assignment operator.

virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself.

virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list.

virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory.

virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list.

void	ResetBit (UInt_t f)

virtual void	SaveAs (const char filename="", Option_t option="") const
	Save this object in the file specified by filename.

virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out".

void	SetBit (UInt_t f)

void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f.

virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object.

virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id.

virtual void	SysError (const char method, const char msgfmt,...) const
	Issue system error message.

R__ALWAYS_INLINE Bool_t	TestBit (UInt_t f) const

Int_t	TestBits (UInt_t f) const

virtual void	UseCurrentStyle ()
	Set current style settings in this object This function is called when either TCanvas::UseCurrentStyle or TROOT::ForceStyle have been invoked.

virtual void	Warning (const char method, const char msgfmt,...) const
	Issue warning message.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory.

virtual Int_t	Write (const char *name=0, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory.

Public Member Functions inherited from RooPrintable
	RooPrintable ()

virtual	~RooPrintable ()

virtual Int_t	defaultPrintContents (Option_t *opt) const
	Default choice of contents to be printed (name and value)

virtual StyleOption	defaultPrintStyle (Option_t *opt) const

virtual void	printAddress (std::ostream &os) const
	Print class name of object.

virtual void	printExtras (std::ostream &os) const
	Interface to print extras of object.

virtual void	printMultiline (std::ostream &os, Int_t contents, Bool_t verbose=kFALSE, TString indent="") const
	Interface for detailed printing of object.

virtual void	printStream (std::ostream &os, Int_t contents, StyleOption style, TString indent="") const
	Print description of object on ostream, printing contents set by contents integer, which is interpreted as an OR of 'enum ContentsOptions' values and in the style given by 'enum StyleOption'.

virtual void	printTree (std::ostream &os, TString indent="") const
	Interface for tree structure printing of object.

virtual void	printValue (std::ostream &os) const
	Interface to print value of object.

Static Protected Member Functions
static void	registerSampler (RooNumGenFactory &fact)
	Register RooIntegrator1D, is parameters and capabilities with RooNumIntFactory.

Protected Attributes
RooTFoamBinding *	_binding

Double_t *	_range

TFoam *	_tfoam

Double_t *	_vec

Double_t *	_xmin

Protected Attributes inherited from RooAbsNumGenerator
RooDataSet *	_cache

RooArgSet	_catVars

RooArgSet *	_cloneSet

RooAbsReal *	_funcClone

const RooAbsReal *	_funcMaxVal

RooRealVar *	_funcValPtr

RooRealVar *	_funcValStore

Bool_t	_isValid

RooArgSet	_realVars

Bool_t	_verbose

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

Friends
class	RooNumGenFactory

Additional Inherited Members
Public Types inherited from TObject
enum	{ kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 , kBitMask = 0x00ffffff }

enum	{ kSingleKey = BIT(0) , kOverwrite = BIT(1) , kWriteDelete = BIT(2) }

enum	EDeprecatedStatusBits { kObjInCanvas = BIT(3) }

enum	EStatusBits { kCanDelete = BIT(0) , kMustCleanup = BIT(3) , kIsReferenced = BIT(4) , kHasUUID = BIT(5) , kCannotPick = BIT(6) , kNoContextMenu = BIT(8) , kInvalidObject = BIT(13) }

Public Types inherited from RooPrintable
enum	ContentsOption { kName =1 , kClassName =2 , kValue =4 , kArgs =8 , kExtras =16 , kAddress =32 , kTitle =64 , kCollectionHeader =128 }

enum	StyleOption { kInline =1 , kSingleLine =2 , kStandard =3 , kVerbose =4 , kTreeStructure =5 }

Static Public Member Functions inherited from TObject
static Long_t	GetDtorOnly ()
	Return destructor only flag.

static Bool_t	GetObjectStat ()
	Get status of object stat flag.

static void	SetDtorOnly (void *obj)
	Set destructor only flag.

static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable.

Static Public Member Functions inherited from RooPrintable
static std::ostream &	defaultPrintStream (std::ostream *os=0)
	Return a reference to the current default stream to use in Print().

static void	nameFieldLength (Int_t newLen)
	Set length of field reserved from printing name of RooAbsArgs in multi-line collection printing to given amount.

Protected Types inherited from TObject
enum	{ kOnlyPrepStep = BIT(3) }

Protected Member Functions inherited from TObject
virtual void	DoError (int level, const char location, const char fmt, va_list va) const
	Interface to ErrorHandler (protected).

void	MakeZombie ()

Static Protected Attributes inherited from RooPrintable
static Int_t	_nameLength

#include <RooFoamGenerator.h>

Inheritance diagram for RooFoamGenerator:

[legend]

Constructor & Destructor Documentation

◆ RooFoamGenerator() [1/2]

RooFoamGenerator::RooFoamGenerator ( )

inline

Definition at line 33 of file RooFoamGenerator.h.

◆ RooFoamGenerator() [2/2]

RooFoamGenerator::RooFoamGenerator	(	const RooAbsReal &	func,
		const RooArgSet &	genVars,
		const RooNumGenConfig &	config,
		Bool_t	verbose = `kFALSE`,
		const RooAbsReal *	maxFuncVal = `0`
	)

Definition at line 89 of file RooFoamGenerator.cxx.

◆ ~RooFoamGenerator()

RooFoamGenerator::~RooFoamGenerator ( )

virtual

Destructor.

Definition at line 126 of file RooFoamGenerator.cxx.

Member Function Documentation

◆ canSampleCategories()

virtual Bool_t RooFoamGenerator::canSampleCategories ( ) const

inlinevirtual

Reimplemented from RooAbsNumGenerator.

Definition at line 46 of file RooFoamGenerator.h.

◆ canSampleConditional()

virtual Bool_t RooFoamGenerator::canSampleConditional ( ) const

inlinevirtual

Reimplemented from RooAbsNumGenerator.

Definition at line 45 of file RooFoamGenerator.h.

◆ clone()

RooAbsNumGenerator * RooFoamGenerator::clone	(	const RooAbsReal &	func,
		const RooArgSet &	genVars,
		const RooArgSet &	,
		const RooNumGenConfig &	config,
		Bool_t	verbose = `kFALSE`,
		const RooAbsReal *	maxFuncVal = `0`
	)		const

inlinevirtual

Implements RooAbsNumGenerator.

Definition at line 35 of file RooFoamGenerator.h.

◆ engine()

TFoam & RooFoamGenerator::engine ( )

inline

Definition at line 43 of file RooFoamGenerator.h.

◆ generateEvent()

const RooArgSet * RooFoamGenerator::generateEvent	(	UInt_t	remaining,
		Double_t &	resampleRatio
	)

virtual

are we actually generating anything? (the cache always contains at least our function value)

Implements RooAbsNumGenerator.

Definition at line 140 of file RooFoamGenerator.cxx.

◆ registerSampler()

void RooFoamGenerator::registerSampler ( RooNumGenFactory & fact )

staticprotected

Register RooIntegrator1D, is parameters and capabilities with RooNumIntFactory.

Definition at line 70 of file RooFoamGenerator.cxx.

Friends And Related Symbol Documentation

◆ RooNumGenFactory

friend class RooNumGenFactory

friend

Definition at line 50 of file RooFoamGenerator.h.

Member Data Documentation

◆ _binding

RooTFoamBinding* RooFoamGenerator::_binding

protected

Definition at line 53 of file RooFoamGenerator.h.

◆ _range

Double_t* RooFoamGenerator::_range

protected

Definition at line 56 of file RooFoamGenerator.h.

◆ _tfoam

TFoam* RooFoamGenerator::_tfoam

protected

Definition at line 54 of file RooFoamGenerator.h.

◆ _vec

Double_t* RooFoamGenerator::_vec

protected

Definition at line 57 of file RooFoamGenerator.h.

◆ _xmin

Double_t* RooFoamGenerator::_xmin

protected

Definition at line 55 of file RooFoamGenerator.h.

Libraries for RooFoamGenerator:

[legend]

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

roofit/roofitcore/inc/RooFoamGenerator.h
roofit/roofitcore/src/RooFoamGenerator.cxx

Public Member Functions

Static Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Constructor & Destructor Documentation

◆ RooFoamGenerator() [1/2]

◆ RooFoamGenerator() [2/2]

◆ ~RooFoamGenerator()

Member Function Documentation

◆ canSampleCategories()

◆ canSampleConditional()

◆ clone()

◆ engine()

◆ generateEvent()

◆ registerSampler()

Friends And Related Symbol Documentation

◆ RooNumGenFactory

Member Data Documentation

◆ _binding

◆ _range

◆ _tfoam

◆ _vec

◆ _xmin