1 #ifndef ALIANALYSISMANAGER_H
2 #define ALIANALYSISMANAGER_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
4 * See cxx source for full Copyright notice */
7 // Author: Andrei Gheata, 31/05/2006
9 //==============================================================================
10 // AliAnalysysManager - Manager analysis class. Allows creation of several
11 // analysis tasks and data containers storing their input/output. Allows
12 // connecting/chaining tasks via shared data containers. Serializes the current
13 // event for all tasks depending only on initial input data.
14 //==============================================================================
19 #ifndef ROOT_THashTable
20 #include <THashTable.h>
22 #ifndef ROOT_Riostream
23 #include <Riostream.h>
31 class AliAnalysisSelector;
32 class AliAnalysisDataContainer;
33 class AliAnalysisFileDescriptor;
34 class AliAnalysisTask;
35 class AliVEventHandler;
37 class AliAnalysisGrid;
38 class AliAnalysisStatistics;
42 class AliAnalysisManager : public TNamed {
46 enum EAliAnalysisContType {
47 kExchangeContainer = 0, // use to exchange data between tasks
48 kInputContainer = 1, // use for the task private input data
49 kOutputContainer = 2, // use for the task private output data
50 kParamContainer = 3 // use for storing task private parameters/cuts per analysis session
53 enum EAliAnalysisExecMode {
60 enum EAliAnalysisFlags {
62 kDisableBranches = BIT(15),
63 kUseDataSet = BIT(16),
64 kSaveCanvases = BIT(17),
65 kExternalLoop = BIT(18),
66 kSkipTerminate = BIT(19),
67 kUseProgressBar = BIT(20),
68 kTrueNotify = BIT(21),
69 kTasksInitialized = BIT(22),
70 kCollectThroughput= BIT(23)
73 AliAnalysisManager(const char *name = "mgr", const char *title="");
74 virtual ~AliAnalysisManager();
76 AliAnalysisManager(const AliAnalysisManager& other);
77 AliAnalysisManager& operator=(const AliAnalysisManager& other);
80 Bool_t EventLoop(Long64_t nevents);
81 virtual Int_t GetEntry(Long64_t entry, Int_t getall = 0);
82 virtual Bool_t Init(TTree *tree);
83 virtual Bool_t Notify();
84 virtual Bool_t ProcessCut(Long64_t entry) {return Process(entry);}
85 virtual Bool_t Process(Long64_t entry);
86 TFile *OpenProofFile(AliAnalysisDataContainer *cont, const char *option, const char *extaod="");
87 static TFile *OpenFile(AliAnalysisDataContainer *cont, const char *option, Bool_t ignoreProof=kFALSE);
88 void PackOutput(TList *target);
89 void RegisterExtraFile(const char *fname);
90 Long64_t StartAnalysis(const char *type, TTree * const tree, Long64_t nentries=1234567890, Long64_t firstentry=0);
91 Long64_t StartAnalysis(const char *type, const char *dataset, Long64_t nentries=1234567890, Long64_t firstentry=0);
92 Long64_t StartAnalysis(const char *type, Long64_t nentries=1234567890, Long64_t firstentry=0);
93 virtual void SlaveBegin(TTree *tree);
94 virtual void Terminate();
95 void UnpackOutput(TList *source);
98 static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
99 static Int_t LoadMacro(const char *filename, Int_t *error = 0, Bool_t check = kFALSE);
101 GetAnalysisType() const {return fMode;}
102 void GetAnalysisTypeString(TString &type) const;
103 Bool_t GetAutoBranchLoading() const {return fAutoBranchHandling;}
104 Long64_t GetCacheSize() const {return fCacheSize;}
105 static const char *GetCommonFileName() {return fgCommonFileName.Data();}
106 AliAnalysisDataContainer *
107 GetCommonInputContainer() const {return fCommonInput;}
108 AliAnalysisDataContainer *
109 GetCommonOutputContainer() const {return fCommonOutput;}
110 TObjArray *GetContainers() const {return fContainers;}
111 Long64_t GetCurrentEntry() const {return fCurrentEntry;}
112 UInt_t GetDebugLevel() const {return fDebug;}
113 Bool_t GetAsyncReading() const {return fAsyncReading;}
114 TString GetExtraFiles() const {return fExtraFiles;}
115 AliVEventPool* GetEventPool() const {return fEventPool;}
116 Bool_t GetFileFromWrapper(const char *filename, const TList *source);
117 const char *GetFileInfoLog() const {return fFileInfoLog.Data();}
118 static Int_t GetRunFromAlienPath(const char *path);
119 AliAnalysisGrid* GetGridHandler() {return fGridHandler;}
120 TObjArray *GetInputs() const {return fInputs;}
121 AliVEventHandler* GetInputEventHandler() const {return fInputEventHandler;}
122 AliVEventHandler* GetMCtruthEventHandler() const {return fMCtruthEventHandler;}
123 Int_t GetNsysInfo() const {return fNSysInfo;}
124 AliVEventHandler* GetOutputEventHandler() const {return fOutputEventHandler;}
125 TObjArray *GetOutputs() const {return fOutputs;}
126 TObjArray *GetParamOutputs() const {return fParamCont;}
127 TObjArray *GetExchangeContainers() const {return fExchangeCont;}
128 Int_t GetRunFromPath() const {return fRunFromPath;}
129 const char *GetRequestedBranches() const {return fRequestedBranches.Data();}
130 TObjArray *GetTasks() const {return fTasks;}
131 TObjArray *GetTopTasks() const {return fTopTasks;}
132 TTree *GetTree() const {return fTree;}
133 TObjArray *GetZombieTasks() const {return fZombies;}
134 static const char *GetGlobalStr(const char *key, Bool_t &valid);
135 static Int_t GetGlobalInt(const char *key, Bool_t &valid);
136 static Double_t GetGlobalDbl(const char *key, Bool_t &valid);
137 TMap *GetGlobals() {return fGlobals;}
138 static Bool_t IsMacroLoaded(const char * filename);
139 Bool_t IsMCLoop() const {return fMCLoop;}
140 static Bool_t IsPipe(std::ostream &out);
141 Bool_t IsProofMode() const {return (fMode==kProofAnalysis)?kTRUE:kFALSE;}
142 Bool_t IsRemote() const {return fIsRemote;}
143 Bool_t IsCollectThroughput() {return TObject::TestBit(kCollectThroughput);}
144 Bool_t IsUsingDataSet() const {return TObject::TestBit(kUseDataSet);}
145 void LoadBranch(const char *n) { if(fAutoBranchHandling) return; DoLoadBranch(n); }
147 void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
148 void SetAutoBranchLoading(Bool_t b) { fAutoBranchHandling = b; }
149 void SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
150 void SetCacheSize(Long64_t size) {fCacheSize = size;}
151 void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;}
152 void SetCollectThroughput(Bool_t flag) {Changed(); TObject::SetBit(kCollectThroughput,flag);}
153 static void SetCommonFileName(const char *name) {fgCommonFileName = name;}
154 void SetDebugLevel(UInt_t level);
155 void SetDisableBranches(Bool_t disable=kTRUE) {Changed(); TObject::SetBit(kDisableBranches,disable);}
156 void SetAsyncReading(Bool_t flag=kTRUE) {fAsyncReading = flag;}
157 void SetExternalLoop(Bool_t flag) {Changed(); TObject::SetBit(kExternalLoop,flag);}
158 void SetMCLoop(Bool_t flag=kTRUE) {fMCLoop = flag;}
159 void SetEventPool(AliVEventPool* const epool) {Changed(); fEventPool = epool;}
160 void SetFileInfoLog(const char *name) {TObject::SetBit(kCollectThroughput,kTRUE); fFileInfoLog = name;}
161 void SetGridHandler(AliAnalysisGrid * const handler) {Changed(); fGridHandler = handler;}
162 void SetInputEventHandler(AliVEventHandler* const handler);
163 void SetMCtruthEventHandler(AliVEventHandler* const handler) {Changed(); fMCtruthEventHandler = handler;}
164 void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
165 void SetOutputEventHandler(AliVEventHandler* const handler);
166 void SetRunFromPath(Int_t run) {fRunFromPath = run;}
167 void SetSelector(AliAnalysisSelector * const sel) {fSelector = sel;}
168 void SetSaveCanvases(Bool_t flag=kTRUE) {TObject::SetBit(kSaveCanvases,flag);}
169 void SetSkipTerminate(Bool_t flag) {TObject::SetBit(kSkipTerminate,flag);}
170 void SetUseProgressBar(Bool_t flag, Int_t freq=1);
171 void SetSpecialOutputLocation(const char *loc) {fSpecialOutputLocation = loc;}
172 static void SetGlobalStr(const char *key, const char *value);
173 static void SetGlobalInt(const char *key, Int_t value);
174 static void SetGlobalDbl(const char *key, Double_t value);
177 // Container handling
178 AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype,
179 EAliAnalysisContType type = kExchangeContainer,
180 const char *filename = NULL);
182 // Including tasks and getting them
183 void AddTask(AliAnalysisTask *task);
184 AliAnalysisTask *GetTask(const char *name) const;
185 Int_t GetTaskIndex(const AliAnalysisTask *task) const;
187 // Connecting data containers to task inputs/outputs
188 Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot,
189 AliAnalysisDataContainer *cont);
190 Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot,
191 AliAnalysisDataContainer *cont);
192 // Garbage collection
193 void CleanContainers();
195 // Analysis initialization and execution, status
196 void AddBranches(const char *branches);
197 void AddStatisticsTask(UInt_t offlineMask=0);
198 void CheckBranches(Bool_t load=kFALSE);
199 Bool_t CheckTasks() const;
200 void CountEvent(Int_t ninput, Int_t nprocessed, Int_t nfailed, Int_t naccepted);
201 Bool_t InitAnalysis();
202 Bool_t IsInitialized() const {return fInitOK;}
203 Bool_t IsTrainInitialized() const {return TObject::TestBit(kTasksInitialized);}
204 Bool_t IsExternalLoop() const {return TObject::TestBit(kExternalLoop);}
205 Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);}
206 Bool_t IsSkipTerminate() const {return TObject::TestBit(kSkipTerminate);}
207 Bool_t MustClean() const {return fMustClean;}
208 void SetMustClean(Bool_t flag=kTRUE) {fMustClean = flag;}
209 void ResetAnalysis();
210 void ExecAnalysis(Option_t *option="");
211 void PrintStatus(Option_t *option="all") const;
212 void ProfileTask(const char *name, const char *option="VM") const;
213 void ProfileTask(Int_t itop, const char *option="VM") const;
214 static void ProgressBar(const char *opname, Long64_t current, Long64_t size, TStopwatch * const watch=0, Bool_t last=kFALSE, Bool_t refresh=kFALSE);
215 void AddStatisticsMsg(const char *line);
216 const char *GetStatisticsMsg() const {return fStatisticsMsg.Data();}
217 const AliAnalysisStatistics *GetStatistics() const {return fStatistics;}
218 void SetStatistics(AliAnalysisStatistics *stat) {fStatistics = stat;}
219 void WriteStatisticsMsg(Int_t nevents);
220 Int_t GetNcalls() const {return fNcalls;}
221 Bool_t ValidateOutputFiles() const;
223 static const char* GetOADBPath();
225 void ApplyDebugOptions();
226 void AddClassDebug(const char *className, Int_t debugLevel);
229 Bool_t IsLocked() const {return fLocked;}
233 void InitInputData(AliVEvent* esdEvent, AliESDfriend* esdFriend);
235 void CreateReadCache();
236 void ImportWrappers(TList *source);
237 void InputFileFromTree(TTree * const tree, TString &fname);
238 void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
239 void DoLoadBranch(const char *name);
242 TTree *fTree; //! Input tree in case of TSelector model
243 AliVEventHandler *fInputEventHandler; // Optional common input event handler
244 AliVEventHandler *fOutputEventHandler; // Optional common output event handler
245 AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler
246 AliVEventPool *fEventPool; // Event pool for mixing analysis
247 Long64_t fCurrentEntry; //! Current processed entry in the tree
248 Long64_t fNSysInfo; // Event frequency for collecting system information
249 EAliAnalysisExecMode fMode; // Execution mode
250 Bool_t fInitOK; // Initialisation done
251 Bool_t fMustClean; // Flag to let ROOT do cleanup
252 Bool_t fIsRemote; //! Flag is set for remote analysis
253 Bool_t fLocked; //! Lock for the manager and handlers
254 Bool_t fMCLoop; // External MC generator loop
255 UInt_t fDebug; // Debug level
256 TString fSpecialOutputLocation; // URL/path where the special outputs will be copied
257 TObjArray *fTasks; // List of analysis tasks
258 TObjArray *fTopTasks; // List of top tasks
259 TObjArray *fZombies; // List of zombie tasks
260 TObjArray *fContainers; // List of all containers
261 TObjArray *fInputs; // List of containers with input data
262 TObjArray *fOutputs; // List of containers with results
263 TObjArray *fParamCont; // List of containers with parameters
264 TObjArray *fExchangeCont; // List of exchange containers
265 TObjArray *fDebugOptions; // List of debug options
266 TObjArray *fFileDescriptors; //! List of file descriptors
267 AliAnalysisFileDescriptor *fCurrentDescriptor; //! Current file descriptor
268 AliAnalysisDataContainer *fCommonInput; // Common input container
269 AliAnalysisDataContainer *fCommonOutput; // Common output container
270 AliAnalysisSelector *fSelector; //! Current selector
271 AliAnalysisGrid *fGridHandler; //! Grid handler plugin
272 TString fExtraFiles; // List of extra files to be merged
273 TString fFileInfoLog; // File name for fileinfo logs
274 Bool_t fAutoBranchHandling; // def=kTRUE, turn off if you use LoadBranch
275 Bool_t fAsyncReading; // Enable async reading
276 THashTable fTable; // keep branch ptrs in case of manual branch loading
277 Int_t fRunFromPath; // Run number retrieved from path to input data
278 Int_t fNcalls; // Total number of calls (events) of ExecAnalysis
279 Long64_t fMaxEntries; // Maximum number of entries
280 Long64_t fCacheSize; // Cache size in bytes
281 static Int_t fPBUpdateFreq; // Progress bar update freq.
282 TString fStatisticsMsg; // Statistics user message
283 TString fRequestedBranches; // Requested branch names
284 AliAnalysisStatistics *fStatistics; // Statistics info about input events
285 TMap *fGlobals; // Map with global variables
286 TStopwatch *fIOTimer; //! Timer for I/O + deserialization
287 TStopwatch *fCPUTimer; //! Timer for useful processing
288 TStopwatch *fInitTimer; //! Timer for initialization
289 Double_t fIOTime; //! Cumulated time in IO
290 Double_t fCPUTime; //! Cumulated time in Exec
291 Double_t fInitTime; //! Cumulated time in initialization
292 static TString fgCommonFileName; //! Common output file name (not streamed)
293 static TString fgMacroNames; //! Loaded macro names
294 static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
295 ClassDef(AliAnalysisManager, 21) // Analysis manager class