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