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 //==============================================================================
23 class AliAnalysisSelector;
24 class AliAnalysisDataContainer;
25 class AliAnalysisTask;
26 class AliVEventHandler;
28 class AliAnalysisGrid;
31 class AliAnalysisManager : public TNamed {
35 enum EAliAnalysisContType {
36 kExchangeContainer = 0,
41 enum EAliAnalysisExecMode {
48 enum EAliAnalysisFlags {
50 kDisableBranches = BIT(15),
51 kUseDataSet = BIT(16),
52 kSaveCanvases = BIT(17)
55 AliAnalysisManager(const char *name = "mgr", const char *title="");
56 virtual ~AliAnalysisManager();
58 AliAnalysisManager(const AliAnalysisManager& other);
59 AliAnalysisManager& operator=(const AliAnalysisManager& other);
61 // Management methods called by the framework
62 void StartAnalysis(const char *type="local", TTree *tree=0, Long64_t nentries=1234567890, Long64_t firstentry=0);
63 void StartAnalysis(const char *type, const char *dataset, Long64_t nentries=1234567890, Long64_t firstentry=0);
65 virtual Bool_t Init(TTree *tree);
66 virtual Bool_t Notify();
67 virtual void SlaveBegin(TTree *tree);
68 virtual Bool_t ProcessCut(Long64_t entry) {return Process(entry);}
69 virtual Bool_t Process(Long64_t entry);
70 virtual Int_t GetEntry(Long64_t entry, Int_t getall = 0);
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 UnpackOutput(TList *source);
75 virtual void Terminate();
78 static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
79 TObjArray *GetContainers() const {return fContainers;}
80 UInt_t GetDebugLevel() const {return fDebug;}
81 TObjArray *GetInputs() const {return fInputs;}
82 TObjArray *GetOutputs() const {return fOutputs;}
83 TObjArray *GetTasks() const {return fTasks;}
84 TObjArray *GetTopTasks() const {return fTopTasks;}
85 TTree *GetTree() const {return fTree;}
86 TObjArray *GetZombieTasks() const {return fZombies;}
87 Long64_t GetCurrentEntry() const {return fCurrentEntry;}
89 GetAnalysisType() const {return fMode;}
90 void GetAnalysisTypeString(TString &type) const;
91 Bool_t IsUsingDataSet() const {return TObject::TestBit(kUseDataSet);}
93 void RegisterExtraFile(const char *fname);
94 void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
95 void SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
96 static void SetCommonFileName(const char *name) {fgCommonFileName = name;}
97 void SetDebugLevel(UInt_t level) {fDebug = level;}
98 void SetSpecialOutputLocation(const char *location) {fSpecialOutputLocation = location;}
99 void SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);}
100 void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;}
101 void SetInputEventHandler(AliVEventHandler* handler);
102 void SetOutputEventHandler(AliVEventHandler* handler);
103 void SetMCtruthEventHandler(AliVEventHandler* handler) {fMCtruthEventHandler = handler;}
104 void SetGridHandler(AliAnalysisGrid *handler) {fGridHandler = handler;}
105 void SetEventPool(AliVEventPool* epool) {fEventPool = epool;}
106 void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
107 void SetSelector(AliAnalysisSelector *sel) {fSelector = sel;}
108 void SetSaveCanvases(Bool_t flag=kTRUE) {TObject::SetBit(kSaveCanvases,flag);}
109 AliVEventHandler* GetInputEventHandler() {return fInputEventHandler;}
110 AliVEventHandler* GetOutputEventHandler() {return fOutputEventHandler;}
111 AliVEventHandler* GetMCtruthEventHandler() {return fMCtruthEventHandler;}
112 static const char *GetCommonFileName() {return fgCommonFileName.Data();}
113 AliAnalysisDataContainer *GetCommonInputContainer() {return fCommonInput;}
114 AliAnalysisDataContainer *GetCommonOutputContainer() {return fCommonOutput;}
115 AliAnalysisGrid* GetGridHandler() {return fGridHandler;}
116 AliVEventPool* GetEventPool() {return fEventPool;}
117 Bool_t GetFileFromWrapper(const char *filename, TList *source);
118 TString GetExtraFiles() const {return fExtraFiles;}
120 // Container handling
121 AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype,
122 EAliAnalysisContType type = kExchangeContainer,
123 const char *filename = NULL);
125 // Including tasks and getting them
126 void AddTask(AliAnalysisTask *task);
127 AliAnalysisTask *GetTask(const char *name) const;
129 // Connecting data containers to task inputs/outputs
130 Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot,
131 AliAnalysisDataContainer *cont);
132 Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot,
133 AliAnalysisDataContainer *cont);
134 // Garbage collection
135 void CleanContainers();
137 // Analysis initialization and execution, status
138 Bool_t InitAnalysis();
139 Bool_t IsInitialized() const {return fInitOK;}
140 Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);}
141 void ResetAnalysis();
142 void ExecAnalysis(Option_t *option="");
143 void FinishAnalysis();
144 void PrintStatus(Option_t *option="all") const;
145 Bool_t ValidateOutputFiles() const;
148 void ImportWrappers(TList *source);
149 void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
152 TTree *fTree; //! Input tree in case of TSelector model
153 AliVEventHandler *fInputEventHandler; // Optional common input event handler
154 AliVEventHandler *fOutputEventHandler; // Optional common output event handler
155 AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler
156 AliVEventPool *fEventPool; // Event pool for mixing analysis
157 Long64_t fCurrentEntry; //! Current processed entry in the tree
158 Long64_t fNSysInfo; // Event frequency for collecting system information
159 EAliAnalysisExecMode fMode; // Execution mode
160 Bool_t fInitOK; // Initialisation done
161 UInt_t fDebug; // Debug level
162 TString fSpecialOutputLocation; // URL/path where the special outputs will be copied
163 TObjArray *fTasks; // List of analysis tasks
164 TObjArray *fTopTasks; // List of top tasks
165 TObjArray *fZombies; // List of zombie tasks
166 TObjArray *fContainers; // List of all containers
167 TObjArray *fInputs; // List of containers with input data
168 TObjArray *fOutputs; // List of containers with results
169 AliAnalysisDataContainer *fCommonInput; // Common input container
170 AliAnalysisDataContainer *fCommonOutput; // Common output container
171 AliAnalysisSelector *fSelector; //! Current selector
172 AliAnalysisGrid *fGridHandler; //! Grid handler plugin
173 TString fExtraFiles; // List of extra files to be merged
175 static TString fgCommonFileName; //! Common output file name (not streamed)
176 static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
177 ClassDef(AliAnalysisManager,5) // Analysis manager class