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_t doCINTExport) ;
48 RooWorkspace(const char* name, const char* title=0) ;
49 RooWorkspace(const RooWorkspace& other) ;
51
52 void exportToCint(const char* namespaceName=0) ;
53
54 Bool_t importClassCode(const char* pat="*", Bool_t doReplace=kFALSE) ;
55 Bool_t importClassCode(TClass* theClass, Bool_t doReplace=kFALSE) ;
56
57 // Import functions for dataset, functions, generic objects
58 Bool_t 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_t 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_t 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_t 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_t import(TObject& object, Bool_t replaceExisting=kFALSE) ;
75 Bool_t import(TObject& object, const char* aliasName, Bool_t replaceExisting=kFALSE) ;
76
77 // Transaction management interface for multi-step import operations
81
82 // Named set management
83 Bool_t defineSet(const char* name, const RooArgSet& aset, Bool_t importMissing=kFALSE) ;
84 Bool_t defineSet(const char* name, const char* contentList) ;
85 Bool_t extendSet(const char* name, const char* newContents) ;
86 Bool_t renameSet(const char* name, const char* newName) ;
87 Bool_t removeSet(const char* name) ;
88 const RooArgSet* set(const char* name) ;
89
90 // Import, load and save parameter value snapshots
91 Bool_t saveSnapshot(const char* name, const char* paramNames) ;
92 Bool_t saveSnapshot(const char* name, const RooArgSet& params, Bool_t importValues=kFALSE) ;
93 Bool_t 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 // Join p.d.f.s and datasets for simultaneous analysis
102 // RooAbsPdf* joinPdf(const char* jointPdfName, const char* indexName, const char* inputMapping) ;
103 // RooAbsData* joinData(const char* jointDataName, const char* indexName, const char* inputMapping) ;
104
105 // Accessor functions
106 RooAbsPdf* pdf(const char* name) const ;
107 RooAbsReal* function(const char* name) const ;
108 RooRealVar* var(const char* name) const ;
109 RooCategory* cat(const char* name) const ;
110 RooAbsCategory* catfunc(const char* name) const ;
111 RooAbsData* data(const char* name) const ;
112 RooAbsData* embeddedData(const char* name) const ;
113 RooAbsArg* arg(const char* name) const ;
114 RooAbsArg* fundArg(const char* name) const ;
115 RooArgSet argSet(const char* nameList) const ;
117 const RooArgSet& components() const { return _allOwnedNodes ; }
118 TObject* genobj(const char* name) const ;
119 TObject* obj(const char* name) const ;
120
121 // Group accessors
122 RooArgSet allVars() const;
123 RooArgSet allCats() const ;
124 RooArgSet allFunctions() const ;
125 RooArgSet allCatFunctions() const ;
126 RooArgSet allPdfs() const ;
128 std::list<RooAbsData*> allData() const ;
129 std::list<RooAbsData*> allEmbeddedData() const ;
130 std::list<TObject*> allGenericObjects() const ;
131
132 Bool_t makeDir() ;
133 Bool_t cd(const char* path = 0) ;
134
135 Bool_t writeToFile(const char* fileName, Bool_t recreate=kTRUE) ;
136
137 /// Make internal collection use an unordered_map for
138 /// faster searching. Important when large trees are
139 /// imported / or modified in the workspace.
140 /// Note that RooAbsCollection may eventually switch
141 /// this on by itself.
142 void useFindsWithHashLookup(bool flag) {
144 }
145
146 virtual void RecursiveRemove(TObject *obj);
147
148 // Tools management
150 RooAbsArg* factory(const char* expr) ;
151
152 // RooStudyManager modules
153 Bool_t addStudy(RooAbsStudy& study) ;
155 void clearStudies() ;
156
157 // Print function
158 void Print(Option_t* opts=0) const ;
159
160 static void autoImportClassCode(Bool_t flag) ;
161
162 static void addClassDeclImportDir(const char* dir) ;
163 static void addClassImplImportDir(const char* dir) ;
164 static void setClassFileExportDir(const char* dir=0) ;
165
166 const TUUID& uuid() const { return _uuid ; }
167
169
170 class CodeRepo : public TObject {
171 public:
172 CodeRepo(RooWorkspace* wspace=0) : _wspace(wspace), _compiledOK(kTRUE) {} ;
173
174 CodeRepo(const CodeRepo& other, RooWorkspace* wspace=0) : TObject(other) ,
175 _wspace(wspace?wspace:other._wspace),
176 _c2fmap(other._c2fmap),
177 _fmap(other._fmap),
178 _ehmap(other._ehmap),
179 _compiledOK(other._compiledOK) {} ;
180
181 virtual ~CodeRepo() {} ;
182
183 Bool_t autoImportClass(TClass* tc, Bool_t doReplace=kFALSE) ;
185
186 Bool_t compiledOK() const { return _compiledOK ; }
187
188 std::string listOfClassNames() const ;
189
190
191
193 public:
196 } ;
197
199 public:
205 } ;
206
207
208 class ExtraHeader {
209 public:
212 } ;
213
214 protected:
215 RooWorkspace* _wspace ; // owning workspace
216 std::map<TString,ClassRelInfo> _c2fmap ; // List of contained classes
217 std::map<TString,ClassFiles> _fmap ; // List of contained files
218 std::map<TString,ExtraHeader> _ehmap ; // List of extra header files
219 Bool_t _compiledOK ; //! Flag indicating that classes compiled OK
220
221 ClassDef(CodeRepo,2) ; // Code repository for RooWorkspace
222 } ;
223
224
225 class WSDir : public TDirectoryFile {
226 public:
227 WSDir(const char* name, const char* title, RooWorkspace* wspace) :
228 TDirectoryFile(name,title,"RooWorkspace::WSDir",0),
229 _wspace(wspace)
230 {
231 }
232
233 virtual ~WSDir() { Clear("nodelete") ; } ;
234
235
236 virtual void Add(TObject*,Bool_t) ;
237 virtual void Append(TObject*,Bool_t) ;
238
239 protected:
240 friend class RooWorkspace ;
241 void InternalAppend(TObject* obj) ;
242 RooWorkspace* _wspace ; //! do not persist
243
244 ClassDef(WSDir,1) ; // TDirectory representation of RooWorkspace
245 } ;
246
247
248 private:
249 friend class RooAbsArg;
250 friend class RooAbsPdf;
251 friend class RooConstraintSum;
252 Bool_t defineSetInternal(const char *name, const RooArgSet &aset);
253
254 Bool_t isValidCPPID(const char *name);
255 void exportObj(TObject *obj);
256 void unExport();
257
258 friend class CodeRepo;
259 static std::list<std::string> _classDeclDirList;
260 static std::list<std::string> _classImplDirList;
261 static std::string _classFileExportDir;
262
263 TUUID _uuid; // Unique workspace ID
264
265 static Bool_t _autoClass; // Automatic import of non-distribution class code
266
267 CodeRepo _classes; // Repository of embedded class code. This data member _must_ be first
268
269 RooArgSet _allOwnedNodes; // List of owned pdfs and components
270 RooLinkedList _dataList; // List of owned datasets
271 RooLinkedList _embeddedDataList; // List of owned datasets that are embedded in pdfs
272 RooLinkedList _views; // List of model views
273 RooLinkedList _snapshots; // List of parameter snapshots
274 RooLinkedList _genObjects; // List of generic objects
275 RooLinkedList _studyMods; // List if StudyManager modules
276 std::map<std::string, RooArgSet> _namedSets; // Map of named RooArgSets
277
278 WSDir *_dir; //! Transient ROOT directory representation of workspace
279
280 RooExpensiveObjectCache _eocache; // Cache for expensive objects
281
282 std::unique_ptr<RooFactoryWSTool> _factory; //! Factory tool associated with workspace
283
284 Bool_t _doExport; //! Export contents of workspace to CINT?
285 std::string _exportNSName; //! Name of CINT namespace to which contents are exported
286
287 Bool_t _openTrans; //! Is there a transaction open?
288 RooArgSet _sandboxNodes; //! Sandbox for incoming objects in a transaction
289
290 ClassDef(RooWorkspace, 8) // Persistable project container for (composite) pdfs, functions, variables and datasets
291} ;
292
293#endif
const Bool_t kFALSE
Definition: RtypesCore.h:101
bool Bool_t
Definition: RtypesCore.h:63
const Bool_t kTRUE
Definition: RtypesCore.h:100
const char Option_t
Definition: RtypesCore.h:66
#define ClassDef(name, id)
Definition: Rtypes.h:325
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:72
RooAbsCategory is the base class for objects that represent a discrete value with a finite number of ...
void useHashMapForFind(bool flag) const
Install an internal hash map for fast finding of elements by name.
TIterator * createIterator(Bool_t dir=kIterForward) const
TIterator-style iteration over contained elements.
RooAbsData is the common abstract base class for binned and unbinned datasets.
Definition: RooAbsData.h:79
RooAbsReal is the common abstract base class for objects that represent a real value and implements f...
Definition: RooAbsReal.h:61
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:35
RooCategory is an object to represent discrete states.
Definition: RooCategory.h:27
RooCmdArg is a named container for two doubles, two integers two object points and three string point...
Definition: RooCmdArg.h:27
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_t forward=kTRUE) const
Create a TIterator for this list.
RooRealVar represents a variable that can be changed from the outside.
Definition: RooRealVar.h:39
Bool_t autoImportClass(TClass *tc, Bool_t doReplace=kFALSE)
Import code of class 'tc' into the repository.
std::map< TString, ExtraHeader > _ehmap
Definition: RooWorkspace.h:218
CodeRepo(RooWorkspace *wspace=0)
Definition: RooWorkspace.h:172
RooWorkspace * _wspace
Definition: RooWorkspace.h:215
std::string listOfClassNames() const
Return STL string with last of class names contained in the code repository.
Bool_t compiledOK() const
Definition: RooWorkspace.h:186
std::map< TString, ClassRelInfo > _c2fmap
Definition: RooWorkspace.h:216
Bool_t compileClasses()
For all classes in the workspace for which no class definition is found in the ROOT class table extra...
CodeRepo(const CodeRepo &other, RooWorkspace *wspace=0)
Definition: RooWorkspace.h:174
std::map< TString, ClassFiles > _fmap
Definition: RooWorkspace.h:217
virtual void Append(TObject *, Bool_t)
Overload TDirectory interface method to prohibit insertion of objects in read-only directory workspac...
void InternalAppend(TObject *obj)
Internal access to TDirectory append method.
virtual void Add(TObject *, Bool_t)
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:227
RooWorkspace * _wspace
Definition: RooWorkspace.h:242
The RooWorkspace is a persistable container for RooFit projects.
Definition: RooWorkspace.h:43
Bool_t makeDir()
Create transient TDirectory representation of this workspace.
RooExpensiveObjectCache _eocache
Transient ROOT directory representation of workspace.
Definition: RooWorkspace.h:280
RooLinkedList _genObjects
Definition: RooWorkspace.h:274
void exportToCint(const char *namespaceName=0)
Activate export of workspace symbols to CINT in a namespace with given name.
std::string _exportNSName
Export contents of workspace to CINT?
Definition: RooWorkspace.h:285
static std::list< std::string > _classDeclDirList
Definition: RooWorkspace.h:259
const RooArgSet * getSnapshot(const char *name) const
Return the RooArgSet containing a snapshot of variables contained in the workspace.
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 th...
static void addClassDeclImportDir(const char *dir)
Add dir to search path for class declaration (header) files.
Bool_t defineSetInternal(const char *name, const RooArgSet &aset)
void unExport()
Delete exported reference in CINT namespace.
RooLinkedList _dataList
Definition: RooWorkspace.h:270
RooAbsData * data(const char *name) const
Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found.
RooAbsData * embeddedData(const char *name) const
Retrieve dataset (binned or unbinned) with given name. A null pointer is returned if not found.
WSDir * _dir
Definition: RooWorkspace.h:278
static void addClassImplImportDir(const char *dir)
Add dir to search path for class implementation (.cxx) files.
TObject * genobj(const char *name) const
Return generic object with given name.
std::map< std::string, RooArgSet > _namedSets
Definition: RooWorkspace.h:276
Bool_t _openTrans
Name of CINT namespace to which contents are exported.
Definition: RooWorkspace.h:287
std::list< RooAbsData * > allData() const
Return list of all dataset in the workspace.
void clearStudies()
Remove all RooStudyManager modules.
void useFindsWithHashLookup(bool flag)
Make internal collection use an unordered_map for faster searching.
Definition: RooWorkspace.h:142
RooAbsArg * fundArg(const char *name) const
Return fundamental (i.e.
RooArgSet argSet(const char *nameList) const
Return set of RooAbsArgs matching to given list of names.
std::unique_ptr< RooFactoryWSTool > _factory
Definition: RooWorkspace.h:282
RooArgSet allVars() const
Return set with all variable objects.
virtual void RecursiveRemove(TObject *obj)
If one of the TObject we have a referenced to is deleted, remove the reference.
RooArgSet allCats() const
Return set with all category objects.
Bool_t commitTransaction()
RooLinkedList _views
Definition: RooWorkspace.h:272
Bool_t startTransaction()
Open an import transaction operations.
RooAbsReal * function(const char *name) const
Retrieve function (RooAbsReal) with given name. Note that all RooAbsPdfs are also RooAbsReals....
TIterator * studyIterator()
Definition: RooWorkspace.h:154
RooArgSet allResolutionModels() const
Return set with all resolution model objects.
RooLinkedList _snapshots
Definition: RooWorkspace.h:273
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 whi...
void merge(const RooWorkspace &)
Definition: RooWorkspace.h:99
RooCategory * cat(const char *name) const
Retrieve discrete variable (RooCategory) with given name. A null pointer is returned if not found.
Bool_t renameSet(const char *name, const char *newName)
Rename set to a new name.
RooAbsArg * arg(const char *name) const
Return RooAbsArg with given name. A null pointer is returned if none is found.
std::list< RooAbsData * > allEmbeddedData() const
Return list of all dataset in the workspace.
void Print(Option_t *opts=0) const
Print contents of the workspace.
RooArgSet allPdfs() const
Return set with all probability density function objects.
Bool_t addStudy(RooAbsStudy &study)
Insert RooStudyManager module.
Bool_t writeToFile(const char *fileName, Bool_t recreate=kTRUE)
Save this current workspace into given file.
std::list< TObject * > allGenericObjects() const
Return list of all generic objects in the workspace.
static void setClassFileExportDir(const char *dir=0)
Specify the name of the directory in which embedded source code is unpacked and compiled.
Bool_t _doExport
Factory tool associated with workspace.
Definition: RooWorkspace.h:284
Bool_t removeSet(const char *name)
Remove a named set from the workspace.
static void autoImportClassCode(Bool_t flag)
If flag is true, source code of classes not the the ROOT distribution is automatically imported if on...
RooAbsCategory * catfunc(const char *name) const
Retrieve discrete function (RooAbsCategory) with given name. A null pointer is returned if not found.
RooLinkedList _studyMods
Definition: RooWorkspace.h:275
RooLinkedList getSnapshots()
Definition: RooWorkspace.h:97
RooArgSet allCatFunctions() const
Return set with all category function objects.
static std::string _classFileExportDir
Definition: RooWorkspace.h:261
static std::list< std::string > _classImplDirList
Definition: RooWorkspace.h:260
~RooWorkspace()
Workspace destructor.
Bool_t defineSet(const char *name, const RooArgSet &aset, Bool_t importMissing=kFALSE)
Define a named RooArgSet with given constituents.
RooWorkspace()
Default constructor.
Bool_t cd(const char *path=0)
Bool_t saveSnapshot(const char *name, const char *paramNames)
Save snapshot of values and attributes (including "Constant") of given parameters.
Bool_t loadSnapshot(const char *name)
Load the values and attributes of the parameters in the snapshot saved with the given name.
CodeRepo _classes
Definition: RooWorkspace.h:267
RooRealVar * var(const char *name) const
Retrieve real-valued variable (RooRealVar) with given name. A null pointer is returned if not found.
const RooArgSet & components() const
Definition: RooWorkspace.h:117
RooArgSet allFunctions() const
Return set with all function objects.
RooFactoryWSTool & factory()
Return instance to factory tool.
RooExpensiveObjectCache & expensiveObjectCache()
Definition: RooWorkspace.h:168
Bool_t isValidCPPID(const char *name)
Return true if given name is a valid C++ identifier name.
RooArgSet _sandboxNodes
Is there a transaction open?
Definition: RooWorkspace.h:288
Bool_t cancelTransaction()
Cancel an ongoing import transaction.
void exportObj(TObject *obj)
Export reference to given workspace object to CINT.
const TUUID & uuid() const
Definition: RooWorkspace.h:166
static Bool_t _autoClass
Definition: RooWorkspace.h:265
RooLinkedList _embeddedDataList
Definition: RooWorkspace.h:271
RooArgSet _allOwnedNodes
Definition: RooWorkspace.h:269
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...
TObject * obj(const char *name) const
Return any type of object (RooAbsArg, RooAbsData or generic object) with given name)
TIterator * componentIterator() const
Definition: RooWorkspace.h:116
RooAbsPdf * pdf(const char *name) const
Retrieve p.d.f (RooAbsPdf) with given name. A null pointer is returned if not found.
TClass instances represent classes, structs and namespaces in the ROOT type system.
Definition: TClass.h:80
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:37
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