[u/mrichter/AliRoot.git] / ANALYSIS / AliAnalysisManager.h

#ifndef ALIANALYSISMANAGER_H
#define ALIANALYSISMANAGER_H
/* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 * See cxx source for full Copyright notice                               */

/* $Id$ */
// Author: Andrei Gheata, 31/05/2006

//==============================================================================
//   AliAnalysysManager - Manager analysis class. Allows creation of several
// analysis tasks and data containers storing their input/output. Allows 
// connecting/chaining tasks via shared data containers. Serializes the current
// event for all tasks depending only on initial input data.
//==============================================================================

#ifndef ROOT_TNamed
#include <TNamed.h>
#endif
#ifndef ROOT_THashTable
#include <THashTable.h>
#endif

class TClass;
class TTree;
class TFile;
class TStopwatch;
class AliAnalysisSelector;
class AliAnalysisDataContainer;
class AliAnalysisTask;
class AliVEventHandler;
class AliVEventPool;
class AliAnalysisGrid;


class AliAnalysisManager : public TNamed {

public:

enum EAliAnalysisContType {
   kExchangeContainer  = 0,   // use to exchange data between tasks
   kInputContainer     = 1,   // use for the task private input data
   kOutputContainer    = 2,   // use for the task private output data
   kParamContainer     = 3    // use for storing task private parameters/cuts per analysis session
};   

enum EAliAnalysisExecMode {
   kLocalAnalysis    = 0,
   kProofAnalysis    = 1,
   kGridAnalysis     = 2,
   kMixingAnalysis   = 3
};

enum EAliAnalysisFlags {
   kEventLoop        = BIT(14),
   kDisableBranches  = BIT(15),
   kUseDataSet       = BIT(16),
   kSaveCanvases     = BIT(17),
   kExternalLoop     = BIT(18),
   kSkipTerminate    = BIT(19)
};   

   AliAnalysisManager(const char *name = "mgr", const char *title="");
   virtual            ~AliAnalysisManager();

   AliAnalysisManager(const AliAnalysisManager& other);
   AliAnalysisManager& operator=(const AliAnalysisManager& other);
   
   // Event loop control
   virtual Int_t       GetEntry(Long64_t entry, Int_t getall = 0);
   virtual Bool_t      Init(TTree *tree);   
   virtual Bool_t      Notify();
   virtual Bool_t      ProcessCut(Long64_t entry) {return Process(entry);}
   virtual Bool_t      Process(Long64_t entry);
   TFile              *OpenProofFile(AliAnalysisDataContainer *cont, const char *option);
   static TFile       *OpenFile(AliAnalysisDataContainer *cont, const char *option, Bool_t ignoreProof=kFALSE);
   void                PackOutput(TList *target);
   void                RegisterExtraFile(const char *fname);
   Long64_t            StartAnalysis(const char *type="local", TTree * const tree=0, Long64_t nentries=1234567890, Long64_t firstentry=0);
   Long64_t            StartAnalysis(const char *type, const char *dataset, Long64_t nentries=1234567890, Long64_t firstentry=0);
   virtual void        SlaveBegin(TTree *tree);
   virtual void        Terminate();
   void                UnpackOutput(TList *source);

   // Getters/Setters
   static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
   EAliAnalysisExecMode 
                       GetAnalysisType() const    {return fMode;}
   void                GetAnalysisTypeString(TString &type) const;                    
   Bool_t              GetAutoBranchLoading() const {return fAutoBranchHandling;} 
   static const char  *GetCommonFileName()        {return fgCommonFileName.Data();}
   AliAnalysisDataContainer *
                       GetCommonInputContainer() const  {return fCommonInput;}
   AliAnalysisDataContainer *
                       GetCommonOutputContainer() const {return fCommonOutput;}
   TObjArray          *GetContainers() const      {return fContainers;}
   Long64_t            GetCurrentEntry() const    {return fCurrentEntry;}
   UInt_t              GetDebugLevel() const      {return fDebug;}
   TString             GetExtraFiles() const      {return fExtraFiles;}
   AliVEventPool*      GetEventPool()  const      {return fEventPool;}
   Bool_t              GetFileFromWrapper(const char *filename, const TList *source);
   AliAnalysisGrid*    GetGridHandler()           {return fGridHandler;}
   TObjArray          *GetInputs() const          {return fInputs;}
   AliVEventHandler*   GetInputEventHandler() const   {return fInputEventHandler;}
   AliVEventHandler*   GetMCtruthEventHandler() const {return fMCtruthEventHandler;}
   AliVEventHandler*   GetOutputEventHandler() const  {return fOutputEventHandler;}
   TObjArray          *GetOutputs() const         {return fOutputs;}
   TObjArray          *GetParamOutputs() const    {return fParamCont;}
   TObjArray          *GetTasks() const           {return fTasks;}
   TObjArray          *GetTopTasks() const        {return fTopTasks;}
   TTree              *GetTree() const            {return fTree;}
   TObjArray          *GetZombieTasks() const     {return fZombies;}
   Bool_t              IsRemote() const           {return fIsRemote;}
   Bool_t              IsUsingDataSet() const     {return TObject::TestBit(kUseDataSet);}
   void                LoadBranch(const char *n)  { if(fAutoBranchHandling) return; DoLoadBranch(n); }
   void                SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
   void                SetAutoBranchLoading(Bool_t b) { fAutoBranchHandling = b; }
   void                SetCurrentEntry(Long64_t entry)            {fCurrentEntry = entry;}
   void                SetCollectSysInfoEach(Int_t nevents=0)     {fNSysInfo = nevents;}
   static void         SetCommonFileName(const char *name)        {fgCommonFileName = name;}
   void                SetDebugLevel(UInt_t level)                {fDebug = level;}
   void                SetDisableBranches(Bool_t disable=kTRUE)   {TObject::SetBit(kDisableBranches,disable);}
   void                SetExternalLoop(Bool_t flag)               {TObject::SetBit(kExternalLoop,flag);}
   void                SetEventPool(AliVEventPool* const epool)   {fEventPool = epool;}
   void                SetGridHandler(AliAnalysisGrid * const handler) {fGridHandler = handler;}
   void                SetInputEventHandler(AliVEventHandler* const handler);
   void                SetMCtruthEventHandler(AliVEventHandler* const handler) {fMCtruthEventHandler = handler;}
   void                SetNSysInfo(Long64_t nevents)              {fNSysInfo = nevents;}
   void                SetOutputEventHandler(AliVEventHandler* const handler);
   void                SetSelector(AliAnalysisSelector * const sel)      {fSelector = sel;}
   void                SetSaveCanvases(Bool_t flag=kTRUE)         {TObject::SetBit(kSaveCanvases,flag);}
   void                SetSkipTerminate(Bool_t flag)              {TObject::SetBit(kSkipTerminate,flag);}
   void                SetSpecialOutputLocation(const char *loc)  {fSpecialOutputLocation = loc;}

   // Container handling
   AliAnalysisDataContainer *CreateContainer(const char *name, TClass *datatype, 
                       EAliAnalysisContType type     = kExchangeContainer, 
                       const char          *filename = NULL);
   
   // Including tasks and getting them
   void                 AddTask(AliAnalysisTask *task);
   AliAnalysisTask     *GetTask(const char *name) const;
   
   // Connecting data containers to task inputs/outputs
   Bool_t               ConnectInput(AliAnalysisTask *task, Int_t islot,
                                     AliAnalysisDataContainer *cont);
   Bool_t               ConnectOutput(AliAnalysisTask *task, Int_t islot,
                                     AliAnalysisDataContainer *cont);
   // Garbage collection
   void                 CleanContainers();
   
   // Analysis initialization and execution, status
   Bool_t               InitAnalysis();
   Bool_t               IsInitialized() const {return fInitOK;}
   Bool_t               IsExternalLoop() const {return TObject::TestBit(kExternalLoop);}
   Bool_t               IsEventLoop() const {return TObject::TestBit(kEventLoop);}
   Bool_t               IsSkipTerminate() const {return TObject::TestBit(kSkipTerminate);}
   void                 ResetAnalysis();
   void                 ExecAnalysis(Option_t *option="");
   void                 PrintStatus(Option_t *option="all") const;
   void                 ProfileTask(const char *name, const char *option="VM") const;
   void                 ProfileTask(Int_t itop, const char *option="VM") const;
   static void          ProgressBar(const char *opname, Long64_t current, Long64_t size, TStopwatch * const watch=0, Bool_t last=kFALSE, Bool_t refresh=kFALSE);
   Bool_t               ValidateOutputFiles() const;

protected:
   void                 ImportWrappers(TList *source);
   void                 SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
   void                 DoLoadBranch(const char *name);

private:
   TTree                  *fTree;                //! Input tree in case of TSelector model
   AliVEventHandler       *fInputEventHandler;   //  Optional common input  event handler
   AliVEventHandler       *fOutputEventHandler;  //  Optional common output event handler
   AliVEventHandler       *fMCtruthEventHandler; //  Optional common MC Truth event handler
   AliVEventPool          *fEventPool;           //  Event pool for mixing analysis
   Long64_t                fCurrentEntry;        //! Current processed entry in the tree
   Long64_t                fNSysInfo;            // Event frequency for collecting system information
   EAliAnalysisExecMode    fMode;                // Execution mode
   Bool_t                  fInitOK;              // Initialisation done
   Bool_t                  fIsRemote;            //! Flag is set for remote analysis
   UInt_t                  fDebug;               // Debug level
   TString                 fSpecialOutputLocation; // URL/path where the special outputs will be copied
   TObjArray              *fTasks;               // List of analysis tasks
   TObjArray              *fTopTasks;            // List of top tasks
   TObjArray              *fZombies;             // List of zombie tasks
   TObjArray              *fContainers;          // List of all containers
   TObjArray              *fInputs;              // List of containers with input data
   TObjArray              *fOutputs;             // List of containers with results
   TObjArray              *fParamCont;           // List of containers with results
   AliAnalysisDataContainer *fCommonInput;       // Common input container
   AliAnalysisDataContainer *fCommonOutput;      // Common output container
   AliAnalysisSelector    *fSelector;            //! Current selector
   AliAnalysisGrid        *fGridHandler;         //! Grid handler plugin
   TString                 fExtraFiles;          // List of extra files to be merged
   Bool_t                  fAutoBranchHandling;  // def=kTRUE, turn off if you use LoadBranch
   THashTable              fTable;               // keep branch ptrs in case of manual branch loading

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