]>
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 |
19 | ||
20 | class TClass; | |
c52c2132 | 21 | class TTree; |
8d7d3b59 | 22 | class TFile; |
cd11251e | 23 | class TStopwatch; |
8d7d3b59 | 24 | class AliAnalysisSelector; |
d3106602 | 25 | class AliAnalysisDataContainer; |
26 | class AliAnalysisTask; | |
d2f1d9ef | 27 | class AliVEventHandler; |
c2922515 | 28 | class AliVEventPool; |
c57f56b7 | 29 | class AliAnalysisGrid; |
8c9485b2 | 30 | |
d3106602 | 31 | |
c52c2132 | 32 | class AliAnalysisManager : public TNamed { |
d3106602 | 33 | |
34 | public: | |
35 | ||
36 | enum EAliAnalysisContType { | |
6cd44ee0 | 37 | kExchangeContainer = 0, // use to exchange data between tasks |
38 | kInputContainer = 1, // use for the task private input data | |
39 | kOutputContainer = 2, // use for the task private output data | |
40 | kParamContainer = 3 // use for storing task private parameters/cuts per analysis session | |
d3106602 | 41 | }; |
c52c2132 | 42 | |
43 | enum EAliAnalysisExecMode { | |
44 | kLocalAnalysis = 0, | |
45 | kProofAnalysis = 1, | |
aee5ee44 | 46 | kGridAnalysis = 2, |
47 | kMixingAnalysis = 3 | |
c52c2132 | 48 | }; |
49 | ||
efd53803 | 50 | enum EAliAnalysisFlags { |
b1310ef5 | 51 | kEventLoop = BIT(14), |
d86ed856 | 52 | kDisableBranches = BIT(15), |
a0e2e8b1 | 53 | kUseDataSet = BIT(16), |
06a59280 | 54 | kSaveCanvases = BIT(17), |
90a4b3ee | 55 | kExternalLoop = BIT(18), |
56 | kSkipTerminate = BIT(19) | |
efd53803 | 57 | }; |
58 | ||
6e14aaa2 | 59 | AliAnalysisManager(const char *name = "mgr", const char *title=""); |
d3106602 | 60 | virtual ~AliAnalysisManager(); |
c52c2132 | 61 | |
62 | AliAnalysisManager(const AliAnalysisManager& other); | |
63 | AliAnalysisManager& operator=(const AliAnalysisManager& other); | |
d3106602 | 64 | |
06a59280 | 65 | // Event loop control |
66 | virtual Int_t GetEntry(Long64_t entry, Int_t getall = 0); | |
2d626244 | 67 | virtual Bool_t Init(TTree *tree); |
327eaf46 | 68 | virtual Bool_t Notify(); |
327eaf46 | 69 | virtual Bool_t ProcessCut(Long64_t entry) {return Process(entry);} |
d3106602 | 70 | virtual Bool_t Process(Long64_t entry); |
84fcd93f | 71 | TFile *OpenProofFile(AliAnalysisDataContainer *cont, const char *option); |
72 | static TFile *OpenFile(AliAnalysisDataContainer *cont, const char *option, Bool_t ignoreProof=kFALSE); | |
c52c2132 | 73 | void PackOutput(TList *target); |
06a59280 | 74 | void RegisterExtraFile(const char *fname); |
61505f8b | 75 | Long64_t StartAnalysis(const char *type="local", TTree * const tree=0, Long64_t nentries=1234567890, Long64_t firstentry=0); |
1f87e9fb | 76 | Long64_t StartAnalysis(const char *type, const char *dataset, Long64_t nentries=1234567890, Long64_t firstentry=0); |
06a59280 | 77 | virtual void SlaveBegin(TTree *tree); |
d3106602 | 78 | virtual void Terminate(); |
06a59280 | 79 | void UnpackOutput(TList *source); |
d3106602 | 80 | |
c52c2132 | 81 | // Getters/Setters |
82 | static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;} | |
c52c2132 | 83 | EAliAnalysisExecMode |
06a59280 | 84 | GetAnalysisType() const {return fMode;} |
d29168d6 | 85 | void GetAnalysisTypeString(TString &type) const; |
06a59280 | 86 | static const char *GetCommonFileName() {return fgCommonFileName.Data();} |
87 | AliAnalysisDataContainer * | |
61505f8b | 88 | GetCommonInputContainer() const {return fCommonInput;} |
06a59280 | 89 | AliAnalysisDataContainer * |
61505f8b | 90 | GetCommonOutputContainer() const {return fCommonOutput;} |
06a59280 | 91 | TObjArray *GetContainers() const {return fContainers;} |
92 | Long64_t GetCurrentEntry() const {return fCurrentEntry;} | |
93 | UInt_t GetDebugLevel() const {return fDebug;} | |
94 | TString GetExtraFiles() const {return fExtraFiles;} | |
61505f8b | 95 | AliVEventPool* GetEventPool() const {return fEventPool;} |
96 | Bool_t GetFileFromWrapper(const char *filename, const TList *source); | |
06a59280 | 97 | AliAnalysisGrid* GetGridHandler() {return fGridHandler;} |
98 | TObjArray *GetInputs() const {return fInputs;} | |
61505f8b | 99 | AliVEventHandler* GetInputEventHandler() const {return fInputEventHandler;} |
100 | AliVEventHandler* GetMCtruthEventHandler() const {return fMCtruthEventHandler;} | |
101 | AliVEventHandler* GetOutputEventHandler() const {return fOutputEventHandler;} | |
06a59280 | 102 | TObjArray *GetOutputs() const {return fOutputs;} |
103 | TObjArray *GetTasks() const {return fTasks;} | |
104 | TObjArray *GetTopTasks() const {return fTopTasks;} | |
105 | TTree *GetTree() const {return fTree;} | |
106 | TObjArray *GetZombieTasks() const {return fZombies;} | |
06a59280 | 107 | Bool_t IsUsingDataSet() const {return TObject::TestBit(kUseDataSet);} |
c52c2132 | 108 | void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;} |
06a59280 | 109 | void SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;} |
110 | void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;} | |
111 | static void SetCommonFileName(const char *name) {fgCommonFileName = name;} | |
112 | void SetDebugLevel(UInt_t level) {fDebug = level;} | |
113 | void SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);} | |
114 | void SetExternalLoop(Bool_t flag) {TObject::SetBit(kExternalLoop,flag);} | |
61505f8b | 115 | void SetEventPool(AliVEventPool* const epool) {fEventPool = epool;} |
116 | void SetGridHandler(AliAnalysisGrid * const handler) {fGridHandler = handler;} | |
117 | void SetInputEventHandler(AliVEventHandler* const handler); | |
118 | void SetMCtruthEventHandler(AliVEventHandler* const handler) {fMCtruthEventHandler = handler;} | |
06a59280 | 119 | void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;} |
61505f8b | 120 | void SetOutputEventHandler(AliVEventHandler* const handler); |
121 | void SetSelector(AliAnalysisSelector * const sel) {fSelector = sel;} | |
06a59280 | 122 | void SetSaveCanvases(Bool_t flag=kTRUE) {TObject::SetBit(kSaveCanvases,flag);} |
90a4b3ee | 123 | void SetSkipTerminate(Bool_t flag) {TObject::SetBit(kSkipTerminate,flag);} |
06a59280 | 124 | void SetSpecialOutputLocation(const char *loc) {fSpecialOutputLocation = loc;} |
d3106602 | 125 | |
126 | // Container handling | |
127 | AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype, | |
c52c2132 | 128 | EAliAnalysisContType type = kExchangeContainer, |
129 | const char *filename = NULL); | |
d3106602 | 130 | |
131 | // Including tasks and getting them | |
132 | void AddTask(AliAnalysisTask *task); | |
133 | AliAnalysisTask *GetTask(const char *name) const; | |
134 | ||
135 | // Connecting data containers to task inputs/outputs | |
136 | Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot, | |
137 | AliAnalysisDataContainer *cont); | |
138 | Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot, | |
139 | AliAnalysisDataContainer *cont); | |
140 | // Garbage collection | |
141 | void CleanContainers(); | |
142 | ||
143 | // Analysis initialization and execution, status | |
144 | Bool_t InitAnalysis(); | |
145 | Bool_t IsInitialized() const {return fInitOK;} | |
90a4b3ee | 146 | Bool_t IsExternalLoop() const {return TObject::TestBit(kExternalLoop);} |
efd53803 | 147 | Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);} |
90a4b3ee | 148 | Bool_t IsSkipTerminate() const {return TObject::TestBit(kSkipTerminate);} |
d3106602 | 149 | void ResetAnalysis(); |
150 | void ExecAnalysis(Option_t *option=""); | |
d3106602 | 151 | void PrintStatus(Option_t *option="all") const; |
096b5a2e | 152 | void ProfileTask(const char *name, const char *option="VM") const; |
153 | void ProfileTask(Int_t itop, const char *option="VM") const; | |
61505f8b | 154 | static void ProgressBar(const char *opname, Long64_t current, Long64_t size, TStopwatch * const watch=0, Bool_t last=kFALSE, Bool_t refresh=kFALSE); |
923e2ca5 | 155 | Bool_t ValidateOutputFiles() const; |
d3106602 | 156 | |
157 | protected: | |
981f2614 | 158 | void ImportWrappers(TList *source); |
efd53803 | 159 | void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);} |
d3106602 | 160 | |
5daf9fd2 | 161 | private: |
6bb2b24f | 162 | TTree *fTree; //! Input tree in case of TSelector model |
54cff064 | 163 | AliVEventHandler *fInputEventHandler; // Optional common input event handler |
d2f1d9ef | 164 | AliVEventHandler *fOutputEventHandler; // Optional common output event handler |
165 | AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler | |
c2922515 | 166 | AliVEventPool *fEventPool; // Event pool for mixing analysis |
6bb2b24f | 167 | Long64_t fCurrentEntry; //! Current processed entry in the tree |
8c0ab8e8 | 168 | Long64_t fNSysInfo; // Event frequency for collecting system information |
6bb2b24f | 169 | EAliAnalysisExecMode fMode; // Execution mode |
170 | Bool_t fInitOK; // Initialisation done | |
171 | UInt_t fDebug; // Debug level | |
13ef3bb0 | 172 | TString fSpecialOutputLocation; // URL/path where the special outputs will be copied |
6bb2b24f | 173 | TObjArray *fTasks; // List of analysis tasks |
174 | TObjArray *fTopTasks; // List of top tasks | |
175 | TObjArray *fZombies; // List of zombie tasks | |
176 | TObjArray *fContainers; // List of all containers | |
177 | TObjArray *fInputs; // List of containers with input data | |
178 | TObjArray *fOutputs; // List of containers with results | |
6cd44ee0 | 179 | TObjArray *fParamCont; //! List of containers with results |
60a04972 | 180 | AliAnalysisDataContainer *fCommonInput; // Common input container |
181 | AliAnalysisDataContainer *fCommonOutput; // Common output container | |
8d7d3b59 | 182 | AliAnalysisSelector *fSelector; //! Current selector |
c57f56b7 | 183 | AliAnalysisGrid *fGridHandler; //! Grid handler plugin |
c9e39043 | 184 | TString fExtraFiles; // List of extra files to be merged |
5daf9fd2 | 185 | |
84fcd93f | 186 | static TString fgCommonFileName; //! Common output file name (not streamed) |
c52c2132 | 187 | static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance |
6cd44ee0 | 188 | ClassDef(AliAnalysisManager,6) // Analysis manager class |
d3106602 | 189 | }; |
190 | #endif |