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 const char *GetRequestedBranches() const {return fRequestedBranches.Data();}
113 TObjArray *GetTasks() const {return fTasks;}
114 TObjArray *GetTopTasks() const {return fTopTasks;}
115 TTree *GetTree() const {return fTree;}
116 TObjArray *GetZombieTasks() const {return fZombies;}
117 Bool_t IsProofMode() const {return (fMode==kProofAnalysis)?kTRUE:kFALSE;}
118 Bool_t IsRemote() const {return fIsRemote;}
119 Bool_t IsUsingDataSet() const {return TObject::TestBit(kUseDataSet);}
120 void LoadBranch(const char *n) { if(fAutoBranchHandling) return; DoLoadBranch(n); }
121 void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
122 void SetAutoBranchLoading(Bool_t b) { fAutoBranchHandling = b; }
123 void SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
124 void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;}
125 static void SetCommonFileName(const char *name) {fgCommonFileName = name;}
126 void SetDebugLevel(UInt_t level) {fDebug = level;}
127 void SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);}
128 void SetExternalLoop(Bool_t flag) {TObject::SetBit(kExternalLoop,flag);}
129 void SetEventPool(AliVEventPool* const epool) {fEventPool = epool;}
130 void SetGridHandler(AliAnalysisGrid * const handler) {fGridHandler = handler;}
131 void SetInputEventHandler(AliVEventHandler* const handler);
132 void SetMCtruthEventHandler(AliVEventHandler* const handler) {fMCtruthEventHandler = handler;}
133 void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
134 void SetOutputEventHandler(AliVEventHandler* const handler);
135 void SetRunFromPath(Int_t run) {fRunFromPath = run;}
136 void SetSelector(AliAnalysisSelector * const sel) {fSelector = sel;}
137 void SetSaveCanvases(Bool_t flag=kTRUE) {TObject::SetBit(kSaveCanvases,flag);}
138 void SetSkipTerminate(Bool_t flag) {TObject::SetBit(kSkipTerminate,flag);}
139 void SetUseProgressBar(Bool_t flag) {TObject::SetBit(kUseProgressBar,flag);}
140 void SetSpecialOutputLocation(const char *loc) {fSpecialOutputLocation = loc;}
142 // Container handling
143 AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype,
144 EAliAnalysisContType type = kExchangeContainer,
145 const char *filename = NULL);
147 // Including tasks and getting them
148 void AddTask(AliAnalysisTask *task);
149 AliAnalysisTask *GetTask(const char *name) const;
151 // Connecting data containers to task inputs/outputs
152 Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot,
153 AliAnalysisDataContainer *cont);
154 Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot,
155 AliAnalysisDataContainer *cont);
156 // Garbage collection
157 void CleanContainers();
159 // Analysis initialization and execution, status
160 void AddBranches(const char *branches);
161 void CheckBranches(Bool_t load=kFALSE);
162 Bool_t InitAnalysis();
163 Bool_t IsInitialized() const {return fInitOK;}
164 Bool_t IsExternalLoop() const {return TObject::TestBit(kExternalLoop);}
165 Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);}
166 Bool_t IsSkipTerminate() const {return TObject::TestBit(kSkipTerminate);}
167 void ResetAnalysis();
168 void ExecAnalysis(Option_t *option="");
169 void PrintStatus(Option_t *option="all") const;
170 void ProfileTask(const char *name, const char *option="VM") const;
171 void ProfileTask(Int_t itop, const char *option="VM") const;
172 static void ProgressBar(const char *opname, Long64_t current, Long64_t size, TStopwatch * const watch=0, Bool_t last=kFALSE, Bool_t refresh=kFALSE);
173 void AddStatisticsMsg(const char *line);
174 const char *GetStatisticsMsg() const {return fStatisticsMsg.Data();}
175 void WriteStatisticsMsg(Int_t nevents);
176 Int_t GetNcalls() const {return fNcalls;}
177 Bool_t ValidateOutputFiles() const;
180 void ImportWrappers(TList *source);
181 void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
182 void DoLoadBranch(const char *name);
185 TTree *fTree; //! Input tree in case of TSelector model
186 AliVEventHandler *fInputEventHandler; // Optional common input event handler
187 AliVEventHandler *fOutputEventHandler; // Optional common output event handler
188 AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler
189 AliVEventPool *fEventPool; // Event pool for mixing analysis
190 Long64_t fCurrentEntry; //! Current processed entry in the tree
191 Long64_t fNSysInfo; // Event frequency for collecting system information
192 EAliAnalysisExecMode fMode; // Execution mode
193 Bool_t fInitOK; // Initialisation done
194 Bool_t fIsRemote; //! Flag is set for remote analysis
195 UInt_t fDebug; // Debug level
196 TString fSpecialOutputLocation; // URL/path where the special outputs will be copied
197 TObjArray *fTasks; // List of analysis tasks
198 TObjArray *fTopTasks; // List of top tasks
199 TObjArray *fZombies; // List of zombie tasks
200 TObjArray *fContainers; // List of all containers
201 TObjArray *fInputs; // List of containers with input data
202 TObjArray *fOutputs; // List of containers with results
203 TObjArray *fParamCont; // List of containers with results
204 AliAnalysisDataContainer *fCommonInput; // Common input container
205 AliAnalysisDataContainer *fCommonOutput; // Common output container
206 AliAnalysisSelector *fSelector; //! Current selector
207 AliAnalysisGrid *fGridHandler; //! Grid handler plugin
208 TString fExtraFiles; // List of extra files to be merged
209 Bool_t fAutoBranchHandling; // def=kTRUE, turn off if you use LoadBranch
210 THashTable fTable; // keep branch ptrs in case of manual branch loading
211 Int_t fRunFromPath; // Run number retrieved from path to input data
212 Int_t fNcalls; // Total number of calls (events) of ExecAnalysis
213 TString fStatisticsMsg; // Statistics user message
214 TString fRequestedBranches; // Requested branch names
215 static TString fgCommonFileName; //! Common output file name (not streamed)
216 static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
217 ClassDef(AliAnalysisManager,11) // Analysis manager class