Added AddTrackParams() method for convenience + some comments
[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisManager.h
CommitLineData
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
20class TClass;
c52c2132 21class TTree;
8d7d3b59 22class TFile;
23class AliAnalysisSelector;
d3106602 24class AliAnalysisDataContainer;
25class AliAnalysisTask;
d2f1d9ef 26class AliVEventHandler;
c2922515 27class AliVEventPool;
c57f56b7 28class AliAnalysisGrid;
8c9485b2 29
d3106602 30
c52c2132 31class AliAnalysisManager : public TNamed {
d3106602 32
33public:
34
35enum EAliAnalysisContType {
c52c2132 36 kExchangeContainer = 0,
d3106602 37 kInputContainer = 1,
38 kOutputContainer = 2
39};
c52c2132 40
41enum EAliAnalysisExecMode {
42 kLocalAnalysis = 0,
43 kProofAnalysis = 1,
aee5ee44 44 kGridAnalysis = 2,
45 kMixingAnalysis = 3
c52c2132 46};
47
efd53803 48enum EAliAnalysisFlags {
b1310ef5 49 kEventLoop = BIT(14),
d86ed856 50 kDisableBranches = BIT(15),
51 kUseDataSet = BIT(16)
efd53803 52};
53
6e14aaa2 54 AliAnalysisManager(const char *name = "mgr", const char *title="");
d3106602 55 virtual ~AliAnalysisManager();
c52c2132 56
57 AliAnalysisManager(const AliAnalysisManager& other);
58 AliAnalysisManager& operator=(const AliAnalysisManager& other);
d3106602 59
8c0ab8e8 60 // Management
61 void StartAnalysis(const char *type="local", TTree *tree=0, Long64_t nentries=1234567890, Long64_t firstentry=0);
d86ed856 62 void StartAnalysis(const char *type, const char *dataset, Long64_t nentries=1234567890, Long64_t firstentry=0);
c52c2132 63
2d626244 64 virtual Bool_t Init(TTree *tree);
327eaf46 65 virtual Bool_t Notify();
d3106602 66 virtual void SlaveBegin(TTree *tree);
327eaf46 67 virtual Bool_t ProcessCut(Long64_t entry) {return Process(entry);}
d3106602 68 virtual Bool_t Process(Long64_t entry);
327eaf46 69 virtual Int_t GetEntry(Long64_t entry, Int_t getall = 0);
8d7d3b59 70 TFile *OpenProofFile(const char *name, const char *option);
c52c2132 71 void PackOutput(TList *target);
72 void UnpackOutput(TList *source);
d3106602 73 virtual void Terminate();
74
c52c2132 75 // Getters/Setters
76 static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
d3106602 77 TObjArray *GetContainers() const {return fContainers;}
c52c2132 78 UInt_t GetDebugLevel() const {return fDebug;}
d3106602 79 TObjArray *GetInputs() const {return fInputs;}
80 TObjArray *GetOutputs() const {return fOutputs;}
81 TObjArray *GetTasks() const {return fTasks;}
82 TObjArray *GetTopTasks() const {return fTopTasks;}
c52c2132 83 TTree *GetTree() const {return fTree;}
d3106602 84 TObjArray *GetZombieTasks() const {return fZombies;}
c52c2132 85 Long64_t GetCurrentEntry() const {return fCurrentEntry;}
86 EAliAnalysisExecMode
87 GetAnalysisType() const {return fMode;}
d86ed856 88 Bool_t IsUsingDataSet() const {return TObject::TestBit(kUseDataSet);}
c52c2132 89
90 void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
91 void SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
92 void SetDebugLevel(UInt_t level) {fDebug = level;}
13ef3bb0 93 void SetSpecialOutputLocation(const char *location) {fSpecialOutputLocation = location;}
b1310ef5 94 void SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);}
8c0ab8e8 95 void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;}
60a04972 96 void SetInputEventHandler(AliVEventHandler* handler);
97 void SetOutputEventHandler(AliVEventHandler* handler);
d2f1d9ef 98 void SetMCtruthEventHandler(AliVEventHandler* handler) {fMCtruthEventHandler = handler;}
c57f56b7 99 void SetGridHandler(AliAnalysisGrid *handler) {fGridHandler = handler;}
c2922515 100 void SetEventPool(AliVEventPool* epool) {fEventPool = epool;}
8c0ab8e8 101 void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
8d7d3b59 102 void SetSelector(AliAnalysisSelector *sel) {fSelector = sel;}
54cff064 103 AliVEventHandler* GetInputEventHandler() {return fInputEventHandler;}
d2f1d9ef 104 AliVEventHandler* GetOutputEventHandler() {return fOutputEventHandler;}
105 AliVEventHandler* GetMCtruthEventHandler() {return fMCtruthEventHandler;}
60a04972 106 AliAnalysisDataContainer *GetCommonInputContainer() {return fCommonInput;}
107 AliAnalysisDataContainer *GetCommonOutputContainer() {return fCommonOutput;}
c57f56b7 108 AliAnalysisGrid* GetGridHandler() {return fGridHandler;}
c2922515 109 AliVEventPool* GetEventPool() {return fEventPool;}
d3106602 110
111 // Container handling
112 AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype,
c52c2132 113 EAliAnalysisContType type = kExchangeContainer,
114 const char *filename = NULL);
d3106602 115
116 // Including tasks and getting them
117 void AddTask(AliAnalysisTask *task);
118 AliAnalysisTask *GetTask(const char *name) const;
119
120 // Connecting data containers to task inputs/outputs
121 Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot,
122 AliAnalysisDataContainer *cont);
123 Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot,
124 AliAnalysisDataContainer *cont);
125 // Garbage collection
126 void CleanContainers();
127
128 // Analysis initialization and execution, status
129 Bool_t InitAnalysis();
130 Bool_t IsInitialized() const {return fInitOK;}
efd53803 131 Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);}
d3106602 132 void ResetAnalysis();
133 void ExecAnalysis(Option_t *option="");
134 void FinishAnalysis();
135 void PrintStatus(Option_t *option="all") const;
136
137protected:
981f2614 138 void ImportWrappers(TList *source);
efd53803 139 void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
d3106602 140
5daf9fd2 141private:
6bb2b24f 142 TTree *fTree; //! Input tree in case of TSelector model
54cff064 143 AliVEventHandler *fInputEventHandler; // Optional common input event handler
d2f1d9ef 144 AliVEventHandler *fOutputEventHandler; // Optional common output event handler
145 AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler
c2922515 146 AliVEventPool *fEventPool; // Event pool for mixing analysis
6bb2b24f 147 Long64_t fCurrentEntry; //! Current processed entry in the tree
8c0ab8e8 148 Long64_t fNSysInfo; // Event frequency for collecting system information
6bb2b24f 149 EAliAnalysisExecMode fMode; // Execution mode
150 Bool_t fInitOK; // Initialisation done
151 UInt_t fDebug; // Debug level
13ef3bb0 152 TString fSpecialOutputLocation; // URL/path where the special outputs will be copied
6bb2b24f 153 TObjArray *fTasks; // List of analysis tasks
154 TObjArray *fTopTasks; // List of top tasks
155 TObjArray *fZombies; // List of zombie tasks
156 TObjArray *fContainers; // List of all containers
157 TObjArray *fInputs; // List of containers with input data
158 TObjArray *fOutputs; // List of containers with results
60a04972 159 AliAnalysisDataContainer *fCommonInput; // Common input container
160 AliAnalysisDataContainer *fCommonOutput; // Common output container
8d7d3b59 161 AliAnalysisSelector *fSelector; //! Current selector
c57f56b7 162 AliAnalysisGrid *fGridHandler; //! Grid handler plugin
5daf9fd2 163
c52c2132 164 static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
60a04972 165 ClassDef(AliAnalysisManager,4) // Analysis manager class
d3106602 166};
167#endif