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