RooWorkspace Class Reference

The RooWorkspace is a persistable container for RooFit projects.

A workspace can contain and own variables, p.d.f.s, functions and datasets. All objects that live in the workspace are owned by the workspace. The import() method enforces consistency of objects upon insertion into the workspace (e.g. no duplicate object with the same name are allowed) and makes sure all objects in the workspace are connected to each other. Easy accessor methods like pdf(), var() and data() allow to refer to the contents of the workspace by object name. The entire RooWorkspace can be saved into a ROOT TFile and organises the consistent streaming of its contents without duplication. If a RooWorkspace contains custom classes, i.e. classes not in the ROOT distribution, portability of workspaces can be enhanced by storing the source code of those classes in the workspace as well. This process is also organized by the workspace through the importClassCode() method.

Seemingly random crashes when reading large workspaces

When reading or loading workspaces with deeply nested PDFs, one can encounter ouf-of-memory errors if the stack size is too small. This manifests in crashes at seemingly random locations, or in the process silently ending. Unfortunately, ROOT neither recover from this situation, nor warn or give useful instructions. When suspecting to have run out of stack memory, check

ulimit -s

and try reading again.

PyROOT

The RooWorkspace::import function can't be used in PyROOT because import is a reserved python keyword. For this reason, an alternative with a capitalized name is provided:

workspace.Import(x)

Definition at line 43 of file RooWorkspace.h.

Classes
class	CodeRepo
class	WSDir

Public Member Functions
	RooWorkspace ()
	Default constructor. More...
	RooWorkspace (const char *name, bool doCINTExport)
	Construct empty workspace with given name and option to export reference to all workspace contents to a CINT namespace with the same name. More...
	RooWorkspace (const char *name, const char *title=nullptr)
	Construct empty workspace with given name and title. More...
	RooWorkspace (const RooWorkspace &other)
	Workspace copy constructor. More...
	~RooWorkspace () override
	Workspace destructor. More...
bool	addStudy (RooAbsStudy &study)
	Insert RooStudyManager module. More...
RooArgSet	allCatFunctions () const
	Return set with all category function objects. More...
RooArgSet	allCats () const
	Return set with all category objects. More...
std::list< RooAbsData * >	allData () const
	Return list of all dataset in the workspace. More...
std::list< RooAbsData * >	allEmbeddedData () const
	Return list of all dataset in the workspace. More...
RooArgSet	allFunctions () const
	Return set with all function objects. More...
std::list< TObject * >	allGenericObjects () const
	Return list of all generic objects in the workspace. More...
RooArgSet	allPdfs () const
	Return set with all probability density function objects. More...
RooArgSet	allResolutionModels () const
	Return set with all resolution model objects. More...
RooArgSet	allVars () const
	Return set with all variable objects. More...
RooAbsArg *	arg (RooStringView name) const
	Return RooAbsArg with given name. A null pointer is returned if none is found. More...
RooArgSet	argSet (RooStringView nameList) const
	Return set of RooAbsArgs matching to given list of names. More...
bool	cancelTransaction ()
	Cancel an ongoing import transaction. More...
RooCategory *	cat (RooStringView name) const
	Retrieve discrete variable (RooCategory) with given name. A null pointer is returned if not found. More...
RooAbsCategory *	catfunc (RooStringView name) const
	Retrieve discrete function (RooAbsCategory) with given name. A null pointer is returned if not found. More...
bool	cd (const char *path=nullptr)
void	clearStudies ()
	Remove all RooStudyManager modules. More...
bool	commitTransaction ()
TIterator *	componentIterator () const
const RooArgSet &	components () const
RooAbsData *	data (RooStringView name) const
	Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found. More...
bool	defineSet (const char *name, const char *contentList)
	Define a named set in the work space through a comma separated list of names of objects already in the workspace. More...
bool	defineSet (const char *name, const RooArgSet &aset, bool importMissing=false)
	Define a named RooArgSet with given constituents. More...
RooAbsData *	embeddedData (RooStringView name) const
	Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found. More...
RooExpensiveObjectCache &	expensiveObjectCache ()
bool	extendSet (const char *name, const char *newContents)
	Define a named set in the work space through a comma separated list of names of objects already in the workspace. More...
RooFactoryWSTool &	factory ()
	Return instance to factory tool. More...
RooAbsArg *	factory (RooStringView expr)
	Short-hand function for factory()->process(expr); More...
RooAbsReal *	function (RooStringView name) const
	Retrieve function (RooAbsReal) with given name. Note that all RooAbsPdfs are also RooAbsReals. A null pointer is returned if not found. More...
RooAbsArg *	fundArg (RooStringView name) const
	Return fundamental (i.e. More...
TObject *	genobj (RooStringView name) const
	Return generic object with given name. More...
const RooArgSet *	getSnapshot (const char *name) const
	Return the RooArgSet containing a snapshot of variables contained in the workspace. More...
RooLinkedList const &	getSnapshots () const
bool	import (const char *fileSpec, const RooCmdArg &arg1=RooCmdArg(), const RooCmdArg &arg2=RooCmdArg(), const RooCmdArg &arg3=RooCmdArg(), const RooCmdArg &arg4=RooCmdArg(), const RooCmdArg &arg5=RooCmdArg(), const RooCmdArg &arg6=RooCmdArg(), const RooCmdArg &arg7=RooCmdArg(), const RooCmdArg &arg8=RooCmdArg(), const RooCmdArg &arg9=RooCmdArg())
	Import a RooAbsArg or RooAbsData set from a workspace in a file. More...
bool	import (const RooAbsArg &arg, const RooCmdArg &arg1=RooCmdArg(), const RooCmdArg &arg2=RooCmdArg(), const RooCmdArg &arg3=RooCmdArg(), const RooCmdArg &arg4=RooCmdArg(), const RooCmdArg &arg5=RooCmdArg(), const RooCmdArg &arg6=RooCmdArg(), const RooCmdArg &arg7=RooCmdArg(), const RooCmdArg &arg8=RooCmdArg(), const RooCmdArg &arg9=RooCmdArg())
	Import a RooAbsArg object, e.g. More...
bool	import (const RooArgSet &args, const RooCmdArg &arg1=RooCmdArg(), const RooCmdArg &arg2=RooCmdArg(), const RooCmdArg &arg3=RooCmdArg(), const RooCmdArg &arg4=RooCmdArg(), const RooCmdArg &arg5=RooCmdArg(), const RooCmdArg &arg6=RooCmdArg(), const RooCmdArg &arg7=RooCmdArg(), const RooCmdArg &arg8=RooCmdArg(), const RooCmdArg &arg9=RooCmdArg())
	Import multiple RooAbsArg objects into workspace. More...
bool	import (RooAbsData &data, const RooCmdArg &arg1=RooCmdArg(), const RooCmdArg &arg2=RooCmdArg(), const RooCmdArg &arg3=RooCmdArg(), const RooCmdArg &arg4=RooCmdArg(), const RooCmdArg &arg5=RooCmdArg(), const RooCmdArg &arg6=RooCmdArg(), const RooCmdArg &arg7=RooCmdArg(), const RooCmdArg &arg8=RooCmdArg(), const RooCmdArg &arg9=RooCmdArg())
	Import a dataset (RooDataSet or RooDataHist) into the work space. More...
bool	import (TObject &object, bool replaceExisting=false)
	Import a clone of a generic TObject into workspace generic object container. More...
bool	import (TObject &object, const char *aliasName, bool replaceExisting=false)
	Import a clone of a generic TObject into workspace generic object container. More...
bool	importClassCode (const char *pat="*", bool doReplace=false)
	Inport code of all classes in the workspace that have a class name that matches pattern 'pat' and which are not found to be part of the standard ROOT distribution. More...
bool	importClassCode (TClass *theClass, bool doReplace=false)
TClass *	IsA () const override
bool	loadSnapshot (const char *name)
	Load the values and attributes of the parameters in the snapshot saved with the given name. More...
bool	makeDir ()
	Create transient TDirectory representation of this workspace. More...
void	merge (const RooWorkspace &)
TObject *	obj (RooStringView name) const
	Return any type of object (RooAbsArg, RooAbsData or generic object) with given name) More...
RooAbsPdf *	pdf (RooStringView name) const
	Retrieve p.d.f (RooAbsPdf) with given name. A null pointer is returned if not found. More...
void	Print (Option_t *opts=nullptr) const override
	Print contents of the workspace. More...
void	RecursiveRemove (TObject *obj) override
	If one of the TObject we have a referenced to is deleted, remove the reference. More...
bool	removeSet (const char *name)
	Remove a named set from the workspace. More...
bool	renameSet (const char *name, const char *newName)
	Rename set to a new name. More...
bool	saveSnapshot (RooStringView, const char *paramNames)
	Save snapshot of values and attributes (including "Constant") of given parameters. More...
bool	saveSnapshot (RooStringView, const RooArgSet &params, bool importValues=false)
	Save snapshot of values and attributes (including "Constant") of parameters 'params'. More...
const RooArgSet *	set (const char *name)
	Return pointer to previously defined named set with given nmame If no such set is found a null pointer is returned. More...
const std::map< std::string, RooArgSet > &	sets () const
bool	startTransaction ()
	Open an import transaction operations. More...
void	Streamer (TBuffer &) override
	Stream an object of class RooWorkspace. More...
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
TIterator *	studyIterator ()
void	useFindsWithHashLookup (bool flag)
	Make internal collection use an unordered_map for faster searching. More...
const TUUID &	uuid () const
RooRealVar *	var (RooStringView name) const
	Retrieve real-valued variable (RooRealVar) with given name. A null pointer is returned if not found. More...
bool	writeToFile (const char *fileName, bool recreate=true)
	Save this current workspace into given file. More...
Public Member Functions inherited from TNamed
	TNamed ()
	TNamed (const char *name, const char *title)
	TNamed (const TNamed &named)
	TNamed copy ctor. More...
	TNamed (const TString &name, const TString &title)
virtual	~TNamed ()
	TNamed destructor. More...
void	Clear (Option_t *option="") override
	Set name and title to empty strings (""). More...
TObject *	Clone (const char *newname="") const override
	Make a clone of an object using the Streamer facility. More...
Int_t	Compare (const TObject *obj) const override
	Compare two TNamed objects. More...
void	Copy (TObject &named) const override
	Copy this to obj. More...
virtual void	FillBuffer (char *&buffer)
	Encode TNamed into output buffer. More...
const char *	GetName () const override
	Returns name of object. More...
const char *	GetTitle () const override
	Returns title of object. More...
ULong_t	Hash () const override
	Return hash value for this object. More...
TClass *	IsA () const override
Bool_t	IsSortable () const override
void	ls (Option_t *option="") const override
	List TNamed name and title. More...
TNamed &	operator= (const TNamed &rhs)
	TNamed assignment operator. More...
void	Print (Option_t *option="") const override
	Print TNamed name and title. More...
virtual void	SetName (const char *name)
	Set the name of the TNamed. More...
virtual void	SetNameTitle (const char *name, const char *title)
	Set all the TNamed parameters (name and title). More...
virtual void	SetTitle (const char *title="")
	Set the title of the TNamed. More...
virtual Int_t	Sizeof () const
	Return size of the TNamed part of the TObject. More...
void	Streamer (TBuffer &) override
	Stream an object of class TObject. More...
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
Public Member Functions inherited from TObject
	TObject ()
	TObject constructor. More...
	TObject (const TObject &object)
	TObject copy ctor. More...
virtual	~TObject ()
	TObject destructor. More...
void	AbstractMethod (const char *method) const
	Use this method to implement an "abstract" method that you don't want to leave purely abstract. More...
virtual void	AppendPad (Option_t *option="")
	Append graphics object to current pad. More...
virtual void	Browse (TBrowser *b)
	Browse object. May be overridden for another default action. More...
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. More...
virtual const char *	ClassName () const
	Returns name of class to which the object belongs. More...
virtual void	Clear (Option_t *="")
virtual TObject *	Clone (const char *newname="") const
	Make a clone of an object using the Streamer facility. More...
virtual Int_t	Compare (const TObject *obj) const
	Compare abstract method. More...
virtual void	Copy (TObject &object) const
	Copy this to obj. More...
virtual void	Delete (Option_t *option="")
	Delete this object. More...
virtual Int_t	DistancetoPrimitive (Int_t px, Int_t py)
	Computes distance from point (px,py) to the object. More...
virtual void	Draw (Option_t *option="")
	Default Draw method for all objects. More...
virtual void	DrawClass () const
	Draw class inheritance tree of the class to which this object belongs. More...
virtual TObject *	DrawClone (Option_t *option="") const
	Draw a clone of this object in the current selected pad with: gROOT->SetSelectedPad(c1). More...
virtual void	Dump () const
	Dump contents of object on stdout. More...
virtual void	Error (const char *method, const char *msgfmt,...) const
	Issue error message. More...
virtual void	Execute (const char *method, const char *params, Int_t *error=nullptr)
	Execute method on this object with the given parameter string, e.g. More...
virtual void	Execute (TMethod *method, TObjArray *params, Int_t *error=nullptr)
	Execute method on this object with parameters stored in the TObjArray. More...
virtual void	ExecuteEvent (Int_t event, Int_t px, Int_t py)
	Execute action corresponding to an event at (px,py). More...
virtual void	Fatal (const char *method, const char *msgfmt,...) const
	Issue fatal error message. More...
virtual TObject *	FindObject (const char *name) const
	Must be redefined in derived classes. More...
virtual TObject *	FindObject (const TObject *obj) const
	Must be redefined in derived classes. More...
virtual Option_t *	GetDrawOption () const
	Get option used by the graphics system to draw this object. More...
virtual const char *	GetIconName () const
	Returns mime type name of object. More...
virtual const char *	GetName () const
	Returns name of object. More...
virtual char *	GetObjectInfo (Int_t px, Int_t py) const
	Returns string containing info about the object at position (px,py). More...
virtual Option_t *	GetOption () const
virtual const char *	GetTitle () const
	Returns title of object. More...
virtual UInt_t	GetUniqueID () const
	Return the unique object id. More...
virtual Bool_t	HandleTimer (TTimer *timer)
	Execute action in response of a timer timing out. More...
virtual ULong_t	Hash () const
	Return hash value for this object. More...
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. More...
virtual void	Info (const char *method, const char *msgfmt,...) const
	Issue info message. More...
virtual Bool_t	InheritsFrom (const char *classname) const
	Returns kTRUE if object inherits from class "classname". More...
virtual Bool_t	InheritsFrom (const TClass *cl) const
	Returns kTRUE if object inherits from TClass cl. More...
virtual void	Inspect () const
	Dump contents of this object in a graphics canvas. More...
void	InvertBit (UInt_t f)
virtual TClass *	IsA () const
Bool_t	IsDestructed () const
	IsDestructed. More...
virtual Bool_t	IsEqual (const TObject *obj) const
	Default equal comparison (objects are equal if they have the same address in memory). More...
virtual Bool_t	IsFolder () const
	Returns kTRUE in case object contains browsable objects (like containers or lists of other objects). More...
R__ALWAYS_INLINE Bool_t	IsOnHeap () const
virtual Bool_t	IsSortable () const
R__ALWAYS_INLINE Bool_t	IsZombie () const
virtual void	ls (Option_t *option="") const
	The ls function lists the contents of a class on stdout. More...
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). More...
virtual Bool_t	Notify ()
	This method must be overridden to handle object notification. More...
void	Obsolete (const char *method, const char *asOfVers, const char *removedFromVers) const
	Use this method to declare a method obsolete. More...
void	operator delete (void *ptr)
	Operator delete. More...
void	operator delete[] (void *ptr)
	Operator delete []. More...
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. More...
virtual void	Paint (Option_t *option="")
	This method must be overridden if a class wants to paint itself. More...
virtual void	Pop ()
	Pop on object drawn in a pad to the top of the display list. More...
virtual void	Print (Option_t *option="") const
	This method must be overridden when a class wants to print itself. More...
virtual Int_t	Read (const char *name)
	Read contents of object with specified name from the current directory. More...
virtual void	RecursiveRemove (TObject *obj)
	Recursively remove this object from a list. More...
void	ResetBit (UInt_t f)
virtual void	SaveAs (const char *filename="", Option_t *option="") const
	Save this object in the file specified by filename. More...
virtual void	SavePrimitive (std::ostream &out, Option_t *option="")
	Save a primitive as a C++ statement(s) on output stream "out". More...
void	SetBit (UInt_t f)
void	SetBit (UInt_t f, Bool_t set)
	Set or unset the user status bits as specified in f. More...
virtual void	SetDrawOption (Option_t *option="")
	Set drawing option for object. More...
virtual void	SetUniqueID (UInt_t uid)
	Set the unique object id. More...
virtual void	Streamer (TBuffer &)
	Stream an object of class TObject. More...
void	StreamerNVirtual (TBuffer &ClassDef_StreamerNVirtual_b)
virtual void	SysError (const char *method, const char *msgfmt,...) const
	Issue system error message. More...
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. More...
virtual void	Warning (const char *method, const char *msgfmt,...) const
	Issue warning message. More...
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0)
	Write this object to the current directory. More...
virtual Int_t	Write (const char *name=nullptr, Int_t option=0, Int_t bufsize=0) const
	Write this object to the current directory. More...

Static Public Member Functions
static void	addClassDeclImportDir (const char *dir)
	Add dir to search path for class declaration (header) files. More...
static void	addClassImplImportDir (const char *dir)
	Add dir to search path for class implementation (.cxx) files. More...
static void	autoImportClassCode (bool flag)
	If flag is true, source code of classes not the ROOT distribution is automatically imported if on object of such a class is imported in the workspace. More...
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
static void	setClassFileExportDir (const char *dir=nullptr)
	Specify the name of the directory in which embedded source code is unpacked and compiled. More...
Static Public Member Functions inherited from TNamed
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
Static Public Member Functions inherited from TObject
static TClass *	Class ()
static const char *	Class_Name ()
static constexpr Version_t	Class_Version ()
static const char *	DeclFileName ()
static Longptr_t	GetDtorOnly ()
	Return destructor only flag. More...
static Bool_t	GetObjectStat ()
	Get status of object stat flag. More...
static void	SetDtorOnly (void *obj)
	Set destructor only flag. More...
static void	SetObjectStat (Bool_t stat)
	Turn on/off tracking of objects in the TObjectTable. More...

Private Member Functions
bool	defineSetInternal (const char *name, const RooArgSet &aset)

Private Attributes
RooArgSet	_allOwnedNodes
	List of owned pdfs and components. More...
CodeRepo	_classes
RooLinkedList	_dataList
	List of owned datasets. More...
WSDir *	_dir = nullptr
	! Transient ROOT directory representation of workspace More...
bool	_doExport
	! Export contents of workspace to CINT? More...
RooLinkedList	_embeddedDataList
	List of owned datasets that are embedded in pdfs. More...
RooExpensiveObjectCache	_eocache
	Cache for expensive objects. More...
std::string	_exportNSName
	! Name of CINT namespace to which contents are exported More...
std::unique_ptr< RooFactoryWSTool >	_factory
	! Factory tool associated with workspace More...
RooLinkedList	_genObjects
	List of generic objects. More...
std::map< std::string, RooArgSet >	_namedSets
	Map of named RooArgSets. More...
bool	_openTrans = false
	! Is there a transaction open? More...
RooArgSet	_sandboxNodes
	! Sandbox for incoming objects in a transaction More...
RooLinkedList	_snapshots
	List of parameter snapshots. More...
RooLinkedList	_studyMods
	List if StudyManager modules. More...
TUUID	_uuid
RooLinkedList	_views
	List of model views. More...

Static Private Attributes
static bool	_autoClass = false
static std::list< std::string >	_classDeclDirList
static std::string	_classFileExportDir = ".wscode.%s.%s"
static std::list< std::string >	_classImplDirList

Friends
class	CodeRepo
class	RooAbsArg
class	RooAbsPdf
class	RooConstraintSum

Additional Inherited Members
Public Types inherited from TObject
enum	{   kIsOnHeap = 0x01000000 , kNotDeleted = 0x02000000 , kZombie = 0x04000000 , kInconsistent = 0x08000000 ,   kBitMask = 0x00ffffff }
enum	{ kSingleKey = (1ULL << ( 0 )) , kOverwrite = (1ULL << ( 1 )) , kWriteDelete = (1ULL << ( 2 )) }
enum	EDeprecatedStatusBits { kObjInCanvas = (1ULL << ( 3 )) }
enum	EStatusBits {   kCanDelete = (1ULL << ( 0 )) , kMustCleanup = (1ULL << ( 3 )) , kIsReferenced = (1ULL << ( 4 )) , kHasUUID = (1ULL << ( 5 )) ,   kCannotPick = (1ULL << ( 6 )) , kNoContextMenu = (1ULL << ( 8 )) , kInvalidObject = (1ULL << ( 13 )) }
Protected Types inherited from TObject
enum	{ kOnlyPrepStep = (1ULL << ( 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). More...
void	MakeZombie ()
Protected Attributes inherited from TNamed
TString	fName
TString	fTitle

#include <RooWorkspace.h>

Inheritance diagram for RooWorkspace:

Constructor & Destructor Documentation

RooWorkspace() [1/4]

RooWorkspace::RooWorkspace

(

)

Default constructor.

Definition at line 162 of file RooWorkspace.cxx.

RooWorkspace() [2/4]

RooWorkspace::RooWorkspace	(	const char *	name,
		bool	doCINTExport
	)

Construct empty workspace with given name and option to export reference to all workspace contents to a CINT namespace with the same name.

Definition at line 180 of file RooWorkspace.cxx.

RooWorkspace() [3/4]

RooWorkspace::RooWorkspace	(	const char *	name,
		const char *	title = nullptr
	)

Construct empty workspace with given name and title.

Definition at line 171 of file RooWorkspace.cxx.

RooWorkspace() [4/4]

RooWorkspace::RooWorkspace

(

const RooWorkspace &

other

)

Workspace copy constructor.

Definition at line 189 of file RooWorkspace.cxx.

~RooWorkspace()

RooWorkspace::~RooWorkspace ( )

override

Workspace destructor.

Definition at line 231 of file RooWorkspace.cxx.

Member Function Documentation

addClassDeclImportDir()

void RooWorkspace::addClassDeclImportDir ( const char *  dir )

static

Add dir to search path for class declaration (header) files.

This is needed to find class headers custom classes are imported into the workspace.

Definition at line 117 of file RooWorkspace.cxx.

addClassImplImportDir()

void RooWorkspace::addClassImplImportDir ( const char *  dir )

static

Add dir to search path for class implementation (.cxx) files.

This is needed to find class headers custom classes are imported into the workspace.

Definition at line 126 of file RooWorkspace.cxx.

addStudy()

bool RooWorkspace::addStudy

(

RooAbsStudy &

study

)

Insert RooStudyManager module.

Definition at line 1965 of file RooWorkspace.cxx.

allCatFunctions()

RooArgSet RooWorkspace::allCatFunctions

(

)

const

Return set with all category function objects.

Definition at line 1369 of file RooWorkspace.cxx.

allCats()

RooArgSet RooWorkspace::allCats

(

)

const

Return set with all category objects.

Definition at line 1329 of file RooWorkspace.cxx.

allData()

std::list< RooAbsData * > RooWorkspace::allData

(

)

const

Return list of all dataset in the workspace.

Definition at line 1426 of file RooWorkspace.cxx.

allEmbeddedData()

std::list< RooAbsData * > RooWorkspace::allEmbeddedData

(

)

const

Return list of all dataset in the workspace.

Definition at line 1439 of file RooWorkspace.cxx.

allFunctions()

RooArgSet RooWorkspace::allFunctions

(

)

const

Return set with all function objects.

Definition at line 1348 of file RooWorkspace.cxx.

allGenericObjects()

std::list< TObject * > RooWorkspace::allGenericObjects

(

)

const

Return list of all generic objects in the workspace.

Definition at line 1453 of file RooWorkspace.cxx.

allPdfs()

RooArgSet RooWorkspace::allPdfs

(

)

const

Return set with all probability density function objects.

Definition at line 1407 of file RooWorkspace.cxx.

allResolutionModels()

RooArgSet RooWorkspace::allResolutionModels

(

)

const

Return set with all resolution model objects.

Definition at line 1388 of file RooWorkspace.cxx.

allVars()

RooArgSet RooWorkspace::allVars

(

)

const

Return set with all variable objects.

Definition at line 1311 of file RooWorkspace.cxx.

arg()

RooAbsArg * RooWorkspace::arg

(

RooStringView

name

)

const

Return RooAbsArg with given name. A null pointer is returned if none is found.

Definition at line 1246 of file RooWorkspace.cxx.

argSet()

RooArgSet RooWorkspace::argSet

(

RooStringView

nameList

)

const

Return set of RooAbsArgs matching to given list of names.

Definition at line 1256 of file RooWorkspace.cxx.

autoImportClassCode()

void RooWorkspace::autoImportClassCode ( bool  flag )

static

If flag is true, source code of classes not the ROOT distribution is automatically imported if on object of such a class is imported in the workspace.

Definition at line 152 of file RooWorkspace.cxx.

cancelTransaction()

bool RooWorkspace::cancelTransaction

(

)

Cancel an ongoing import transaction.

All objects imported since startTransaction() will be removed and the transaction will be terminated. Return true if cancel operation succeeds, return false if there was no open transaction

Definition at line 1035 of file RooWorkspace.cxx.

cat()

RooCategory * RooWorkspace::cat

(

RooStringView

name

)

const

Retrieve discrete variable (RooCategory) with given name. A null pointer is returned if not found.

Definition at line 1227 of file RooWorkspace.cxx.

catfunc()

RooAbsCategory * RooWorkspace::catfunc

(

RooStringView

name

)

const

Retrieve discrete function (RooAbsCategory) with given name. A null pointer is returned if not found.

Definition at line 1236 of file RooWorkspace.cxx.

cd()

bool RooWorkspace::cd

(

const char *

path = nullptr

)

Definition at line 2026 of file RooWorkspace.cxx.

Class()

static TClass * RooWorkspace::Class ( )

static

Returns

TClass describing this class

Class_Name()

static const char * RooWorkspace::Class_Name ( )

static

Returns

Name of this class

Class_Version()

static constexpr Version_t RooWorkspace::Class_Version ( )

inlinestaticconstexpr

Returns

Version of this class

Definition at line 285 of file RooWorkspace.h.

clearStudies()

void RooWorkspace::clearStudies

(

)

Remove all RooStudyManager modules.

Definition at line 1978 of file RooWorkspace.cxx.

commitTransaction()

bool RooWorkspace::commitTransaction

(

)

Definition at line 1054 of file RooWorkspace.cxx.

componentIterator()

TIterator * RooWorkspace::componentIterator ( ) const

inline

Definition at line 113 of file RooWorkspace.h.

components()

const RooArgSet & RooWorkspace::components ( ) const

inline

Definition at line 116 of file RooWorkspace.h.

data()

RooAbsData * RooWorkspace::data

(

RooStringView

name

)

const

Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found.

Definition at line 1291 of file RooWorkspace.cxx.

DeclFileName()

static const char * RooWorkspace::DeclFileName ( )

inlinestatic

Returns

Name of the file containing the class declaration

Definition at line 285 of file RooWorkspace.h.

defineSet() [1/2]

bool RooWorkspace::defineSet	(	const char *	name,
		const char *	contentList
	)

Define a named set in the work space through a comma separated list of names of objects already in the workspace.

Definition at line 888 of file RooWorkspace.cxx.

defineSet() [2/2]

bool RooWorkspace::defineSet	(	const char *	name,
		const RooArgSet &	aset,
		bool	importMissing = false
	)

Define a named RooArgSet with given constituents.

If importMissing is true, any constituents of aset that are not in the workspace will be imported, otherwise an error is returned for missing components

Definition at line 830 of file RooWorkspace.cxx.

defineSetInternal()

bool RooWorkspace::defineSetInternal ( const char *  name, const RooArgSet &  aset  )

private

Definition at line 864 of file RooWorkspace.cxx.

embeddedData()

RooAbsData * RooWorkspace::embeddedData

(

RooStringView

name

)

const

Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found.

Definition at line 1300 of file RooWorkspace.cxx.

expensiveObjectCache()

RooExpensiveObjectCache & RooWorkspace::expensiveObjectCache ( )

inline

Definition at line 167 of file RooWorkspace.h.

extendSet()

bool RooWorkspace::extendSet	(	const char *	name,
		const char *	newContents
	)

Define a named set in the work space through a comma separated list of names of objects already in the workspace.

Definition at line 923 of file RooWorkspace.cxx.

factory() [1/2]

RooFactoryWSTool & RooWorkspace::factory

(

)

Return instance to factory tool.

Definition at line 2049 of file RooWorkspace.cxx.

factory() [2/2]

RooAbsArg * RooWorkspace::factory

(

RooStringView

expr

)

Short-hand function for factory()->process(expr);

Create a RooFit object from the given expression.

Creating variables
x[-10,10]	Create variable x with given range and put it in workspace
x[3,-10,10]	Create variable x with given range and initial value and put it in workspace
x[3]	Create variable x with given constant value
<numeric literal>	Numeric literal expressions (0.5, -3 etc..) are converted to a RooConst(<numeric literal>) wherever a RooAbsReal or RooAbsArg argument is expected
Creating categories
c[lep,kao,nt1,nt2]	Create category c with given state names
tag[B0=1,B0bar=-1]	Create category tag with given state names and index assignments
Creating functions and pdfs
MyPdf::g(x,m,s)	Create pdf or function of type MyPdf with name g with argument x,m,s Interpretation and number of arguments are mapped to the constructor arguments of the class (after the name and title).
MyPdf(x,m,s)	As above, but with an implicitly defined (unique) object name
Creating sets and lists (to be used as inputs above)
{a,b,c}	Create RooArgSet or RooArgList (as determined by context) from given contents

Objects that are not created, are assumed to exist in the workspace Object creation expressions as shown above can be nested, e.g. one can do

RooGaussian::g(x[-10,10],m[0],3)

to create a pdf and its variables in one go. This nesting can be applied recursively e.g.

SUM::model( f[0.5,0,1] * RooGaussian::g( x[-10,10], m[0], 3] ),
                         RooChebychev::c( x, {a0[0.1],a1[0.2],a2[-0.3]} ))

creates the sum of a Gaussian and a Chebychev and all its variables.

A seperate series of operator meta-type exists to simplify the construction of composite expressions meta-types in all capitals (SUM) create pdfs, meta types in lower case (sum) create functions.

Expression	Effect
SUM::name(f1*pdf1,f2*pdf2,pdf3]	Create sum pdf name with value f1*pdf1+f2*pdf2+(1-f1-f2)*pdf3
RSUM::name(f1*pdf1,f2*pdf2,pdf3]	Create recursive sum pdf name with value f1*pdf1 + (1-f1)(f2*pdf2 + (1-f2)pdf3)
ASUM::name(f1*amp1,f2*amp2,amp3]	Create sum pdf name with value f1*amp1+f2*amp2+(1-f1-f2)*amp3 where amplX are amplitudes of type RooAbsReal
sum::name(a1,a2,a3]	Create sum function with value a1+a2+a3
sum::name(a1*b1,a2*b2,a3*b 3]	Create sum function with value a1*b1+a2*b2+a3*b3
PROD::name(pdf1,pdf2]	Create product of pdf with name with given input pdfs
PROD::name(pdf1|x,pdf2]	Create product of conditional pdf pdf1 given x and pdf2
prod::name(a,b,c]	Create production function with value a*b*c
SIMUL::name(cat,a=pdf1,b=pdf2]	Create simultaneous pdf index category cat. Make pdf1 to state a, pdf2 to state b
EXPR::name(<expr>,var,...]	Create a generic pdf that interprets the given expression
expr::name(<expr>,var,...]	Create a generic function that interprets the given expression
taylorexpand::name(func,{var1,var2,...},val,order,eps1,eps2]	Create a taylor expansion of func w.r.t. {var1,var2,..} around val up to order
‘lagrangianmorph::name("$fileName('infile.root&rsquo;),$observableName(obs),$couplings({var1[-10,10],var2[-10,10]}),$folders({'sample1,sample2,sample3'}),$NewPhysics(var1=1,var2=0)"]<td> Create a RooLagrangianMorphFunc function for the observable obs as a function ofvar1,var2` based on input templates stored in the folders in the file

The functionality of high-level object creation tools like RooSimWSTool, RooCustomizer and RooClassFactory is also interfaced through meta-types in the factory.

Interface to RooSimWSTool
SIMCLONE::name( modelPdf, $ParamSplit(...), $ParamSplitConstrained(...), $Restrict(...) ]	Clone-and-customize modelPdf according to ParamSplit and ParamSplitConstrained() specifications and return a RooSimultaneous pdf of all built clones
MSIMCLONE::name( masterIndex, $AddPdf(mstate1, modelPdf1, $ParamSplit(...)), $AddPdf(mstate2,modelPdf2),...) ]	Clone-and-customize multiple models (modelPdf1,modelPdf2) according to ParamSplit and ParamSplitConstrained() specifications and return a RooSimultaneous pdf of all built clones, using the specified master index to map prototype pdfs to master states
Interface to RooCustomizer
EDIT::name( orig, substNode=origNode), ... ]	Create a clone of input object orig, with the specified replacements operations executed
EDIT::name( orig, origNode=$REMOVE(), ... ]	Create clone of input removing term origNode from all PROD() terms that contained it
EDIT::name( orig, origNode=$REMOVE(prodname,...), ... ]	As above, but restrict removal of origNode to PROD term(s) prodname,...
Interface to RooClassFactory
CEXPR::name(<expr>,var,...]	Create a custom compiled pdf that evaluates the given expression
cexpr::name(<expr>,var,...]	Create a custom compiled function that evaluates the given expression
$MetaType(...)	Meta argument that does not result in construction of an object but is used logically organize input arguments in certain operator pdf constructions. The defined meta arguments are context dependent. The only meta argument that is defined globally is $Alias(typeName,aliasName) to define aliases for type names. For the definition of meta arguments in operator pdfs see the definitions below.

Definition at line 2066 of file RooWorkspace.cxx.

function()

RooAbsReal * RooWorkspace::function

(

RooStringView

name

)

const

Retrieve function (RooAbsReal) with given name. Note that all RooAbsPdfs are also RooAbsReals. A null pointer is returned if not found.

Definition at line 1209 of file RooWorkspace.cxx.

fundArg()

RooAbsArg * RooWorkspace::fundArg

(

RooStringView

name

)

const

Return fundamental (i.e.

non-derived) RooAbsArg with given name. Fundamental types are e.g. RooRealVar, RooCategory. A null pointer is returned if none is found.

Definition at line 1277 of file RooWorkspace.cxx.

genobj()

TObject * RooWorkspace::genobj

(

RooStringView

name

)

const

Return generic object with given name.

Definition at line 2008 of file RooWorkspace.cxx.

getSnapshot()

const RooArgSet * RooWorkspace::getSnapshot

(

const char *

name

)

const

Return the RooArgSet containing a snapshot of variables contained in the workspace.

Note that the variables of the objects in the snapshots are copies of the variables in the workspace. To load the values of a snapshot in the workspace variables, use loadSnapshot() instead.

Definition at line 1191 of file RooWorkspace.cxx.

getSnapshots()

RooLinkedList const & RooWorkspace::getSnapshots ( ) const

inline

Definition at line 98 of file RooWorkspace.h.

import() [1/6]

RooWorkspace::import	(	const char *	fileSpec,
		const RooCmdArg &	arg1 = RooCmdArg(),
		const RooCmdArg &	arg2 = RooCmdArg(),
		const RooCmdArg &	arg3 = RooCmdArg(),
		const RooCmdArg &	arg4 = RooCmdArg(),
		const RooCmdArg &	arg5 = RooCmdArg(),
		const RooCmdArg &	arg6 = RooCmdArg(),
		const RooCmdArg &	arg7 = RooCmdArg(),
		const RooCmdArg &	arg8 = RooCmdArg(),
		const RooCmdArg &	arg9 = RooCmdArg()
	)

Import a RooAbsArg or RooAbsData set from a workspace in a file.

Filespec should be constructed as "filename:wspacename:objectname" The arguments will be passed to the relevant import() or import(RooAbsData&, ...) import calls

Note

From python, use Import(), since import is a reserved keyword.

PyROOT

Support the C++ import() as Import() in python

Definition at line 255 of file RooWorkspace.cxx.

import() [2/6]

RooWorkspace::import	(	const RooAbsArg &	arg,
		const RooCmdArg &	arg1 = RooCmdArg(),
		const RooCmdArg &	arg2 = RooCmdArg(),
		const RooCmdArg &	arg3 = RooCmdArg(),
		const RooCmdArg &	arg4 = RooCmdArg(),
		const RooCmdArg &	arg5 = RooCmdArg(),
		const RooCmdArg &	arg6 = RooCmdArg(),
		const RooCmdArg &	arg7 = RooCmdArg(),
		const RooCmdArg &	arg8 = RooCmdArg(),
		const RooCmdArg &	arg9 = RooCmdArg()
	)

Import a RooAbsArg object, e.g.

function, p.d.f or variable into the workspace. This import function clones the input argument and will own the clone. If a composite object is offered for import, e.g. a p.d.f with parameters and observables, the complete tree of objects is imported. If any of the variables of a composite object (parameters/observables) are already in the workspace the imported p.d.f. is connected to the already existing variables. If any of the function objects (p.d.f, formulas) to be imported already exists in the workspace an error message is printed and the import of the entire tree of objects is cancelled. Several optional arguments can be provided to modify the import procedure.

Accepted arguments
RenameConflictNodes(const char* suffix)	Add suffix to branch node name if name conflicts with existing node in workspace
RenameAllNodes(const char* suffix)	Add suffix to all branch node names including top level node.
RenameAllVariables(const char* suffix)	Add suffix to all variables of objects being imported.
RenameAllVariablesExcept(const char* suffix, const char* exceptionList)	Add suffix to all variables names, except ones listed
RenameVariable(const char* inputName, const char* outputName)	Rename a single variable as specified upon import.
RecycleConflictNodes()	If any of the function objects to be imported already exist in the name space, connect the imported expression to the already existing nodes. Attention Use with care! If function definitions do not match, this alters the definition of your function upon import
Silence()	Do not issue any info message

The RenameConflictNodes, RenameNodes and RecycleConflictNodes arguments are mutually exclusive. The RenameVariable argument can be repeated as often as necessary to rename multiple variables. Alternatively, a single RenameVariable argument can be given with two comma separated lists.

Note

From python, use Import(), since import is a reserved keyword.

PyROOT

Support the C++ import() as Import() in python

PyROOT

The RooWorkspace constructor is pythonized with the command argument pythonization. The keywords must correspond to the CmdArgs of the constructor.

Definition at line 355 of file RooWorkspace.cxx.

import() [3/6]

bool RooWorkspace::import	(	const RooArgSet &	args,
		const RooCmdArg &	arg1 = RooCmdArg(),
		const RooCmdArg &	arg2 = RooCmdArg(),
		const RooCmdArg &	arg3 = RooCmdArg(),
		const RooCmdArg &	arg4 = RooCmdArg(),
		const RooCmdArg &	arg5 = RooCmdArg(),
		const RooCmdArg &	arg6 = RooCmdArg(),
		const RooCmdArg &	arg7 = RooCmdArg(),
		const RooCmdArg &	arg8 = RooCmdArg(),
		const RooCmdArg &	arg9 = RooCmdArg()
	)

Import multiple RooAbsArg objects into workspace.

For details on arguments see documentation of import() method for single RooAbsArg

Note

From python, use Import(), since import is a reserved keyword.

Definition at line 315 of file RooWorkspace.cxx.

import() [4/6]

RooWorkspace::import	(	RooAbsData &	data,
		const RooCmdArg &	arg1 = RooCmdArg(),
		const RooCmdArg &	arg2 = RooCmdArg(),
		const RooCmdArg &	arg3 = RooCmdArg(),
		const RooCmdArg &	arg4 = RooCmdArg(),
		const RooCmdArg &	arg5 = RooCmdArg(),
		const RooCmdArg &	arg6 = RooCmdArg(),
		const RooCmdArg &	arg7 = RooCmdArg(),
		const RooCmdArg &	arg8 = RooCmdArg(),
		const RooCmdArg &	arg9 = RooCmdArg()
	)

Import a dataset (RooDataSet or RooDataHist) into the work space.

The workspace will contain a copy of the data. The dataset and its variables can be renamed upon insertion with the options below

Accepted arguments
Rename(const char* suffix)	Rename dataset upon insertion
RenameVariable(const char* inputName, const char* outputName)	Change names of observables in dataset upon insertion
Silence	Be quiet, except in case of errors Note From python, use Import(), since import is a reserved keyword.

PyROOT

Support the C++ import() as Import() in python

Definition at line 712 of file RooWorkspace.cxx.