Logo ROOT  
Reference Guide
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.

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_t doCINTExport)
 
 RooWorkspace (const char *name, const char *title=0)
 Construct empty workspace with given name and title. More...
 
 RooWorkspace (const RooWorkspace &other)
 Workspace copy constructor. More...
 
 ~RooWorkspace ()
 Workspace destructor. More...
 
Bool_t 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...
 
RooAbsArgarg (const char *name) const
 Return RooAbsArg with given name. A null pointer is returned if none is found. More...
 
RooArgSet argSet (const char *nameList) const
 Return set of RooAbsArgs matching to given list of names. More...
 
Bool_t cancelTransaction ()
 Cancel an ongoing import transaction. More...
 
RooCategorycat (const char *name) const
 Retrieve discrete variable (RooCategory) with given name. A null pointer is returned if not found. More...
 
RooAbsCategorycatfunc (const char *name) const
 Retrieve discrete function (RooAbsCategory) with given name. A null pointer is returned if not found. More...
 
Bool_t cd (const char *path=0)
 
void clearStudies ()
 Remove all RooStudyManager modules. More...
 
Bool_t commitTransaction ()
 
TIteratorcomponentIterator () const
 
const RooArgSetcomponents () const
 
RooAbsDatadata (const char *name) const
 Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found. More...
 
Bool_t 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_t defineSet (const char *name, const RooArgSet &aset, Bool_t importMissing=kFALSE)
 Define a named RooArgSet with given constituents. More...
 
RooAbsDataembeddedData (const char *name) const
 Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found. More...
 
RooExpensiveObjectCacheexpensiveObjectCache ()
 
void exportToCint (const char *namespaceName=0)
 Activate export of workspace symbols to CINT in a namespace with given name. More...
 
Bool_t 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...
 
RooFactoryWSToolfactory ()
 Return instance to factory tool. More...
 
RooAbsArgfactory (const char *expr)
 Short-hand function for factory()->process(expr) ;. More...
 
RooAbsRealfunction (const char *name) const
 Retrieve function (RooAbsReal) with given name. Note that all RooAbsPdfs are also RooAbsReals. A null pointer is returned if not found. More...
 
RooAbsArgfundArg (const char *name) const
 Return fundamental (i.e. More...
 
TObjectgenobj (const char *name) const
 Return generic object with given name. More...
 
const RooArgSetgetSnapshot (const char *name) const
 Return the RooArgSet containing a snapshot of variables contained in the workspace. More...
 
Bool_t 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_t 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_t 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_t 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_t import (TObject &object, Bool_t replaceExisting=kFALSE)
 Import a clone of a generic TObject into workspace generic object container. More...
 
Bool_t import (TObject &object, const char *aliasName, Bool_t replaceExisting=kFALSE)
 Import a clone of a generic TObject into workspace generic object container. More...
 
Bool_t importClassCode (const char *pat="*", Bool_t doReplace=kFALSE)
 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_t importClassCode (TClass *theClass, Bool_t doReplace=kFALSE)
 
Bool_t loadSnapshot (const char *name)
 Load the values and attributes of the parameters in the snapshot saved with the given name. More...
 
Bool_t makeDir ()
 Create transient TDirectory representation of this workspace. More...
 
void merge (const RooWorkspace &)
 
TObjectobj (const char *name) const
 Return any type of object (RooAbsArg, RooAbsData or generic object) with given name) More...
 
RooAbsPdfpdf (const char *name) const
 Retrieve p.d.f (RooAbsPdf) with given name. A null pointer is returned if not found. More...
 
void Print (Option_t *opts=0) const
 Print contents of the workspace. More...
 
virtual void RecursiveRemove (TObject *obj)
 If one of the TObject we have a referenced to is deleted, remove the reference. More...
 
Bool_t removeSet (const char *name)
 Remove a named set from the workspace. More...
 
Bool_t renameSet (const char *name, const char *newName)
 Rename set to a new name. More...
 
Bool_t saveSnapshot (const char *name, const char *paramNames)
 Save snapshot of values and attributes (including "Constant") of given parameters. More...
 
Bool_t saveSnapshot (const char *name, const RooArgSet &params, Bool_t importValues=kFALSE)
 Save snapshot of values and attributes (including "Constant") of parameters 'params'. More...
 
const RooArgSetset (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...
 
Bool_t startTransaction ()
 Open an import transaction operations. More...
 
TIteratorstudyIterator ()
 
const TUUIDuuid () const
 
RooRealVarvar (const char *name) const
 Retrieve real-valued variable (RooRealVar) with given name. A null pointer is returned if not found. More...
 
Bool_t writeToFile (const char *fileName, Bool_t recreate=kTRUE)
 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...
 
virtual void Clear (Option_t *option="")
 Set name and title to empty strings (""). More...
 
virtual TObjectClone (const char *newname="") const
 Make a clone of an object using the Streamer facility. More...
 
virtual Int_t Compare (const TObject *obj) const
 Compare two TNamed objects. More...
 
virtual void Copy (TObject &named) const
 Copy this to obj. More...
 
virtual void FillBuffer (char *&buffer)
 Encode TNamed into output buffer. More...
 
virtual const char * GetName () const
 Returns name of object. More...
 
virtual const char * GetTitle () const
 Returns title of object. More...
 
virtual ULong_t Hash () const
 Return hash value for this object. More...
 
virtual Bool_t IsSortable () const
 
virtual void ls (Option_t *option="") const
 List TNamed name and title. More...
 
TNamedoperator= (const TNamed &rhs)
 TNamed assignment operator. More...
 
virtual void Print (Option_t *option="") const
 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...
 
- 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 TObjectClone (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 TObjectDrawClone (Option_t *option="") const
 Draw a clone of this object in the current selected pad for instance with: gROOT->SetSelectedPad(gPad). 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=0)
 Execute method on this object with the given parameter string, e.g. More...
 
virtual void Execute (TMethod *method, TObjArray *params, Int_t *error=0)
 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 TObjectFindObject (const char *name) const
 Must be redefined in derived classes. More...
 
virtual TObjectFindObject (const TObject *obj) const
 Must be redefined in derived classes. More...
 
virtual Option_tGetDrawOption () 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_tGetOption () 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 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...
 
voidoperator new (size_t sz)
 
voidoperator new (size_t sz, void *vp)
 
voidoperator new[] (size_t sz)
 
voidoperator new[] (size_t sz, void *vp)
 
TObjectoperator= (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 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=0, Int_t option=0, Int_t bufsize=0)
 Write this object to the current directory. More...
 
virtual Int_t Write (const char *name=0, 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_t flag)
 If flag is true, source code of classes not the the ROOT distribution is automatically imported if on object of such a class is imported in the workspace. More...
 
static void setClassFileExportDir (const char *dir=0)
 Specify the name of the directory in which embedded source code is unpacked and compiled. More...
 
- Static Public Member Functions inherited from TObject
static Long_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_t defineSetInternal (const char *name, const RooArgSet &aset)
 
void exportObj (TObject *obj)
 Export reference to given workspace object to CINT. More...
 
Bool_t isValidCPPID (const char *name)
 Return true if given name is a valid C++ identifier name. More...
 
void unExport ()
 Delete exported reference in CINT namespace. More...
 

Private Attributes

RooArgSet _allOwnedNodes
 
CodeRepo _classes
 
RooLinkedList _dataList
 
WSDir_dir
 
Bool_t _doExport
 Factory tool associated with workspace. More...
 
RooLinkedList _embeddedDataList
 
RooExpensiveObjectCache _eocache
 Transient ROOT directory representation of workspace. More...
 
std::string _exportNSName
 Export contents of workspace to CINT? More...
 
std::unique_ptr< RooFactoryWSTool_factory
 
RooLinkedList _genObjects
 
std::map< std::string, RooArgSet_namedSets
 
Bool_t _openTrans
 Name of CINT namespace to which contents are exported. More...
 
RooArgSet _sandboxNodes
 Is there a transaction open? More...
 
RooLinkedList _snapshots
 
RooLinkedList _studyMods
 
TUUID _uuid
 
RooLinkedList _views
 

Static Private Attributes

static Bool_t _autoClass = kFALSE
 
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
 

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)
}
 
- 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:
[legend]

Constructor & Destructor Documentation

◆ RooWorkspace() [1/4]

RooWorkspace::RooWorkspace ( )

Default constructor.

Definition at line 139 of file RooWorkspace.cxx.

◆ RooWorkspace() [2/4]

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

Definition at line 154 of file RooWorkspace.cxx.

◆ RooWorkspace() [3/4]

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

Construct empty workspace with given name and title.

Definition at line 148 of file RooWorkspace.cxx.

◆ RooWorkspace() [4/4]

RooWorkspace::RooWorkspace ( const RooWorkspace other)

Workspace copy constructor.

Definition at line 167 of file RooWorkspace.cxx.

◆ ~RooWorkspace()

RooWorkspace::~RooWorkspace ( )

Workspace destructor.

Definition at line 221 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 94 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 103 of file RooWorkspace.cxx.

◆ addStudy()

Bool_t RooWorkspace::addStudy ( RooAbsStudy study)

Insert RooStudyManager module.

Definition at line 2096 of file RooWorkspace.cxx.

◆ allCatFunctions()

RooArgSet RooWorkspace::allCatFunctions ( ) const

Return set with all category function objects.

Definition at line 1467 of file RooWorkspace.cxx.

◆ allCats()

RooArgSet RooWorkspace::allCats ( ) const

Return set with all category objects.

Definition at line 1422 of file RooWorkspace.cxx.

◆ allData()

list< RooAbsData * > RooWorkspace::allData ( ) const

Return list of all dataset in the workspace.

Definition at line 1530 of file RooWorkspace.cxx.

◆ allEmbeddedData()

list< RooAbsData * > RooWorkspace::allEmbeddedData ( ) const

Return list of all dataset in the workspace.

Definition at line 1546 of file RooWorkspace.cxx.

◆ allFunctions()

RooArgSet RooWorkspace::allFunctions ( ) const

Return set with all function objects.

Definition at line 1444 of file RooWorkspace.cxx.

◆ allGenericObjects()

list< TObject * > RooWorkspace::allGenericObjects ( ) const

Return list of all generic objects in the workspace.

Definition at line 1563 of file RooWorkspace.cxx.

◆ allPdfs()

RooArgSet RooWorkspace::allPdfs ( ) const

Return set with all probability density function objects.

Definition at line 1509 of file RooWorkspace.cxx.

◆ allResolutionModels()

RooArgSet RooWorkspace::allResolutionModels ( ) const

Return set with all resolution model objects.

Definition at line 1488 of file RooWorkspace.cxx.

◆ allVars()

RooArgSet RooWorkspace::allVars ( ) const

Return set with all variable objects.

Definition at line 1401 of file RooWorkspace.cxx.

◆ arg()

RooAbsArg * RooWorkspace::arg ( const char *  name) const

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

Definition at line 1336 of file RooWorkspace.cxx.

◆ argSet()

RooArgSet RooWorkspace::argSet ( const char *  nameList) const

Return set of RooAbsArgs matching to given list of names.

Definition at line 1346 of file RooWorkspace.cxx.

◆ autoImportClassCode()

void RooWorkspace::autoImportClassCode ( Bool_t  flag)
static

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

Definition at line 129 of file RooWorkspace.cxx.

◆ cancelTransaction()

Bool_t RooWorkspace::cancelTransaction ( )

Cancel an ongoing import transaction.

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

Definition at line 1075 of file RooWorkspace.cxx.

◆ cat()

RooCategory * RooWorkspace::cat ( const char *  name) const

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

Definition at line 1317 of file RooWorkspace.cxx.

◆ catfunc()

RooAbsCategory * RooWorkspace::catfunc ( const char *  name) const

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

Definition at line 1326 of file RooWorkspace.cxx.

◆ cd()

Bool_t RooWorkspace::cd ( const char *  path = 0)

Definition at line 2157 of file RooWorkspace.cxx.

◆ clearStudies()

void RooWorkspace::clearStudies ( )

Remove all RooStudyManager modules.

Definition at line 2109 of file RooWorkspace.cxx.

◆ commitTransaction()

Bool_t RooWorkspace::commitTransaction ( )

Definition at line 1097 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 114 of file RooWorkspace.h.

◆ data()

RooAbsData * RooWorkspace::data ( const char *  name) const

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

Definition at line 1381 of file RooWorkspace.cxx.

◆ defineSet() [1/2]

Bool_t 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 928 of file RooWorkspace.cxx.

◆ defineSet() [2/2]

Bool_t RooWorkspace::defineSet ( const char *  name,
const RooArgSet aset,
Bool_t  importMissing = kFALSE 
)

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 868 of file RooWorkspace.cxx.

◆ defineSetInternal()

Bool_t RooWorkspace::defineSetInternal ( const char *  name,
const RooArgSet aset 
)
private

Definition at line 904 of file RooWorkspace.cxx.

◆ embeddedData()

RooAbsData * RooWorkspace::embeddedData ( const char *  name) const

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

Definition at line 1390 of file RooWorkspace.cxx.

◆ expensiveObjectCache()

RooExpensiveObjectCache & RooWorkspace::expensiveObjectCache ( )
inline

Definition at line 156 of file RooWorkspace.h.

◆ exportObj()

void RooWorkspace::exportObj ( TObject obj)
private

Export reference to given workspace object to CINT.

Definition at line 3098 of file RooWorkspace.cxx.

◆ exportToCint()

void RooWorkspace::exportToCint ( const char *  nsname = 0)

Activate export of workspace symbols to CINT in a namespace with given name.

If no name is given the namespace will have the same name as the workspace

Definition at line 3062 of file RooWorkspace.cxx.

◆ extendSet()

Bool_t 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 963 of file RooWorkspace.cxx.

◆ factory() [1/2]

RooFactoryWSTool & RooWorkspace::factory ( )

Return instance to factory tool.

Definition at line 2180 of file RooWorkspace.cxx.

◆ factory() [2/2]

RooAbsArg * RooWorkspace::factory ( const char *  expr)

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

Definition at line 2196 of file RooWorkspace.cxx.

◆ function()

RooAbsReal * RooWorkspace::function ( const char *  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 1299 of file RooWorkspace.cxx.

◆ fundArg()

RooAbsArg * RooWorkspace::fundArg ( const char *  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 1367 of file RooWorkspace.cxx.

◆ genobj()

TObject * RooWorkspace::genobj ( const char *  name) const

Return generic object with given name.

Definition at line 2139 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 1244 of file RooWorkspace.cxx.

◆ import() [1/6]

Bool_t 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

Definition at line 245 of file RooWorkspace.cxx.

◆ import() [2/6]

Bool_t RooWorkspace::import ( const RooAbsArg inArg,
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 names
RenameAllVariablesExcept(const char* suffix, const char* exceptionList) Add suffix to all variables names, except ones listed
RenameVariable(const char* inputName, const char* outputName) Rename 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.

Definition at line 349 of file RooWorkspace.cxx.

◆ import() [3/6]

Bool_t 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

Definition at line 307 of file RooWorkspace.cxx.

◆ import() [4/6]

Bool_t RooWorkspace::import ( RooAbsData inData,
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

Definition at line 747 of file RooWorkspace.cxx.

◆ import() [5/6]

Bool_t RooWorkspace::import ( TObject object,
Bool_t  replaceExisting = kFALSE 
)

Import a clone of a generic TObject into workspace generic object container.

Imported object can be retrieved by name through the obj() method. The object is cloned upon importation and the input argument does not need to live beyond the import call

Returns kTRUE if an error has occurred.

Definition at line 2023 of file RooWorkspace.cxx.

◆ import() [6/6]

Bool_t RooWorkspace::import ( TObject object,
const char *  aliasName,
Bool_t  replaceExisting = kFALSE 
)

Import a clone of a generic TObject into workspace generic object container.

The imported object will be stored under the given alias name rather than its own name. Imported object can be retrieved its alias name through the obj() method. The object is cloned upon importation and the input argument does not need to live beyond the import call This method is mostly useful for importing objects that do not have a settable name such as TMatrix

Returns kTRUE if an error has occurred.

Definition at line 2064 of file RooWorkspace.cxx.

◆ importClassCode() [1/2]

Bool_t RooWorkspace::importClassCode ( const char *  pat = "*",
Bool_t  doReplace = kFALSE 
)

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.

If doReplace is true any existing class code saved in the workspace is replaced

Definition at line 1147 of file RooWorkspace.cxx.

◆ importClassCode() [2/2]

Bool_t RooWorkspace::importClassCode ( TClass theClass,
Bool_t  doReplace = kFALSE 
)

Definition at line 1134 of file RooWorkspace.cxx.

◆ isValidCPPID()

Bool_t RooWorkspace::isValidCPPID ( const char *  name)
private

Return true if given name is a valid C++ identifier name.

Definition at line 3127 of file RooWorkspace.cxx.

◆ loadSnapshot()

Bool_t RooWorkspace::loadSnapshot ( const char *  name)

Load the values and attributes of the parameters in the snapshot saved with the given name.

Definition at line 1221 of file RooWorkspace.cxx.

◆ makeDir()

Bool_t RooWorkspace::makeDir ( )

Create transient TDirectory representation of this workspace.

This directory will appear as a subdirectory of the directory that contains the workspace and will have the name of the workspace suffixed with "Dir". The TDirectory interface is read-only. Any attempt to insert objects into the workspace directory representation will result in an error message. Note that some ROOT object like TH1 automatically insert themselves into the current directory when constructed. This will give error messages when done in a workspace directory.

Definition at line 1996 of file RooWorkspace.cxx.

◆ merge()

void RooWorkspace::merge ( const RooWorkspace )
inline

Definition at line 96 of file RooWorkspace.h.

◆ obj()

TObject * RooWorkspace::obj ( const char *  name) const

Return any type of object (RooAbsArg, RooAbsData or generic object) with given name)

Definition at line 2120 of file RooWorkspace.cxx.

◆ pdf()

RooAbsPdf * RooWorkspace::pdf ( const char *  name) const

Retrieve p.d.f (RooAbsPdf) with given name. A null pointer is returned if not found.

Definition at line 1290 of file RooWorkspace.cxx.

◆ Print()

void RooWorkspace::Print ( Option_t opts = 0) const
virtual

Print contents of the workspace.

Reimplemented from TNamed.

Definition at line 2207 of file RooWorkspace.cxx.

◆ RecursiveRemove()

void RooWorkspace::RecursiveRemove ( TObject obj)
virtual

If one of the TObject we have a referenced to is deleted, remove the reference.

Reimplemented from TObject.

Definition at line 3164 of file RooWorkspace.cxx.

◆ removeSet()

Bool_t RooWorkspace::removeSet ( const char *  name)

Remove a named set from the workspace.

Definition at line 1033 of file RooWorkspace.cxx.

◆ renameSet()

Bool_t RooWorkspace::renameSet ( const char *  name,
const char *  newName 
)

Rename set to a new name.

Definition at line 1002 of file RooWorkspace.cxx.

◆ saveSnapshot() [1/2]

Bool_t RooWorkspace::saveSnapshot ( const char *  name,
const char *  paramNames 
)

Save snapshot of values and attributes (including "Constant") of given parameters.

Parameters
[in]nameName of the snapshot.
[in]paramNamesComma-separated list of parameter names to be snapshot.

Definition at line 1175 of file RooWorkspace.cxx.

◆ saveSnapshot() [2/2]

Bool_t RooWorkspace::saveSnapshot ( const char *  name,
const RooArgSet params,
Bool_t  importValues = kFALSE 
)

Save snapshot of values and attributes (including "Constant") of parameters 'params'.

If importValues is FALSE, the present values from the object in the workspace are saved. If importValues is TRUE, the values of the objects passed in the 'params' argument are saved

Definition at line 1190 of file RooWorkspace.cxx.

◆ set()

const RooArgSet * RooWorkspace::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.

Definition at line 990 of file RooWorkspace.cxx.

◆ setClassFileExportDir()

void RooWorkspace::setClassFileExportDir ( const char *  dir = 0)
static

Specify the name of the directory in which embedded source code is unpacked and compiled.

The specified string may contain one 's' token which will be substituted by the workspace name

Definition at line 114 of file RooWorkspace.cxx.

◆ startTransaction()

Bool_t RooWorkspace::startTransaction ( )

Open an import transaction operations.

Returns kTRUE if successful, kFALSE if there is already an ongoing transaction

Definition at line 1055 of file RooWorkspace.cxx.

◆ studyIterator()

TIterator * RooWorkspace::studyIterator ( )
inline

Definition at line 142 of file RooWorkspace.h.

◆ unExport()

void RooWorkspace::unExport ( )
private

Delete exported reference in CINT namespace.

Definition at line 3146 of file RooWorkspace.cxx.

◆ uuid()

const TUUID & RooWorkspace::uuid ( ) const
inline

Definition at line 154 of file RooWorkspace.h.

◆ var()

RooRealVar * RooWorkspace::var ( const char *  name) const

Retrieve real-valued variable (RooRealVar) with given name. A null pointer is returned if not found.

Definition at line 1308 of file RooWorkspace.cxx.

◆ writeToFile()

Bool_t RooWorkspace::writeToFile ( const char *  fileName,
Bool_t  recreate = kTRUE 
)

Save this current workspace into given file.

Definition at line 2168 of file RooWorkspace.cxx.

Friends And Related Function Documentation

◆ CodeRepo

friend class CodeRepo
friend

Definition at line 245 of file RooWorkspace.h.

◆ RooAbsArg

friend class RooAbsArg
friend

Definition at line 237 of file RooWorkspace.h.

◆ RooAbsPdf

friend class RooAbsPdf
friend

Definition at line 238 of file RooWorkspace.h.

Member Data Documentation

◆ _allOwnedNodes

RooArgSet RooWorkspace::_allOwnedNodes
private

Definition at line 256 of file RooWorkspace.h.

◆ _autoClass

Bool_t RooWorkspace::_autoClass = kFALSE
staticprivate

Definition at line 252 of file RooWorkspace.h.

◆ _classDeclDirList

list< string > RooWorkspace::_classDeclDirList
staticprivate

Definition at line 246 of file RooWorkspace.h.

◆ _classes

CodeRepo RooWorkspace::_classes
private

Definition at line 254 of file RooWorkspace.h.

◆ _classFileExportDir

string RooWorkspace::_classFileExportDir = ".wscode.%s.%s"
staticprivate

Definition at line 248 of file RooWorkspace.h.

◆ _classImplDirList

list< string > RooWorkspace::_classImplDirList
staticprivate

Definition at line 247 of file RooWorkspace.h.

◆ _dataList

RooLinkedList RooWorkspace::_dataList
private

Definition at line 257 of file RooWorkspace.h.

◆ _dir

WSDir* RooWorkspace::_dir
private

Definition at line 265 of file RooWorkspace.h.

◆ _doExport

Bool_t RooWorkspace::_doExport
private

Factory tool associated with workspace.

Definition at line 271 of file RooWorkspace.h.

◆ _embeddedDataList

RooLinkedList RooWorkspace::_embeddedDataList
private

Definition at line 258 of file RooWorkspace.h.

◆ _eocache

RooExpensiveObjectCache RooWorkspace::_eocache
private

Transient ROOT directory representation of workspace.

Definition at line 267 of file RooWorkspace.h.

◆ _exportNSName

std::string RooWorkspace::_exportNSName
private

Export contents of workspace to CINT?

Definition at line 272 of file RooWorkspace.h.

◆ _factory

std::unique_ptr<RooFactoryWSTool> RooWorkspace::_factory
private

Definition at line 269 of file RooWorkspace.h.

◆ _genObjects

RooLinkedList RooWorkspace::_genObjects
private

Definition at line 261 of file RooWorkspace.h.

◆ _namedSets

std::map<std::string, RooArgSet> RooWorkspace::_namedSets
private

Definition at line 263 of file RooWorkspace.h.

◆ _openTrans

Bool_t RooWorkspace::_openTrans
private

Name of CINT namespace to which contents are exported.

Definition at line 274 of file RooWorkspace.h.

◆ _sandboxNodes

RooArgSet RooWorkspace::_sandboxNodes
private

Is there a transaction open?

Definition at line 275 of file RooWorkspace.h.

◆ _snapshots

RooLinkedList RooWorkspace::_snapshots
private

Definition at line 260 of file RooWorkspace.h.

◆ _studyMods

RooLinkedList RooWorkspace::_studyMods
private

Definition at line 262 of file RooWorkspace.h.

◆ _uuid

TUUID RooWorkspace::_uuid
private

Definition at line 250 of file RooWorkspace.h.

◆ _views

RooLinkedList RooWorkspace::_views
private

Definition at line 259 of file RooWorkspace.h.

Libraries for RooWorkspace:
[legend]

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