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