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