Logo ROOT  
Reference Guide
RooWorkspace.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Project: RooFit *
3 * Package: RooFitCore *
4 * File: $Id: RooWorkspace.h,v 1.3 2007/07/16 21:04:28 wouter Exp $
5 * Authors: *
6 * WV, Wouter Verkerke, UC Santa Barbara, verkerke@slac.stanford.edu *
7 * DK, David Kirkby, UC Irvine, dkirkby@uci.edu *
8 * *
9 * Copyright (c) 2000-2005, Regents of the University of California *
10 * and Stanford University. All rights reserved. *
11 * *
12 * Redistribution and use in source and binary forms, *
13 * with or without modification, are permitted according to the terms *
14 * listed in LICENSE (http://roofit.sourceforge.net/license.txt) *
15 *****************************************************************************/
16#ifndef ROO_WORKSPACE
17#define ROO_WORKSPACE
18
19#include "RooPrintable.h"
20#include "RooArgSet.h"
21#include "RooLinkedList.h"
22#include "RooCmdArg.h"
24#include "TUUID.h"
25#include <map>
26#include <list>
27#include <memory>
28#include <string>
29
30class TClass ;
31class RooAbsPdf ;
32class RooAbsData ;
33class RooRealVar ;
34class RooCategory ;
35class RooAbsReal ;
36class RooAbsCategory ;
37class RooFactoryWSTool ;
38class RooAbsStudy ;
39
40#include "TNamed.h"
41#include "TDirectoryFile.h"
42
43class RooWorkspace : public TNamed {
44public:
45
46 RooWorkspace() ;
47 RooWorkspace(const char* name, bool doCINTExport)
48 R__SUGGEST_ALTERNATIVE("The \"doCINTExprot\" argument has no effect anymore since ROOT 6."
49 "Consider using RooWorkspace(const char* name, const char* title=nullptr).");
50 RooWorkspace(const char* name, const char* title=nullptr) ;
51 RooWorkspace(const RooWorkspace& other) ;
52 ~RooWorkspace() override ;
53
54 bool importClassCode(const char* pat="*", bool doReplace=false) ;
55 bool importClassCode(TClass* theClass, bool doReplace=false) ;
56
57 // Import functions for dataset, functions, generic objects
58 bool import(const RooAbsArg& arg,
59 const RooCmdArg& arg1=RooCmdArg(),const RooCmdArg& arg2=RooCmdArg(),const RooCmdArg& arg3=RooCmdArg(),
60 const RooCmdArg& arg4=RooCmdArg(),const RooCmdArg& arg5=RooCmdArg(),const RooCmdArg& arg6=RooCmdArg(),
61 const RooCmdArg& arg7=RooCmdArg(),const RooCmdArg& arg8=RooCmdArg(),const RooCmdArg& arg9=RooCmdArg()) ;
62 bool import(const RooArgSet& args,
63 const RooCmdArg& arg1=RooCmdArg(),const RooCmdArg& arg2=RooCmdArg(),const RooCmdArg& arg3=RooCmdArg(),
64 const RooCmdArg& arg4=RooCmdArg(),const RooCmdArg& arg5=RooCmdArg(),const RooCmdArg& arg6=RooCmdArg(),
65 const RooCmdArg& arg7=RooCmdArg(),const RooCmdArg& arg8=RooCmdArg(),const RooCmdArg& arg9=RooCmdArg()) ;
66 bool import(RooAbsData& data,
67 const RooCmdArg& arg1=RooCmdArg(),const RooCmdArg& arg2=RooCmdArg(),const RooCmdArg& arg3=RooCmdArg(),
68 const RooCmdArg& arg4=RooCmdArg(),const RooCmdArg& arg5=RooCmdArg(),const RooCmdArg& arg6=RooCmdArg(),
69 const RooCmdArg& arg7=RooCmdArg(),const RooCmdArg& arg8=RooCmdArg(),const RooCmdArg& arg9=RooCmdArg()) ;
70 bool import(const char *fileSpec,
71 const RooCmdArg& arg1=RooCmdArg(),const RooCmdArg& arg2=RooCmdArg(),const RooCmdArg& arg3=RooCmdArg(),
72 const RooCmdArg& arg4=RooCmdArg(),const RooCmdArg& arg5=RooCmdArg(),const RooCmdArg& arg6=RooCmdArg(),
73 const RooCmdArg& arg7=RooCmdArg(),const RooCmdArg& arg8=RooCmdArg(),const RooCmdArg& arg9=RooCmdArg()) ;
74 bool import(TObject& object, bool replaceExisting=false) ;
75 bool import(TObject& object, const char* aliasName, bool replaceExisting=false) ;
76
77 // Transaction management interface for multi-step import operations
78 bool startTransaction() ;
79 bool cancelTransaction() ;
80 bool commitTransaction() ;
81
82 // Named set management
83 bool defineSet(const char* name, const RooArgSet& aset, bool importMissing=false) ;
84 bool defineSet(const char* name, const char* contentList) ;
85 bool extendSet(const char* name, const char* newContents) ;
86 bool renameSet(const char* name, const char* newName) ;
87 bool removeSet(const char* name) ;
88 const RooArgSet* set(const char* name) ;
89
90 // Import, load and save parameter value snapshots
91 bool saveSnapshot(const char* name, const char* paramNames) ;
92 bool saveSnapshot(const char* name, const RooArgSet& params, bool importValues=false) ;
93 bool loadSnapshot(const char* name) ;
94 const RooArgSet* getSnapshot(const char* name) const ;
95
96 // Retrieve list of parameter snapshots
98
99 void merge(const RooWorkspace& /*other*/) {} ;
100
101 // Accessor functions
111 RooArgSet argSet(RooStringView nameList) const ;
113 R__SUGGEST_ALTERNATIVE("Better iterate over RooWorkspace::components() with range-based loop instead of using RooWorkspace::componentIterator().")
114 { return _allOwnedNodes.createIterator() ; }
115 const RooArgSet& components() const { return _allOwnedNodes ; }
117 TObject* obj(RooStringView name) const ;
118
119 // Group accessors
120 RooArgSet allVars() const;
121 RooArgSet allCats() const ;
122 RooArgSet allFunctions() const ;
123 RooArgSet allCatFunctions() const ;
124 RooArgSet allPdfs() const ;
126 std::list<RooAbsData*> allData() const ;
127 std::list<RooAbsData*> allEmbeddedData() const ;
128 std::list<TObject*> allGenericObjects() const ;
129
130 bool makeDir() ;
131 bool cd(const char* path = nullptr) ;
132
133 bool writeToFile(const char* fileName, bool recreate=true) ;
134
135 /// Make internal collection use an unordered_map for
136 /// faster searching. Important when large trees are
137 /// imported / or modified in the workspace.
138 /// Note that RooAbsCollection may eventually switch
139 /// this on by itself.
140 void useFindsWithHashLookup(bool flag) {
142 }
143
144 void RecursiveRemove(TObject *obj) override;
145
146 // Tools management
149
150 // RooStudyManager modules
151 bool addStudy(RooAbsStudy& study) ;
153 void clearStudies() ;
154
155 // Print function
156 void Print(Option_t* opts=nullptr) const override ;
157
158 static void autoImportClassCode(bool flag) ;
159
160 static void addClassDeclImportDir(const char* dir) ;
161 static void addClassImplImportDir(const char* dir) ;
162 static void setClassFileExportDir(const char* dir=nullptr) ;
163
164 const TUUID& uuid() const { return _uuid ; }
165
167
168 class CodeRepo : public TObject {
169 public:
170 CodeRepo(RooWorkspace* wspace=nullptr) : _wspace(wspace), _compiledOK(true) {} ;
171
172 CodeRepo(const CodeRepo& other, RooWorkspace* wspace=nullptr) : TObject(other) ,
173 _wspace(wspace?wspace:other._wspace),
174 _c2fmap(other._c2fmap),
175 _fmap(other._fmap),
176 _ehmap(other._ehmap),
177 _compiledOK(other._compiledOK) {} ;
178
179 ~CodeRepo() override {} ;
180
181 bool autoImportClass(TClass* tc, bool doReplace=false) ;
182 bool compileClasses() ;
183
184 bool compiledOK() const { return _compiledOK ; }
185
186 std::string listOfClassNames() const ;
187
188
189
191 public:
194 } ;
195
197 public:
198 ClassFiles() : _extracted(false) {}
203 } ;
204
205
207 public:
210 } ;
211
212 protected:
213 RooWorkspace* _wspace ; // owning workspace
214 std::map<TString,ClassRelInfo> _c2fmap ; // List of contained classes
215 std::map<TString,ClassFiles> _fmap ; // List of contained files
216 std::map<TString,ExtraHeader> _ehmap ; // List of extra header files
217 bool _compiledOK ; //! Flag indicating that classes compiled OK
218
219 ClassDefOverride(CodeRepo,2) ; // Code repository for RooWorkspace
220 } ;
221
222
223 class WSDir : public TDirectoryFile {
224 public:
225 WSDir(const char* name, const char* title, RooWorkspace* wspace) :
226 TDirectoryFile(name,title,"RooWorkspace::WSDir",nullptr),
227 _wspace(wspace)
228 {
229 }
230
231 ~WSDir() override { Clear("nodelete") ; }
232
233
234 void Add(TObject*,bool) override ;
235 void Append(TObject*,bool) override ;
236
237 protected:
238 friend class RooWorkspace ;
239 void InternalAppend(TObject* obj) ;
240 RooWorkspace* _wspace ; //! do not persist
241
242 ClassDefOverride(WSDir,1) ; // TDirectory representation of RooWorkspace
243 } ;
244
245
246 private:
247 friend class RooAbsArg;
248 friend class RooAbsPdf;
249 friend class RooConstraintSum;
250 bool defineSetInternal(const char *name, const RooArgSet &aset);
251
252 friend class CodeRepo;
253 static std::list<std::string> _classDeclDirList;
254 static std::list<std::string> _classImplDirList;
255 static std::string _classFileExportDir;
256
257 TUUID _uuid; // Unique workspace ID
258
259 static bool _autoClass; // Automatic import of non-distribution class code
260
261 CodeRepo _classes; // Repository of embedded class code. This data member _must_ be first
262
263 RooArgSet _allOwnedNodes; ///< List of owned pdfs and components
264 RooLinkedList _dataList; ///< List of owned datasets
265 RooLinkedList _embeddedDataList; ///< List of owned datasets that are embedded in pdfs
266 RooLinkedList _views; ///< List of model views
267 RooLinkedList _snapshots; ///< List of parameter snapshots
268 RooLinkedList _genObjects; ///< List of generic objects
269 RooLinkedList _studyMods; ///< List if StudyManager modules
270 std::map<std::string, RooArgSet> _namedSets; ///< Map of named RooArgSets
271
272 WSDir *_dir = nullptr; ///<! Transient ROOT directory representation of workspace
273
274 RooExpensiveObjectCache _eocache; ///< Cache for expensive objects
275
276 std::unique_ptr<RooFactoryWSTool> _factory; ///<! Factory tool associated with workspace
277
278 bool _doExport; ///<! Export contents of workspace to CINT?
279 std::string _exportNSName; ///<! Name of CINT namespace to which contents are exported
280
281 bool _openTrans = false; ///<! Is there a transaction open?
282 RooArgSet _sandboxNodes; ///<! Sandbox for incoming objects in a transaction
283
284 ClassDefOverride(RooWorkspace, 8) // Persistable project container for (composite) pdfs, functions, variables and datasets
285} ;
286
287#endif
#define R__SUGGEST_ALTERNATIVE(ALTERNATIVE)
Definition: RConfig.hxx:521
const char Option_t
Definition: RtypesCore.h:66
#define ClassDefOverride(name, id)
Definition: Rtypes.h:339
char name[80]
Definition: TGX11.cxx:110
RooAbsArg is the common abstract base class for objects that represent a value and a "shape" in RooFi...
Definition: RooAbsArg.h:71
A space to attach TBranches.
void useHashMapForFind(bool flag) const
TIterator * createIterator(bool dir=kIterForward) const
TIterator-style iteration over contained elements.
RooAbsData is the common abstract base class for binned and unbinned datasets.
Definition: RooAbsData.h:62
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:62
RooAbsStudy is an abstract base class for RooStudyManager modules.
Definition: RooAbsStudy.h:33
RooArgSet is a container object that can hold multiple RooAbsArg objects.
Definition: RooArgSet.h:56
RooCategory is an object to represent discrete states.
Definition: RooCategory.h:28
RooCmdArg is a named container for two doubles, two integers two object points and three string point...
Definition: RooCmdArg.h:26
RooConstraintSum calculates the sum of the -(log) likelihoods of a set of RooAbsPfs that represent co...
RooExpensiveObjectCache is a singleton class that serves as repository for objects that are expensive...
RooFactoryWSTool is a class similar to TTree::MakeClass() that generates skeleton code for RooAbsPdf ...
RooLinkedList is an collection class for internal use, storing a collection of RooAbsArg pointers in ...
Definition: RooLinkedList.h:38
TIterator * MakeIterator(bool forward=true) const
Create a TIterator for this list.
RooRealVar represents a variable that can be changed from the outside.
Definition: RooRealVar.h:40
The RooStringView is a wrapper around a C-syle string that can also be constructed from a std::string...
Definition: RooStringView.h:27
std::map< TString, ExtraHeader > _ehmap
Definition: RooWorkspace.h:216
CodeRepo(const CodeRepo &other, RooWorkspace *wspace=nullptr)
Definition: RooWorkspace.h:172
RooWorkspace * _wspace
Definition: RooWorkspace.h:213
std::string listOfClassNames() const
Return STL string with last of class names contained in the code repository.
bool compiledOK() const
Definition: RooWorkspace.h:184
bool autoImportClass(TClass *tc, bool doReplace=false)
Import code of class 'tc' into the repository.
bool compileClasses()
For all classes in the workspace for which no class definition is found in the ROOT class table extra...
std::map< TString, ClassRelInfo > _c2fmap
Definition: RooWorkspace.h:214
CodeRepo(RooWorkspace *wspace=nullptr)
Definition: RooWorkspace.h:170
std::map< TString, ClassFiles > _fmap
Definition: RooWorkspace.h:215
void InternalAppend(TObject *obj)
Internal access to TDirectory append method.
void Add(TObject *, bool) override
Overload TDirectory interface method to prohibit insertion of objects in read-only directory workspac...
WSDir(const char *name, const char *title, RooWorkspace *wspace)
Definition: RooWorkspace.h:225
RooWorkspace * _wspace
Definition: RooWorkspace.h:240
void Append(TObject *, bool) override
Overload TDirectory interface method to prohibit insertion of objects in read-only directory workspac...
The RooWorkspace is a persistable container for RooFit projects.
Definition: RooWorkspace.h:43
RooExpensiveObjectCache _eocache
Cache for expensive objects.
Definition: RooWorkspace.h:274
TObject * obj(RooStringView name) const
Return any type of object (RooAbsArg, RooAbsData or generic object) with given name)
RooLinkedList _genObjects
List of generic objects.
Definition: RooWorkspace.h:268
static bool _autoClass
Definition: RooWorkspace.h:259
std::string _exportNSName
! Name of CINT namespace to which contents are exported
Definition: RooWorkspace.h:279
static std::list< std::string > _classDeclDirList
Definition: RooWorkspace.h:253
const RooArgSet * getSnapshot(const char *name) const
Return the RooArgSet containing a snapshot of variables contained in the workspace.
static void addClassDeclImportDir(const char *dir)
Add dir to search path for class declaration (header) files.
void Print(Option_t *opts=nullptr) const override
Print contents of the workspace.
RooLinkedList _dataList
List of owned datasets.
Definition: RooWorkspace.h:264
RooAbsCategory * catfunc(RooStringView name) const
Retrieve discrete function (RooAbsCategory) with given name. A null pointer is returned if not found.
WSDir * _dir
! Transient ROOT directory representation of workspace
Definition: RooWorkspace.h:272
static void addClassImplImportDir(const char *dir)
Add dir to search path for class implementation (.cxx) files.
RooAbsPdf * pdf(RooStringView name) const
Retrieve p.d.f (RooAbsPdf) with given name. A null pointer is returned if not found.
std::map< std::string, RooArgSet > _namedSets
Map of named RooArgSets.
Definition: RooWorkspace.h:270
RooAbsData * embeddedData(RooStringView name) const
Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found.
RooCategory * cat(RooStringView name) const
Retrieve discrete variable (RooCategory) with given name. A null pointer is returned if not found.
void clearStudies()
Remove all RooStudyManager modules.
bool renameSet(const char *name, const char *newName)
Rename set to a new name.
void useFindsWithHashLookup(bool flag)
Make internal collection use an unordered_map for faster searching.
Definition: RooWorkspace.h:140
std::unique_ptr< RooFactoryWSTool > _factory
! Factory tool associated with workspace
Definition: RooWorkspace.h:276
RooArgSet allVars() const
Return set with all variable objects.
RooArgSet argSet(RooStringView nameList) const
Return set of RooAbsArgs matching to given list of names.
bool writeToFile(const char *fileName, bool recreate=true)
Save this current workspace into given file.
bool saveSnapshot(const char *name, const char *paramNames)
Save snapshot of values and attributes (including "Constant") of given parameters.
bool cd(const char *path=nullptr)
RooArgSet allCats() const
Return set with all category objects.
void RecursiveRemove(TObject *obj) override
If one of the TObject we have a referenced to is deleted, remove the reference.
RooAbsArg * fundArg(RooStringView name) const
Return fundamental (i.e.
bool _doExport
! Export contents of workspace to CINT?
Definition: RooWorkspace.h:278
RooLinkedList _views
List of model views.
Definition: RooWorkspace.h:266
bool commitTransaction()
~RooWorkspace() override
Workspace destructor.
TIterator * studyIterator()
Definition: RooWorkspace.h:152
bool cancelTransaction()
Cancel an ongoing import transaction.
bool startTransaction()
Open an import transaction operations.
RooArgSet allResolutionModels() const
Return set with all resolution model objects.
RooLinkedList _snapshots
List of parameter snapshots.
Definition: RooWorkspace.h:267
void merge(const RooWorkspace &)
Definition: RooWorkspace.h:99
RooArgSet allPdfs() const
Return set with all probability density function objects.
TObject * genobj(RooStringView name) const
Return generic object with given name.
std::list< RooAbsData * > allData() const
Return list of all dataset in the workspace.
RooLinkedList _studyMods
List if StudyManager modules.
Definition: RooWorkspace.h:269
std::list< TObject * > allGenericObjects() const
Return list of all generic objects in the workspace.
static void setClassFileExportDir(const char *dir=nullptr)
Specify the name of the directory in which embedded source code is unpacked and compiled.
RooLinkedList getSnapshots()
Definition: RooWorkspace.h:97
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 whi...
bool makeDir()
Create transient TDirectory representation of this workspace.
RooArgSet allCatFunctions() const
Return set with all category function objects.
static std::string _classFileExportDir
Definition: RooWorkspace.h:255
static std::list< std::string > _classImplDirList
Definition: RooWorkspace.h:254
RooAbsReal * function(RooStringView name) const
Retrieve function (RooAbsReal) with given name. Note that all RooAbsPdfs are also RooAbsReals....
RooAbsArg * arg(RooStringView name) const
Return RooAbsArg with given name. A null pointer is returned if none is found.
RooWorkspace()
Default constructor.
bool removeSet(const char *name)
Remove a named set from the workspace.
CodeRepo _classes
Definition: RooWorkspace.h:261
const RooArgSet & components() const
Definition: RooWorkspace.h:115
RooArgSet allFunctions() const
Return set with all function objects.
RooFactoryWSTool & factory()
Return instance to factory tool.
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 th...
RooExpensiveObjectCache & expensiveObjectCache()
Definition: RooWorkspace.h:166
RooArgSet _sandboxNodes
! Sandbox for incoming objects in a transaction
Definition: RooWorkspace.h:282
bool defineSetInternal(const char *name, const RooArgSet &aset)
bool _openTrans
! Is there a transaction open?
Definition: RooWorkspace.h:281
const TUUID & uuid() const
Definition: RooWorkspace.h:164
RooRealVar * var(RooStringView name) const
Retrieve real-valued variable (RooRealVar) with given name. A null pointer is returned if not found.
bool addStudy(RooAbsStudy &study)
Insert RooStudyManager module.
static void autoImportClassCode(bool flag)
If flag is true, source code of classes not the ROOT distribution is automatically imported if on obj...
RooLinkedList _embeddedDataList
List of owned datasets that are embedded in pdfs.
Definition: RooWorkspace.h:265
RooArgSet _allOwnedNodes
List of owned pdfs and components.
Definition: RooWorkspace.h:263
RooAbsData * data(RooStringView name) const
Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found.
const RooArgSet * set(const char *name)
Return pointer to previously defined named set with given nmame If no such set is found a null pointe...
std::list< RooAbsData * > allEmbeddedData() const
Return list of all dataset in the workspace.
TIterator * componentIterator() const
Definition: RooWorkspace.h:112
bool loadSnapshot(const char *name)
Load the values and attributes of the parameters in the snapshot saved with the given name.
bool defineSet(const char *name, const RooArgSet &aset, bool importMissing=false)
Define a named RooArgSet with given constituents.
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition: TClass.h:81
A ROOT file is structured in Directories (like a file system).
void Clear(Option_t *option="") override
Delete all objects from a Directory list.
Definition: TDirectory.cxx:581
Iterator abstract base class.
Definition: TIterator.h:30
The TNamed class is the base class for all named ROOT classes.
Definition: TNamed.h:29
Mother of all ROOT objects.
Definition: TObject.h:41
Basic string class.
Definition: TString.h:136
This class defines a UUID (Universally Unique IDentifier), also known as GUIDs (Globally Unique IDent...
Definition: TUUID.h:42
int iterate(rng_state_t *X)
Definition: mixmax.icc:34