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 //==============================================================================
24 class AliAnalysisSelector;
25 class AliAnalysisDataContainer;
26 class AliAnalysisTask;
27 class AliVEventHandler;
29 class AliAnalysisGrid;
32 class AliAnalysisManager : public TNamed {
36 enum EAliAnalysisContType {
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
43 enum EAliAnalysisExecMode {
50 enum EAliAnalysisFlags {
52 kDisableBranches = BIT(15),
53 kUseDataSet = BIT(16),
54 kSaveCanvases = BIT(17),
55 kExternalLoop = BIT(18),
56 kSkipTerminate = BIT(19)
59 AliAnalysisManager(const char *name = "mgr", const char *title="");
60 virtual ~AliAnalysisManager();
62 AliAnalysisManager(const AliAnalysisManager& other);
63 AliAnalysisManager& operator=(const AliAnalysisManager& other);
66 virtual Int_t GetEntry(Long64_t entry, Int_t getall = 0);
67 virtual Bool_t Init(TTree *tree);
68 virtual Bool_t Notify();
69 virtual Bool_t ProcessCut(Long64_t entry) {return Process(entry);}
70 virtual Bool_t Process(Long64_t entry);
71 TFile *OpenProofFile(AliAnalysisDataContainer *cont, const char *option);
72 static TFile *OpenFile(AliAnalysisDataContainer *cont, const char *option, Bool_t ignoreProof=kFALSE);
73 void PackOutput(TList *target);
74 void RegisterExtraFile(const char *fname);
75 Long64_t StartAnalysis(const char *type="local", TTree * const tree=0, Long64_t nentries=1234567890, Long64_t firstentry=0);
76 Long64_t StartAnalysis(const char *type, const char *dataset, Long64_t nentries=1234567890, Long64_t firstentry=0);
77 virtual void SlaveBegin(TTree *tree);
78 virtual void Terminate();
79 void UnpackOutput(TList *source);
82 static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
84 GetAnalysisType() const {return fMode;}
85 void GetAnalysisTypeString(TString &type) const;
86 static const char *GetCommonFileName() {return fgCommonFileName.Data();}
87 AliAnalysisDataContainer *
88 GetCommonInputContainer() const {return fCommonInput;}
89 AliAnalysisDataContainer *
90 GetCommonOutputContainer() const {return fCommonOutput;}
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;}
95 AliVEventPool* GetEventPool() const {return fEventPool;}
96 Bool_t GetFileFromWrapper(const char *filename, const TList *source);
97 AliAnalysisGrid* GetGridHandler() {return fGridHandler;}
98 TObjArray *GetInputs() const {return fInputs;}
99 AliVEventHandler* GetInputEventHandler() const {return fInputEventHandler;}
100 AliVEventHandler* GetMCtruthEventHandler() const {return fMCtruthEventHandler;}
101 AliVEventHandler* GetOutputEventHandler() const {return fOutputEventHandler;}
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;}
107 Bool_t IsUsingDataSet() const {return TObject::TestBit(kUseDataSet);}
108 void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
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);}
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;}
119 void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
120 void SetOutputEventHandler(AliVEventHandler* const handler);
121 void SetSelector(AliAnalysisSelector * const sel) {fSelector = sel;}
122 void SetSaveCanvases(Bool_t flag=kTRUE) {TObject::SetBit(kSaveCanvases,flag);}
123 void SetSkipTerminate(Bool_t flag) {TObject::SetBit(kSkipTerminate,flag);}
124 void SetSpecialOutputLocation(const char *loc) {fSpecialOutputLocation = loc;}
126 // Container handling
127 AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype,
128 EAliAnalysisContType type = kExchangeContainer,
129 const char *filename = NULL);
131 // Including tasks and getting them
132 void AddTask(AliAnalysisTask *task);
133 AliAnalysisTask *GetTask(const char *name) const;
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();
143 // Analysis initialization and execution, status
144 Bool_t InitAnalysis();
145 Bool_t IsInitialized() const {return fInitOK;}
146 Bool_t IsExternalLoop() const {return TObject::TestBit(kExternalLoop);}
147 Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);}
148 Bool_t IsSkipTerminate() const {return TObject::TestBit(kSkipTerminate);}
149 void ResetAnalysis();
150 void ExecAnalysis(Option_t *option="");
151 void PrintStatus(Option_t *option="all") const;
152 void ProfileTask(const char *name, const char *option="VM") const;
153 void ProfileTask(Int_t itop, const char *option="VM") const;
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);
155 Bool_t ValidateOutputFiles() const;
158 void ImportWrappers(TList *source);
159 void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
162 TTree *fTree; //! Input tree in case of TSelector model
163 AliVEventHandler *fInputEventHandler; // Optional common input event handler
164 AliVEventHandler *fOutputEventHandler; // Optional common output event handler
165 AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler
166 AliVEventPool *fEventPool; // Event pool for mixing analysis
167 Long64_t fCurrentEntry; //! Current processed entry in the tree
168 Long64_t fNSysInfo; // Event frequency for collecting system information
169 EAliAnalysisExecMode fMode; // Execution mode
170 Bool_t fInitOK; // Initialisation done
171 UInt_t fDebug; // Debug level
172 TString fSpecialOutputLocation; // URL/path where the special outputs will be copied
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
179 TObjArray *fParamCont; //! List of containers with results
180 AliAnalysisDataContainer *fCommonInput; // Common input container
181 AliAnalysisDataContainer *fCommonOutput; // Common output container
182 AliAnalysisSelector *fSelector; //! Current selector
183 AliAnalysisGrid *fGridHandler; //! Grid handler plugin
184 TString fExtraFiles; // List of extra files to be merged
186 static TString fgCommonFileName; //! Common output file name (not streamed)
187 static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
188 ClassDef(AliAnalysisManager,6) // Analysis manager class