RooAbsGenContext is the abstract base class for generator contexts of RooAbsPdf objects.

A generator context is an object that controls the generation of events from a given p.d.f in one or more sessions. This class defines the common interface for all such contexts and organizes storage of common components, such as the observables definition, the prototype data etc..

Definition at line 26 of file RooAbsGenContext.h.

Public Member Functions
	RooAbsGenContext (const RooAbsPdf &model, const RooArgSet &vars, const RooDataSet prototype=0, const RooArgSet auxProto=0, Bool_t _verbose=kFALSE)
	Constructor.

virtual	~RooAbsGenContext ()
	Destructor.

virtual void	attach (const RooArgSet &params)
	Interface to attach given parameters to object in this context.

virtual Int_t	defaultPrintContents (Option_t *opt) const
	Define default contents when printing.

virtual StyleOption	defaultPrintStyle (Option_t *opt) const
	Define default print style.

virtual RooDataSet *	generate (Double_t nEvents=0, Bool_t skipInit=kFALSE, Bool_t extendedMode=kFALSE)
	Generate the specified number of events with nEvents>0 and and return a dataset containing the generated events.

virtual void	generateEvent (RooArgSet &theEvent, Int_t remaining)=0

virtual void	initGenerator (const RooArgSet &theEvent)
	Interface function to initialize context for generation for given set of observables.

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 arguments of context, i.e. the observables being generated in this context.

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

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

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

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

virtual void	setExpectedData (Bool_t)

virtual void	setProtoDataOrder (Int_t *lut)
	Set the traversal order of prototype data to that in the lookup tables passed as argument.

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)

Bool_t	IsDestructed () const
	IsDestructed.

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 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	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.

Protected Member Functions
virtual RooDataSet *	createDataSet (const char name, const char title, const RooArgSet &obs)
	Create an empty dataset to hold the events that will be generated.

void	resampleData (Double_t &ratio)
	Rescale existing output buffer with given ratio.

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 ()

Protected Attributes
UInt_t	_expectedEvents

RooAbsPdf::ExtendMode	_extendMode

RooDataSet *	_genData

Bool_t	_isValid

Int_t	_nextProtoIndex

TString	_normRange

Int_t *	_protoOrder

const RooDataSet *	_prototype

RooArgSet	_protoVars

RooArgSet	_theEvent

Bool_t	_verbose

Protected Attributes inherited from TNamed
TString	fName

TString	fTitle

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 Longptr_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) }

Static Protected Attributes inherited from RooPrintable
static Int_t	_nameLength

#include <RooAbsGenContext.h>

Inheritance diagram for RooAbsGenContext:

[legend]

Constructor & Destructor Documentation

◆ RooAbsGenContext()

RooAbsGenContext::RooAbsGenContext	(	const RooAbsPdf &	model,
		const RooArgSet &	vars,
		const RooDataSet *	prototype = `0`,
		const RooArgSet *	auxProto = `0`,
		Bool_t	_verbose = `kFALSE`
	)

Constructor.

Definition at line 53 of file RooAbsGenContext.cxx.

◆ ~RooAbsGenContext()

RooAbsGenContext::~RooAbsGenContext ( )

virtual

Destructor.

Definition at line 112 of file RooAbsGenContext.cxx.

Member Function Documentation

◆ attach()

void RooAbsGenContext::attach ( const RooArgSet & params )

virtual

Interface to attach given parameters to object in this context.

Reimplemented in RooAddGenContext, RooBinnedGenContext, RooConvGenContext, RooGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 122 of file RooAbsGenContext.cxx.

◆ createDataSet()

RooDataSet * RooAbsGenContext::createDataSet	(	const char *	name,
		const char *	title,
		const RooArgSet &	obs
	)

protectedvirtual

Create an empty dataset to hold the events that will be generated.

Reimplemented in RooSimGenContext, and RooSimSplitGenContext.

Definition at line 131 of file RooAbsGenContext.cxx.

◆ defaultPrintContents()

Int_t RooAbsGenContext::defaultPrintContents ( Option_t * opt ) const

virtual

Define default contents when printing.

Reimplemented from RooPrintable.

Definition at line 400 of file RooAbsGenContext.cxx.

◆ defaultPrintStyle()

RooPrintable::StyleOption RooAbsGenContext::defaultPrintStyle ( Option_t * opt ) const

virtual

Define default print style.

Reimplemented from RooPrintable.

Definition at line 410 of file RooAbsGenContext.cxx.

◆ generate()

RooDataSet * RooAbsGenContext::generate	(	Double_t	nEvents = `0`,
		Bool_t	skipInit = `kFALSE`,
		Bool_t	extendedMode = `kFALSE`
	)

virtual

Generate the specified number of events with nEvents>0 and and return a dataset containing the generated events.

With nEvents<=0, generate the number of events in the prototype dataset, if available, or else the expected number of events, if non-zero. If extendedMode = true generate according to a Poisson(nEvents) The returned dataset belongs to the caller. Return zero in case of an error. Generation of individual events is delegated to a virtual generateEvent() method. A virtual initGenerator() method is also called just before the first call to generateEvent().

Reimplemented in RooBinnedGenContext, and RooSimSplitGenContext.

Definition at line 150 of file RooAbsGenContext.cxx.

◆ generateEvent()

virtual void RooAbsGenContext::generateEvent	(	RooArgSet &	theEvent,
		Int_t	remaining
	)

pure virtual

Implemented in RooAddGenContext, RooBinnedGenContext, RooConvGenContext, RooEffGenContext, RooGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

◆ initGenerator()

void RooAbsGenContext::initGenerator ( const RooArgSet & theEvent )

virtual

Interface function to initialize context for generation for given set of observables.

Reimplemented in RooAddGenContext, RooBinnedGenContext, RooConvGenContext, RooEffGenContext, RooGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 271 of file RooAbsGenContext.cxx.

◆ isValid()

Bool_t RooAbsGenContext::isValid ( ) const

inline

Definition at line 34 of file RooAbsGenContext.h.

◆ isVerbose()

Bool_t RooAbsGenContext::isVerbose ( ) const

inline

Definition at line 43 of file RooAbsGenContext.h.

◆ Print()

virtual void RooAbsGenContext::Print ( Option_t * option = 0 ) const

inlinevirtual

Print TNamed name and title.

Reimplemented from TNamed.

Definition at line 50 of file RooAbsGenContext.h.

◆ printArgs()

void RooAbsGenContext::printArgs ( std::ostream & os ) const

virtual

Print arguments of context, i.e. the observables being generated in this context.

Reimplemented from RooPrintable.

Definition at line 310 of file RooAbsGenContext.cxx.

◆ printClassName()

void RooAbsGenContext::printClassName ( std::ostream & os ) const

virtual

Print class name of context.

Reimplemented from RooPrintable.

Definition at line 300 of file RooAbsGenContext.cxx.

◆ printMultiline()

void RooAbsGenContext::printMultiline	(	std::ostream &	os,
		Int_t	contents,
		Bool_t	verbose = `kFALSE`,
		TString	indent = `""`
	)		const

virtual

Interface for multi-line printing.

Reimplemented from RooPrintable.

Reimplemented in RooAddGenContext, RooBinnedGenContext, RooConvGenContext, RooGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 333 of file RooAbsGenContext.cxx.

◆ printName()

void RooAbsGenContext::printName ( std::ostream & os ) const

virtual

Print name of context.

Reimplemented from RooPrintable.

Definition at line 280 of file RooAbsGenContext.cxx.

◆ printTitle()

void RooAbsGenContext::printTitle ( std::ostream & os ) const

virtual

Print title of context.

Reimplemented from RooPrintable.

Definition at line 290 of file RooAbsGenContext.cxx.

◆ resampleData()

void RooAbsGenContext::resampleData ( Double_t & ratio )

protected

Rescale existing output buffer with given ratio.

Definition at line 371 of file RooAbsGenContext.cxx.

◆ setExpectedData()

virtual void RooAbsGenContext::setExpectedData ( Bool_t )

inlinevirtual

Reimplemented in RooBinnedGenContext, and RooSimSplitGenContext.

Definition at line 66 of file RooAbsGenContext.h.

◆ setProtoDataOrder()

void RooAbsGenContext::setProtoDataOrder ( Int_t * lut )

virtual

Set the traversal order of prototype data to that in the lookup tables passed as argument.

The LUT must be an array of integers with the same size as the number of entries in the prototype dataset and must contain integer values in the range [0,Nevt-1]

Reimplemented in RooBinnedGenContext, RooAddGenContext, RooConvGenContext, RooProdGenContext, RooSimGenContext, and RooSimSplitGenContext.

Definition at line 346 of file RooAbsGenContext.cxx.

◆ setVerbose()

void RooAbsGenContext::setVerbose ( Bool_t verbose = kTRUE )

inline

Definition at line 39 of file RooAbsGenContext.h.

Member Data Documentation

◆ _expectedEvents

UInt_t RooAbsGenContext::_expectedEvents

protected

Definition at line 81 of file RooAbsGenContext.h.

◆ _extendMode

RooAbsPdf::ExtendMode RooAbsGenContext::_extendMode

protected

Definition at line 84 of file RooAbsGenContext.h.

◆ _genData

RooDataSet* RooAbsGenContext::_genData

protected

Definition at line 88 of file RooAbsGenContext.h.

◆ _isValid

Bool_t RooAbsGenContext::_isValid

protected

Definition at line 79 of file RooAbsGenContext.h.

◆ _nextProtoIndex

Int_t RooAbsGenContext::_nextProtoIndex

protected

Definition at line 83 of file RooAbsGenContext.h.

◆ _normRange

TString RooAbsGenContext::_normRange

protected

Definition at line 86 of file RooAbsGenContext.h.

◆ _protoOrder

Int_t* RooAbsGenContext::_protoOrder

protected

Definition at line 85 of file RooAbsGenContext.h.

◆ _prototype

const RooDataSet* RooAbsGenContext::_prototype

protected

Definition at line 77 of file RooAbsGenContext.h.

◆ _protoVars

RooArgSet RooAbsGenContext::_protoVars

protected

Definition at line 82 of file RooAbsGenContext.h.

◆ _theEvent

RooArgSet RooAbsGenContext::_theEvent

protected

Definition at line 78 of file RooAbsGenContext.h.

◆ _verbose

Bool_t RooAbsGenContext::_verbose

protected

Definition at line 80 of file RooAbsGenContext.h.

Libraries for RooAbsGenContext:

[legend]

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RooAbsGenContext()

◆ ~RooAbsGenContext()

Member Function Documentation

◆ attach()

◆ createDataSet()

◆ defaultPrintContents()

◆ defaultPrintStyle()

◆ generate()

◆ generateEvent()

◆ initGenerator()

◆ isValid()

◆ isVerbose()

◆ Print()

◆ printArgs()

◆ printClassName()

◆ printMultiline()

◆ printName()

◆ printTitle()

◆ resampleData()

◆ setExpectedData()

◆ setProtoDataOrder()

◆ setVerbose()

Member Data Documentation

◆ _expectedEvents

◆ _extendMode

◆ _genData

◆ _isValid

◆ _nextProtoIndex

◆ _normRange

◆ _protoOrder

◆ _prototype

◆ _protoVars

◆ _theEvent

◆ _verbose