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