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