Removing lines from the readme file
[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;
d3106602 22class AliAnalysisDataContainer;
23class AliAnalysisTask;
d2f1d9ef 24class AliVEventHandler;
8c9485b2 25
d3106602 26
c52c2132 27class AliAnalysisManager : public TNamed {
d3106602 28
29public:
30
31enum EAliAnalysisContType {
c52c2132 32 kExchangeContainer = 0,
d3106602 33 kInputContainer = 1,
34 kOutputContainer = 2
35};
c52c2132 36
37enum EAliAnalysisExecMode {
38 kLocalAnalysis = 0,
39 kProofAnalysis = 1,
40 kGridAnalysis = 2
41};
42
efd53803 43enum EAliAnalysisFlags {
b1310ef5 44 kEventLoop = BIT(14),
45 kDisableBranches = BIT(15)
efd53803 46};
47
6e14aaa2 48 AliAnalysisManager(const char *name = "mgr", const char *title="");
d3106602 49 virtual ~AliAnalysisManager();
c52c2132 50
51 AliAnalysisManager(const AliAnalysisManager& other);
52 AliAnalysisManager& operator=(const AliAnalysisManager& other);
d3106602 53
8c0ab8e8 54 // Management
55 void StartAnalysis(const char *type="local", TTree *tree=0, Long64_t nentries=1234567890, Long64_t firstentry=0);
c52c2132 56
d3106602 57 virtual void Init(TTree *tree);
327eaf46 58 virtual Bool_t Notify();
d3106602 59 virtual void SlaveBegin(TTree *tree);
327eaf46 60 virtual Bool_t ProcessCut(Long64_t entry) {return Process(entry);}
d3106602 61 virtual Bool_t Process(Long64_t entry);
327eaf46 62 virtual Int_t GetEntry(Long64_t entry, Int_t getall = 0);
c52c2132 63 void PackOutput(TList *target);
64 void UnpackOutput(TList *source);
d3106602 65 virtual void Terminate();
66
c52c2132 67 // Getters/Setters
68 static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
d3106602 69 TObjArray *GetContainers() const {return fContainers;}
c52c2132 70 UInt_t GetDebugLevel() const {return fDebug;}
d3106602 71 TObjArray *GetInputs() const {return fInputs;}
72 TObjArray *GetOutputs() const {return fOutputs;}
73 TObjArray *GetTasks() const {return fTasks;}
74 TObjArray *GetTopTasks() const {return fTopTasks;}
c52c2132 75 TTree *GetTree() const {return fTree;}
d3106602 76 TObjArray *GetZombieTasks() const {return fZombies;}
c52c2132 77 Long64_t GetCurrentEntry() const {return fCurrentEntry;}
78 EAliAnalysisExecMode
79 GetAnalysisType() const {return fMode;}
80
81 void SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
82 void SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
83 void SetDebugLevel(UInt_t level) {fDebug = level;}
b1310ef5 84 void SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);}
8c0ab8e8 85 void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;}
54cff064 86 void SetInputEventHandler(AliVEventHandler* handler) {fInputEventHandler = handler;}
d2f1d9ef 87 void SetOutputEventHandler(AliVEventHandler* handler) {fOutputEventHandler = handler;}
88 void SetMCtruthEventHandler(AliVEventHandler* handler) {fMCtruthEventHandler = handler;}
8c0ab8e8 89 void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
54cff064 90 AliVEventHandler* GetInputEventHandler() {return fInputEventHandler;}
d2f1d9ef 91 AliVEventHandler* GetOutputEventHandler() {return fOutputEventHandler;}
92 AliVEventHandler* GetMCtruthEventHandler() {return fMCtruthEventHandler;}
d3106602 93
94 // Container handling
95 AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype,
c52c2132 96 EAliAnalysisContType type = kExchangeContainer,
97 const char *filename = NULL);
d3106602 98
99 // Including tasks and getting them
100 void AddTask(AliAnalysisTask *task);
101 AliAnalysisTask *GetTask(const char *name) const;
102
103 // Connecting data containers to task inputs/outputs
104 Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot,
105 AliAnalysisDataContainer *cont);
106 Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot,
107 AliAnalysisDataContainer *cont);
108 // Garbage collection
109 void CleanContainers();
110
111 // Analysis initialization and execution, status
112 Bool_t InitAnalysis();
113 Bool_t IsInitialized() const {return fInitOK;}
efd53803 114 Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);}
d3106602 115 void ResetAnalysis();
116 void ExecAnalysis(Option_t *option="");
117 void FinishAnalysis();
118 void PrintStatus(Option_t *option="all") const;
119
120protected:
981f2614 121 void ImportWrappers(TList *source);
efd53803 122 void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
d3106602 123
5daf9fd2 124private:
6bb2b24f 125 TTree *fTree; //! Input tree in case of TSelector model
54cff064 126 AliVEventHandler *fInputEventHandler; // Optional common input event handler
d2f1d9ef 127 AliVEventHandler *fOutputEventHandler; // Optional common output event handler
128 AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler
6bb2b24f 129 Long64_t fCurrentEntry; //! Current processed entry in the tree
8c0ab8e8 130 Long64_t fNSysInfo; // Event frequency for collecting system information
6bb2b24f 131 EAliAnalysisExecMode fMode; // Execution mode
132 Bool_t fInitOK; // Initialisation done
133 UInt_t fDebug; // Debug level
134 TObjArray *fTasks; // List of analysis tasks
135 TObjArray *fTopTasks; // List of top tasks
136 TObjArray *fZombies; // List of zombie tasks
137 TObjArray *fContainers; // List of all containers
138 TObjArray *fInputs; // List of containers with input data
139 TObjArray *fOutputs; // List of containers with results
5daf9fd2 140
c52c2132 141 static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
8c0ab8e8 142 ClassDef(AliAnalysisManager,2) // Analysis manager class
d3106602 143};
144#endif