]>
Commit | Line | Data |
---|---|---|
d3106602 | 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 */ | |
5 | ||
6 | /* $Id$ */ | |
7 | // Author: Andrei Gheata, 31/05/2006 | |
8 | ||
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 | //============================================================================== | |
15 | ||
c52c2132 | 16 | #ifndef ROOT_TNamed |
17 | #include <TNamed.h> | |
d3106602 | 18 | #endif |
012e169c | 19 | #ifndef ROOT_THashTable |
20 | #include <THashTable.h> | |
21 | #endif | |
8ddad121 | 22 | #ifndef ROOT_Riostream |
23 | #include <Riostream.h> | |
24 | #endif | |
d3106602 | 25 | |
26 | class TClass; | |
c52c2132 | 27 | class TTree; |
8d7d3b59 | 28 | class TFile; |
cd11251e | 29 | class TStopwatch; |
77dad4a9 | 30 | class TMap; |
8d7d3b59 | 31 | class AliAnalysisSelector; |
d3106602 | 32 | class AliAnalysisDataContainer; |
9162405c | 33 | class AliAnalysisFileDescriptor; |
d3106602 | 34 | class AliAnalysisTask; |
d2f1d9ef | 35 | class AliVEventHandler; |
c2922515 | 36 | class AliVEventPool; |
c57f56b7 | 37 | class AliAnalysisGrid; |
f5cbe261 | 38 | class AliAnalysisStatistics; |
1f516476 | 39 | class AliVfriendEvent; |
16af082b | 40 | class AliVEvent; |
d3106602 | 41 | |
c52c2132 | 42 | class AliAnalysisManager : public TNamed { |
d3106602 | 43 | |
44 | public: | |
45 | ||
46 | enum EAliAnalysisContType { | |
6cd44ee0 | 47 | kExchangeContainer = 0, // use to exchange data between tasks |
48 | kInputContainer = 1, // use for the task private input data | |
49 | kOutputContainer = 2, // use for the task private output data | |
50 | kParamContainer = 3 // use for storing task private parameters/cuts per analysis session | |
d3106602 | 51 | }; |
c52c2132 | 52 | |
53 | enum EAliAnalysisExecMode { | |
54 | kLocalAnalysis = 0, | |
55 | kProofAnalysis = 1, | |
aee5ee44 | 56 | kGridAnalysis = 2, |
57 | kMixingAnalysis = 3 | |
c52c2132 | 58 | }; |
59 | ||
efd53803 | 60 | enum EAliAnalysisFlags { |
b1310ef5 | 61 | kEventLoop = BIT(14), |
d86ed856 | 62 | kDisableBranches = BIT(15), |
a0e2e8b1 | 63 | kUseDataSet = BIT(16), |
06a59280 | 64 | kSaveCanvases = BIT(17), |
90a4b3ee | 65 | kExternalLoop = BIT(18), |
ff0d33e8 | 66 | kSkipTerminate = BIT(19), |
20b7268e | 67 | kUseProgressBar = BIT(20), |
d512d8e2 | 68 | kTrueNotify = BIT(21), |
9162405c | 69 | kTasksInitialized = BIT(22), |
70 | kCollectThroughput= BIT(23) | |
71 | }; | |
efd53803 | 72 | |
6e14aaa2 | 73 | AliAnalysisManager(const char *name = "mgr", const char *title=""); |
d3106602 | 74 | virtual ~AliAnalysisManager(); |
c52c2132 | 75 | |
76 | AliAnalysisManager(const AliAnalysisManager& other); | |
77 | AliAnalysisManager& operator=(const AliAnalysisManager& other); | |
d3106602 | 78 | |
06a59280 | 79 | // Event loop control |
cf4b2f02 | 80 | Bool_t EventLoop(Long64_t nevents); |
06a59280 | 81 | virtual Int_t GetEntry(Long64_t entry, Int_t getall = 0); |
20b7268e | 82 | virtual Bool_t Init(TTree *tree); |
327eaf46 | 83 | virtual Bool_t Notify(); |
327eaf46 | 84 | virtual Bool_t ProcessCut(Long64_t entry) {return Process(entry);} |
d3106602 | 85 | virtual Bool_t Process(Long64_t entry); |
039e671e | 86 | TFile *OpenProofFile(AliAnalysisDataContainer *cont, const char *option, const char *extaod=""); |
84fcd93f | 87 | static TFile *OpenFile(AliAnalysisDataContainer *cont, const char *option, Bool_t ignoreProof=kFALSE); |
c52c2132 | 88 | void PackOutput(TList *target); |
06a59280 | 89 | void RegisterExtraFile(const char *fname); |
27734f0e | 90 | Long64_t StartAnalysis(const char *type, TTree * const tree, Long64_t nentries=1234567890, Long64_t firstentry=0); |
1f87e9fb | 91 | Long64_t StartAnalysis(const char *type, const char *dataset, Long64_t nentries=1234567890, Long64_t firstentry=0); |
27734f0e | 92 | Long64_t StartAnalysis(const char *type, Long64_t nentries=1234567890, Long64_t firstentry=0); |
06a59280 | 93 | virtual void SlaveBegin(TTree *tree); |
d3106602 | 94 | virtual void Terminate(); |
06a59280 | 95 | void UnpackOutput(TList *source); |
d3106602 | 96 | |
c52c2132 | 97 | // Getters/Setters |
98 | static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;} | |
d66aa2a9 | 99 | static Int_t LoadMacro(const char *filename, Int_t *error = 0, Bool_t check = kFALSE); |
c52c2132 | 100 | EAliAnalysisExecMode |
06a59280 | 101 | GetAnalysisType() const {return fMode;} |
d29168d6 | 102 | void GetAnalysisTypeString(TString &type) const; |
012e169c | 103 | Bool_t GetAutoBranchLoading() const {return fAutoBranchHandling;} |
43072535 | 104 | Long64_t GetCacheSize() const {return fCacheSize;} |
06a59280 | 105 | static const char *GetCommonFileName() {return fgCommonFileName.Data();} |
106 | AliAnalysisDataContainer * | |
61505f8b | 107 | GetCommonInputContainer() const {return fCommonInput;} |
06a59280 | 108 | AliAnalysisDataContainer * |
61505f8b | 109 | GetCommonOutputContainer() const {return fCommonOutput;} |
06a59280 | 110 | TObjArray *GetContainers() const {return fContainers;} |
111 | Long64_t GetCurrentEntry() const {return fCurrentEntry;} | |
112 | UInt_t GetDebugLevel() const {return fDebug;} | |
43072535 | 113 | Bool_t GetAsyncReading() const {return fAsyncReading;} |
06a59280 | 114 | TString GetExtraFiles() const {return fExtraFiles;} |
61505f8b | 115 | AliVEventPool* GetEventPool() const {return fEventPool;} |
116 | Bool_t GetFileFromWrapper(const char *filename, const TList *source); | |
9162405c | 117 | const char *GetFileInfoLog() const {return fFileInfoLog.Data();} |
242accb2 | 118 | static Int_t GetRunFromAlienPath(const char *path); |
06a59280 | 119 | AliAnalysisGrid* GetGridHandler() {return fGridHandler;} |
120 | TObjArray *GetInputs() const {return fInputs;} | |
61505f8b | 121 | AliVEventHandler* GetInputEventHandler() const {return fInputEventHandler;} |
122 | AliVEventHandler* GetMCtruthEventHandler() const {return fMCtruthEventHandler;} | |
627a5dbe | 123 | Int_t GetNsysInfo() const {return fNSysInfo;} |
61505f8b | 124 | AliVEventHandler* GetOutputEventHandler() const {return fOutputEventHandler;} |
06a59280 | 125 | TObjArray *GetOutputs() const {return fOutputs;} |
ff07ec61 | 126 | TObjArray *GetParamOutputs() const {return fParamCont;} |
4ff26233 | 127 | TObjArray *GetExchangeContainers() const {return fExchangeCont;} |
242accb2 | 128 | Int_t GetRunFromPath() const {return fRunFromPath;} |
7acc5b9d | 129 | const char *GetRequestedBranches() const {return fRequestedBranches.Data();} |
06a59280 | 130 | TObjArray *GetTasks() const {return fTasks;} |
131 | TObjArray *GetTopTasks() const {return fTopTasks;} | |
132 | TTree *GetTree() const {return fTree;} | |
133 | TObjArray *GetZombieTasks() const {return fZombies;} | |
77dad4a9 | 134 | static const char *GetGlobalStr(const char *key, Bool_t &valid); |
135 | static Int_t GetGlobalInt(const char *key, Bool_t &valid); | |
136 | static Double_t GetGlobalDbl(const char *key, Bool_t &valid); | |
137 | TMap *GetGlobals() {return fGlobals;} | |
42bb96b9 | 138 | static Bool_t IsMacroLoaded(const char * filename); |
715da79c | 139 | Bool_t IsMCLoop() const {return fMCLoop;} |
8ddad121 | 140 | static Bool_t IsPipe(std::ostream &out); |
d791fad6 | 141 | Bool_t IsProofMode() const {return (fMode==kProofAnalysis)?kTRUE:kFALSE;} |
8e1f0465 | 142 | Bool_t IsRemote() const {return fIsRemote;} |
9162405c | 143 | Bool_t IsCollectThroughput() {return TObject::TestBit(kCollectThroughput);} |
06a59280 | 144 | Bool_t IsUsingDataSet() const {return TObject::TestBit(kUseDataSet);} |
012e169c | 145 | void LoadBranch(const char *n) { if(fAutoBranchHandling) return; DoLoadBranch(n); } |
d512d8e2 | 146 | void RunLocalInit(); |
c52c2132 | 147 | void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;} |
012e169c | 148 | void SetAutoBranchLoading(Bool_t b) { fAutoBranchHandling = b; } |
06a59280 | 149 | void SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;} |
43072535 | 150 | void SetCacheSize(Long64_t size) {fCacheSize = size;} |
06a59280 | 151 | void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;} |
59e0dcd5 | 152 | void SetCollectThroughput(Bool_t flag) {Changed(); TObject::SetBit(kCollectThroughput,flag);} |
06a59280 | 153 | static void SetCommonFileName(const char *name) {fgCommonFileName = name;} |
f03a8355 | 154 | void SetDebugLevel(UInt_t level); |
59e0dcd5 | 155 | void SetDisableBranches(Bool_t disable=kTRUE) {Changed(); TObject::SetBit(kDisableBranches,disable);} |
43072535 | 156 | void SetAsyncReading(Bool_t flag=kTRUE) {fAsyncReading = flag;} |
59e0dcd5 | 157 | void SetExternalLoop(Bool_t flag) {Changed(); TObject::SetBit(kExternalLoop,flag);} |
715da79c | 158 | void SetMCLoop(Bool_t flag=kTRUE) {fMCLoop = flag;} |
59e0dcd5 | 159 | void SetEventPool(AliVEventPool* const epool) {Changed(); fEventPool = epool;} |
9162405c | 160 | void SetFileInfoLog(const char *name) {TObject::SetBit(kCollectThroughput,kTRUE); fFileInfoLog = name;} |
59e0dcd5 | 161 | void SetGridHandler(AliAnalysisGrid * const handler) {Changed(); fGridHandler = handler;} |
61505f8b | 162 | void SetInputEventHandler(AliVEventHandler* const handler); |
59e0dcd5 | 163 | void SetMCtruthEventHandler(AliVEventHandler* const handler) {Changed(); fMCtruthEventHandler = handler;} |
06a59280 | 164 | void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;} |
61505f8b | 165 | void SetOutputEventHandler(AliVEventHandler* const handler); |
242accb2 | 166 | void SetRunFromPath(Int_t run) {fRunFromPath = run;} |
61505f8b | 167 | void SetSelector(AliAnalysisSelector * const sel) {fSelector = sel;} |
06a59280 | 168 | void SetSaveCanvases(Bool_t flag=kTRUE) {TObject::SetBit(kSaveCanvases,flag);} |
90a4b3ee | 169 | void SetSkipTerminate(Bool_t flag) {TObject::SetBit(kSkipTerminate,flag);} |
f03a8355 | 170 | void SetUseProgressBar(Bool_t flag, Int_t freq=1); |
06a59280 | 171 | void SetSpecialOutputLocation(const char *loc) {fSpecialOutputLocation = loc;} |
77dad4a9 | 172 | static void SetGlobalStr(const char *key, const char *value); |
173 | static void SetGlobalInt(const char *key, Int_t value); | |
174 | static void SetGlobalDbl(const char *key, Double_t value); | |
175 | ||
d3106602 | 176 | |
177 | // Container handling | |
178 | AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype, | |
c52c2132 | 179 | EAliAnalysisContType type = kExchangeContainer, |
180 | const char *filename = NULL); | |
d3106602 | 181 | |
182 | // Including tasks and getting them | |
183 | void AddTask(AliAnalysisTask *task); | |
184 | AliAnalysisTask *GetTask(const char *name) const; | |
ed37a9ae | 185 | Int_t GetTaskIndex(const AliAnalysisTask *task) const; |
d3106602 | 186 | |
187 | // Connecting data containers to task inputs/outputs | |
188 | Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot, | |
189 | AliAnalysisDataContainer *cont); | |
190 | Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot, | |
191 | AliAnalysisDataContainer *cont); | |
192 | // Garbage collection | |
193 | void CleanContainers(); | |
194 | ||
195 | // Analysis initialization and execution, status | |
7acc5b9d | 196 | void AddBranches(const char *branches); |
c3732d79 | 197 | void AddStatisticsTask(UInt_t offlineMask=0); |
7acc5b9d | 198 | void CheckBranches(Bool_t load=kFALSE); |
4747b4a7 | 199 | Bool_t CheckTasks() const; |
f5cbe261 | 200 | void CountEvent(Int_t ninput, Int_t nprocessed, Int_t nfailed, Int_t naccepted); |
d3106602 | 201 | Bool_t InitAnalysis(); |
202 | Bool_t IsInitialized() const {return fInitOK;} | |
d512d8e2 | 203 | Bool_t IsTrainInitialized() const {return TObject::TestBit(kTasksInitialized);} |
90a4b3ee | 204 | Bool_t IsExternalLoop() const {return TObject::TestBit(kExternalLoop);} |
efd53803 | 205 | Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);} |
90a4b3ee | 206 | Bool_t IsSkipTerminate() const {return TObject::TestBit(kSkipTerminate);} |
270bc710 | 207 | Bool_t MustClean() const {return fMustClean;} |
208 | void SetMustClean(Bool_t flag=kTRUE) {fMustClean = flag;} | |
d3106602 | 209 | void ResetAnalysis(); |
210 | void ExecAnalysis(Option_t *option=""); | |
d3106602 | 211 | void PrintStatus(Option_t *option="all") const; |
096b5a2e | 212 | void ProfileTask(const char *name, const char *option="VM") const; |
213 | void ProfileTask(Int_t itop, const char *option="VM") const; | |
61505f8b | 214 | static void ProgressBar(const char *opname, Long64_t current, Long64_t size, TStopwatch * const watch=0, Bool_t last=kFALSE, Bool_t refresh=kFALSE); |
e9247450 | 215 | void AddStatisticsMsg(const char *line); |
216 | const char *GetStatisticsMsg() const {return fStatisticsMsg.Data();} | |
f5cbe261 | 217 | const AliAnalysisStatistics *GetStatistics() const {return fStatistics;} |
c3732d79 | 218 | void SetStatistics(AliAnalysisStatistics *stat) {fStatistics = stat;} |
e9247450 | 219 | void WriteStatisticsMsg(Int_t nevents); |
220 | Int_t GetNcalls() const {return fNcalls;} | |
923e2ca5 | 221 | Bool_t ValidateOutputFiles() const; |
37196805 | 222 | |
223 | static const char* GetOADBPath(); | |
d3106602 | 224 | |
6f3e07d8 | 225 | void ApplyDebugOptions(); |
226 | void AddClassDebug(const char *className, Int_t debugLevel); | |
59e0dcd5 | 227 | |
228 | // Security | |
229 | Bool_t IsLocked() const {return fLocked;} | |
230 | void Lock(); | |
231 | void UnLock(); | |
232 | void Changed(); | |
16af082b | 233 | void InitInputData(AliVEvent* esdEvent, AliVfriendEvent* esdFriend); |
d3106602 | 234 | protected: |
43072535 | 235 | void CreateReadCache(); |
981f2614 | 236 | void ImportWrappers(TList *source); |
fdbaa4ce | 237 | void InputFileFromTree(TTree * const tree, TString &fname); |
efd53803 | 238 | void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);} |
012e169c | 239 | void DoLoadBranch(const char *name); |
d3106602 | 240 | |
5daf9fd2 | 241 | private: |
6bb2b24f | 242 | TTree *fTree; //! Input tree in case of TSelector model |
54cff064 | 243 | AliVEventHandler *fInputEventHandler; // Optional common input event handler |
d2f1d9ef | 244 | AliVEventHandler *fOutputEventHandler; // Optional common output event handler |
245 | AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler | |
c2922515 | 246 | AliVEventPool *fEventPool; // Event pool for mixing analysis |
6bb2b24f | 247 | Long64_t fCurrentEntry; //! Current processed entry in the tree |
8c0ab8e8 | 248 | Long64_t fNSysInfo; // Event frequency for collecting system information |
6bb2b24f | 249 | EAliAnalysisExecMode fMode; // Execution mode |
250 | Bool_t fInitOK; // Initialisation done | |
270bc710 | 251 | Bool_t fMustClean; // Flag to let ROOT do cleanup |
8e1f0465 | 252 | Bool_t fIsRemote; //! Flag is set for remote analysis |
59e0dcd5 | 253 | Bool_t fLocked; //! Lock for the manager and handlers |
715da79c | 254 | Bool_t fMCLoop; // External MC generator loop |
6bb2b24f | 255 | UInt_t fDebug; // Debug level |
13ef3bb0 | 256 | TString fSpecialOutputLocation; // URL/path where the special outputs will be copied |
6bb2b24f | 257 | TObjArray *fTasks; // List of analysis tasks |
258 | TObjArray *fTopTasks; // List of top tasks | |
259 | TObjArray *fZombies; // List of zombie tasks | |
260 | TObjArray *fContainers; // List of all containers | |
261 | TObjArray *fInputs; // List of containers with input data | |
262 | TObjArray *fOutputs; // List of containers with results | |
4ff26233 | 263 | TObjArray *fParamCont; // List of containers with parameters |
264 | TObjArray *fExchangeCont; // List of exchange containers | |
6f3e07d8 | 265 | TObjArray *fDebugOptions; // List of debug options |
9162405c | 266 | TObjArray *fFileDescriptors; //! List of file descriptors |
267 | AliAnalysisFileDescriptor *fCurrentDescriptor; //! Current file descriptor | |
60a04972 | 268 | AliAnalysisDataContainer *fCommonInput; // Common input container |
269 | AliAnalysisDataContainer *fCommonOutput; // Common output container | |
8d7d3b59 | 270 | AliAnalysisSelector *fSelector; //! Current selector |
c57f56b7 | 271 | AliAnalysisGrid *fGridHandler; //! Grid handler plugin |
c9e39043 | 272 | TString fExtraFiles; // List of extra files to be merged |
9162405c | 273 | TString fFileInfoLog; // File name for fileinfo logs |
012e169c | 274 | Bool_t fAutoBranchHandling; // def=kTRUE, turn off if you use LoadBranch |
43072535 | 275 | Bool_t fAsyncReading; // Enable async reading |
012e169c | 276 | THashTable fTable; // keep branch ptrs in case of manual branch loading |
242accb2 | 277 | Int_t fRunFromPath; // Run number retrieved from path to input data |
e9247450 | 278 | Int_t fNcalls; // Total number of calls (events) of ExecAnalysis |
f03a8355 | 279 | Long64_t fMaxEntries; // Maximum number of entries |
43072535 | 280 | Long64_t fCacheSize; // Cache size in bytes |
f03a8355 | 281 | static Int_t fPBUpdateFreq; // Progress bar update freq. |
e9247450 | 282 | TString fStatisticsMsg; // Statistics user message |
7acc5b9d | 283 | TString fRequestedBranches; // Requested branch names |
f5cbe261 | 284 | AliAnalysisStatistics *fStatistics; // Statistics info about input events |
77dad4a9 | 285 | TMap *fGlobals; // Map with global variables |
ec5acdce | 286 | TStopwatch *fIOTimer; //! Timer for I/O + deserialization |
287 | TStopwatch *fCPUTimer; //! Timer for useful processing | |
288 | TStopwatch *fInitTimer; //! Timer for initialization | |
289 | Double_t fIOTime; //! Cumulated time in IO | |
290 | Double_t fCPUTime; //! Cumulated time in Exec | |
291 | Double_t fInitTime; //! Cumulated time in initialization | |
84fcd93f | 292 | static TString fgCommonFileName; //! Common output file name (not streamed) |
d66aa2a9 | 293 | static TString fgMacroNames; //! Loaded macro names |
c52c2132 | 294 | static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance |
afdb0e0d | 295 | ClassDef(AliAnalysisManager, 21) // Analysis manager class |
d3106602 | 296 | }; |
297 | #endif |