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 virtual Int_t GetEntry(Long64_t entry, Int_t getall = 0);
80 virtual Bool_t Init(TTree *tree);
81 virtual Bool_t Notify();
82 virtual Bool_t ProcessCut(Long64_t entry) {return Process(entry);}
83 virtual Bool_t Process(Long64_t entry);
84 TFile *OpenProofFile(AliAnalysisDataContainer *cont, const char *option, const char *extaod="");
85 static TFile *OpenFile(AliAnalysisDataContainer *cont, const char *option, Bool_t ignoreProof=kFALSE);
86 void PackOutput(TList *target);
87 void RegisterExtraFile(const char *fname);
88 Long64_t StartAnalysis(const char *type, TTree * const tree, Long64_t nentries=1234567890, Long64_t firstentry=0);
89 Long64_t StartAnalysis(const char *type, const char *dataset, Long64_t nentries=1234567890, Long64_t firstentry=0);
90 Long64_t StartAnalysis(const char *type, Long64_t nentries=1234567890, Long64_t firstentry=0);
91 virtual void SlaveBegin(TTree *tree);
92 virtual void Terminate();
93 void UnpackOutput(TList *source);
96 static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
98 GetAnalysisType() const {return fMode;}
99 void GetAnalysisTypeString(TString &type) const;
100 Bool_t GetAutoBranchLoading() const {return fAutoBranchHandling;}
101 static const char *GetCommonFileName() {return fgCommonFileName.Data();}
102 AliAnalysisDataContainer *
103 GetCommonInputContainer() const {return fCommonInput;}
104 AliAnalysisDataContainer *
105 GetCommonOutputContainer() const {return fCommonOutput;}
106 TObjArray *GetContainers() const {return fContainers;}
107 Long64_t GetCurrentEntry() const {return fCurrentEntry;}
108 UInt_t GetDebugLevel() const {return fDebug;}
109 TString GetExtraFiles() const {return fExtraFiles;}
110 AliVEventPool* GetEventPool() const {return fEventPool;}
111 Bool_t GetFileFromWrapper(const char *filename, const TList *source);
112 const char *GetFileInfoLog() const {return fFileInfoLog.Data();}
113 static Int_t GetRunFromAlienPath(const char *path);
114 AliAnalysisGrid* GetGridHandler() {return fGridHandler;}
115 TObjArray *GetInputs() const {return fInputs;}
116 AliVEventHandler* GetInputEventHandler() const {return fInputEventHandler;}
117 AliVEventHandler* GetMCtruthEventHandler() const {return fMCtruthEventHandler;}
118 Int_t GetNsysInfo() const {return fNSysInfo;}
119 AliVEventHandler* GetOutputEventHandler() const {return fOutputEventHandler;}
120 TObjArray *GetOutputs() const {return fOutputs;}
121 TObjArray *GetParamOutputs() const {return fParamCont;}
122 Int_t GetRunFromPath() const {return fRunFromPath;}
123 const char *GetRequestedBranches() const {return fRequestedBranches.Data();}
124 TObjArray *GetTasks() const {return fTasks;}
125 TObjArray *GetTopTasks() const {return fTopTasks;}
126 TTree *GetTree() const {return fTree;}
127 TObjArray *GetZombieTasks() const {return fZombies;}
128 static const char *GetGlobalStr(const char *key, Bool_t &valid);
129 static Int_t GetGlobalInt(const char *key, Bool_t &valid);
130 static Double_t GetGlobalDbl(const char *key, Bool_t &valid);
131 TMap *GetGlobals() {return fGlobals;}
132 static Bool_t IsPipe(std::ostream &out);
133 Bool_t IsProofMode() const {return (fMode==kProofAnalysis)?kTRUE:kFALSE;}
134 Bool_t IsRemote() const {return fIsRemote;}
135 Bool_t IsCollectThroughput() {return TObject::TestBit(kCollectThroughput);}
136 Bool_t IsUsingDataSet() const {return TObject::TestBit(kUseDataSet);}
137 void LoadBranch(const char *n) { if(fAutoBranchHandling) return; DoLoadBranch(n); }
139 void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
140 void SetAutoBranchLoading(Bool_t b) { fAutoBranchHandling = b; }
141 void SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
142 void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;}
143 void SetCollectThroughput(Bool_t flag) {TObject::SetBit(kCollectThroughput,flag);}
144 static void SetCommonFileName(const char *name) {fgCommonFileName = name;}
145 void SetDebugLevel(UInt_t level);
146 void SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);}
147 void SetExternalLoop(Bool_t flag) {TObject::SetBit(kExternalLoop,flag);}
148 void SetEventPool(AliVEventPool* const epool) {fEventPool = epool;}
149 void SetFileInfoLog(const char *name) {TObject::SetBit(kCollectThroughput,kTRUE); fFileInfoLog = name;}
150 void SetGridHandler(AliAnalysisGrid * const handler) {fGridHandler = handler;}
151 void SetInputEventHandler(AliVEventHandler* const handler);
152 void SetMCtruthEventHandler(AliVEventHandler* const handler) {fMCtruthEventHandler = handler;}
153 void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
154 void SetOutputEventHandler(AliVEventHandler* const handler);
155 void SetRunFromPath(Int_t run) {fRunFromPath = run;}
156 void SetSelector(AliAnalysisSelector * const sel) {fSelector = sel;}
157 void SetSaveCanvases(Bool_t flag=kTRUE) {TObject::SetBit(kSaveCanvases,flag);}
158 void SetSkipTerminate(Bool_t flag) {TObject::SetBit(kSkipTerminate,flag);}
159 void SetUseProgressBar(Bool_t flag, Int_t freq=1);
160 void SetSpecialOutputLocation(const char *loc) {fSpecialOutputLocation = loc;}
161 static void SetGlobalStr(const char *key, const char *value);
162 static void SetGlobalInt(const char *key, Int_t value);
163 static void SetGlobalDbl(const char *key, Double_t value);
166 // Container handling
167 AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype,
168 EAliAnalysisContType type = kExchangeContainer,
169 const char *filename = NULL);
171 // Including tasks and getting them
172 void AddTask(AliAnalysisTask *task);
173 AliAnalysisTask *GetTask(const char *name) const;
175 // Connecting data containers to task inputs/outputs
176 Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot,
177 AliAnalysisDataContainer *cont);
178 Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot,
179 AliAnalysisDataContainer *cont);
180 // Garbage collection
181 void CleanContainers();
183 // Analysis initialization and execution, status
184 void AddBranches(const char *branches);
185 void AddStatisticsTask(UInt_t offlineMask=0);
186 void CheckBranches(Bool_t load=kFALSE);
187 Bool_t CheckTasks() const;
188 void CountEvent(Int_t ninput, Int_t nprocessed, Int_t nfailed, Int_t naccepted);
189 Bool_t InitAnalysis();
190 Bool_t IsInitialized() const {return fInitOK;}
191 Bool_t IsTrainInitialized() const {return TObject::TestBit(kTasksInitialized);}
192 Bool_t IsExternalLoop() const {return TObject::TestBit(kExternalLoop);}
193 Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);}
194 Bool_t IsSkipTerminate() const {return TObject::TestBit(kSkipTerminate);}
195 Bool_t MustClean() const {return fMustClean;}
196 void SetMustClean(Bool_t flag=kTRUE) {fMustClean = flag;}
197 void ResetAnalysis();
198 void ExecAnalysis(Option_t *option="");
199 void PrintStatus(Option_t *option="all") const;
200 void ProfileTask(const char *name, const char *option="VM") const;
201 void ProfileTask(Int_t itop, const char *option="VM") const;
202 static void ProgressBar(const char *opname, Long64_t current, Long64_t size, TStopwatch * const watch=0, Bool_t last=kFALSE, Bool_t refresh=kFALSE);
203 void AddStatisticsMsg(const char *line);
204 const char *GetStatisticsMsg() const {return fStatisticsMsg.Data();}
205 const AliAnalysisStatistics *GetStatistics() const {return fStatistics;}
206 void SetStatistics(AliAnalysisStatistics *stat) {fStatistics = stat;}
207 void WriteStatisticsMsg(Int_t nevents);
208 Int_t GetNcalls() const {return fNcalls;}
209 Bool_t ValidateOutputFiles() const;
211 static const char* GetOADBPath();
213 void ApplyDebugOptions();
214 void AddClassDebug(const char *className, Int_t debugLevel);
217 void ImportWrappers(TList *source);
218 void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
219 void DoLoadBranch(const char *name);
222 TTree *fTree; //! Input tree in case of TSelector model
223 AliVEventHandler *fInputEventHandler; // Optional common input event handler
224 AliVEventHandler *fOutputEventHandler; // Optional common output event handler
225 AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler
226 AliVEventPool *fEventPool; // Event pool for mixing analysis
227 Long64_t fCurrentEntry; //! Current processed entry in the tree
228 Long64_t fNSysInfo; // Event frequency for collecting system information
229 EAliAnalysisExecMode fMode; // Execution mode
230 Bool_t fInitOK; // Initialisation done
231 Bool_t fMustClean; // Flag to let ROOT do cleanup
232 Bool_t fIsRemote; //! Flag is set for remote analysis
233 UInt_t fDebug; // Debug level
234 TString fSpecialOutputLocation; // URL/path where the special outputs will be copied
235 TObjArray *fTasks; // List of analysis tasks
236 TObjArray *fTopTasks; // List of top tasks
237 TObjArray *fZombies; // List of zombie tasks
238 TObjArray *fContainers; // List of all containers
239 TObjArray *fInputs; // List of containers with input data
240 TObjArray *fOutputs; // List of containers with results
241 TObjArray *fParamCont; // List of containers with results
242 TObjArray *fDebugOptions; // List of debug options
243 TObjArray *fFileDescriptors; //! List of file descriptors
244 AliAnalysisFileDescriptor *fCurrentDescriptor; //! Current file descriptor
245 AliAnalysisDataContainer *fCommonInput; // Common input container
246 AliAnalysisDataContainer *fCommonOutput; // Common output container
247 AliAnalysisSelector *fSelector; //! Current selector
248 AliAnalysisGrid *fGridHandler; //! Grid handler plugin
249 TString fExtraFiles; // List of extra files to be merged
250 TString fFileInfoLog; // File name for fileinfo logs
251 Bool_t fAutoBranchHandling; // def=kTRUE, turn off if you use LoadBranch
252 THashTable fTable; // keep branch ptrs in case of manual branch loading
253 Int_t fRunFromPath; // Run number retrieved from path to input data
254 Int_t fNcalls; // Total number of calls (events) of ExecAnalysis
255 Long64_t fMaxEntries; // Maximum number of entries
256 static Int_t fPBUpdateFreq; // Progress bar update freq.
257 TString fStatisticsMsg; // Statistics user message
258 TString fRequestedBranches; // Requested branch names
259 AliAnalysisStatistics *fStatistics; // Statistics info about input events
260 TMap *fGlobals; // Map with global variables
261 static TString fgCommonFileName; //! Common output file name (not streamed)
262 static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
263 ClassDef(AliAnalysisManager,17) // Analysis manager class