[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

class TClass;
class TTree;
class AliAnalysisDataContainer;
class AliAnalysisTask;
class AliVEventHandler;


class AliAnalysisManager : public TNamed {

public:

enum EAliAnalysisContType {
   kExchangeContainer  = 0,
   kInputContainer   = 1,
   kOutputContainer  = 2
};   

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

enum EAliAnalysisFlags {
   kEventLoop        = BIT(14),
   kDisableBranches  = BIT(15)
};   

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

   AliAnalysisManager(const AliAnalysisManager& other);
   AliAnalysisManager& operator=(const AliAnalysisManager& other);
   
   // Management
   void                StartAnalysis(const char *type="local", TTree *tree=0, Long64_t nentries=1234567890, Long64_t firstentry=0);

   virtual void        Init(TTree *tree);   
   virtual Bool_t      Notify();
   virtual void        SlaveBegin(TTree *tree);
   virtual Bool_t      ProcessCut(Long64_t entry) {return Process(entry);}
   virtual Bool_t      Process(Long64_t entry);
   virtual Int_t       GetEntry(Long64_t entry, Int_t getall = 0);
   void                PackOutput(TList *target);
   void                UnpackOutput(TList *source);
   virtual void        Terminate();

   // Getters/Setters
   static AliAnalysisManager *GetAnalysisManager() {return fgAnalysisManager;}
   TObjArray          *GetContainers() const {return fContainers;}
   UInt_t              GetDebugLevel() const {return fDebug;}
   TObjArray          *GetInputs() const     {return fInputs;}
   TObjArray          *GetOutputs() const    {return fOutputs;}
   TObjArray          *GetTasks() const      {return fTasks;}
   TObjArray          *GetTopTasks() const   {return fTopTasks;}
   TTree              *GetTree() const       {return fTree;}
   TObjArray          *GetZombieTasks() const {return fZombies;}
   Long64_t            GetCurrentEntry() const {return fCurrentEntry;}
   EAliAnalysisExecMode 
                       GetAnalysisType() const {return fMode;}

   void                SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
   void                SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
   void                SetDebugLevel(UInt_t level) {fDebug = level;}
   void                SetSpecialOutputLocation(const char *location) {fSpecialOutputLocation = location;}
   void                SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);}
   void                SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;}
   void                SetInputEventHandler(AliVEventHandler*  handler)  {fInputEventHandler   = handler;}
   void                SetOutputEventHandler(AliVEventHandler*  handler) {fOutputEventHandler  = handler;}
   void                SetMCtruthEventHandler(AliVEventHandler* handler) {fMCtruthEventHandler = handler;}
   void                SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
   AliVEventHandler*   GetInputEventHandler()   {return fInputEventHandler;}
   AliVEventHandler*   GetOutputEventHandler()  {return fOutputEventHandler;}
   AliVEventHandler*   GetMCtruthEventHandler() {return fMCtruthEventHandler;}

   // 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               IsEventLoop() const {return TObject::TestBit(kEventLoop);}
   void                 ResetAnalysis();
   void                 ExecAnalysis(Option_t *option="");
   void                 FinishAnalysis();
   void                 PrintStatus(Option_t *option="all") const;

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

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
   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
   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

   static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
   ClassDef(AliAnalysisManager,3)  // 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
	19
	20	class TClass;
c52c2132	21	class TTree;
d3106602	22	class AliAnalysisDataContainer;
d3106602	23	class AliAnalysisTask;
d2f1d9ef	24	class AliVEventHandler;
8c9485b2	25
d3106602	26
c52c2132	27	class AliAnalysisManager : public TNamed {
d3106602	28
	29	public:
	30
	31	enum EAliAnalysisContType {
c52c2132	32	kExchangeContainer = 0,
d3106602	33	kInputContainer = 1,
	34	kOutputContainer = 2
	35	};
c52c2132	36
	37	enum EAliAnalysisExecMode {
	38	kLocalAnalysis = 0,
	39	kProofAnalysis = 1,
	40	kGridAnalysis = 2
	41	};
	42
efd53803	43	enum EAliAnalysisFlags {
b1310ef5	44	kEventLoop = BIT(14),
b1310ef5	45	kDisableBranches = BIT(15)
efd53803	46	};
efd53803	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
8c0ab8e8	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);
c52c2132	64	void UnpackOutput(TList *source);
d3106602	65	virtual void Terminate();
d3106602	66
c52c2132	67	// Getters/Setters
c52c2132	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;}
13ef3bb0	84	void SetSpecialOutputLocation(const char *location) {fSpecialOutputLocation = location;}
b1310ef5	85	void SetDisableBranches(Bool_t disable=kTRUE) {TObject::SetBit(kDisableBranches,disable);}
8c0ab8e8	86	void SetCollectSysInfoEach(Int_t nevents=0) {fNSysInfo = nevents;}
54cff064	87	void SetInputEventHandler(AliVEventHandler* handler) {fInputEventHandler = handler;}
d2f1d9ef	88	void SetOutputEventHandler(AliVEventHandler* handler) {fOutputEventHandler = handler;}
d2f1d9ef	89	void SetMCtruthEventHandler(AliVEventHandler* handler) {fMCtruthEventHandler = handler;}
8c0ab8e8	90	void SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
54cff064	91	AliVEventHandler* GetInputEventHandler() {return fInputEventHandler;}
d2f1d9ef	92	AliVEventHandler* GetOutputEventHandler() {return fOutputEventHandler;}
d2f1d9ef	93	AliVEventHandler* GetMCtruthEventHandler() {return fMCtruthEventHandler;}
d3106602	94
	95	// Container handling
	96	AliAnalysisDataContainer CreateContainer(const char name, TClass *datatype,
c52c2132	97	EAliAnalysisContType type = kExchangeContainer,
c52c2132	98	const char *filename = NULL);
d3106602	99
	100	// Including tasks and getting them
	101	void AddTask(AliAnalysisTask *task);
	102	AliAnalysisTask GetTask(const char name) const;
	103
	104	// Connecting data containers to task inputs/outputs
	105	Bool_t ConnectInput(AliAnalysisTask *task, Int_t islot,
	106	AliAnalysisDataContainer *cont);
	107	Bool_t ConnectOutput(AliAnalysisTask *task, Int_t islot,
	108	AliAnalysisDataContainer *cont);
	109	// Garbage collection
	110	void CleanContainers();
	111
	112	// Analysis initialization and execution, status
	113	Bool_t InitAnalysis();
	114	Bool_t IsInitialized() const {return fInitOK;}
efd53803	115	Bool_t IsEventLoop() const {return TObject::TestBit(kEventLoop);}
d3106602	116	void ResetAnalysis();
	117	void ExecAnalysis(Option_t *option="");
	118	void FinishAnalysis();
	119	void PrintStatus(Option_t *option="all") const;
	120
	121	protected:
981f2614	122	void ImportWrappers(TList *source);
efd53803	123	void SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
d3106602	124
5daf9fd2	125	private:
6bb2b24f	126	TTree *fTree; //! Input tree in case of TSelector model
54cff064	127	AliVEventHandler *fInputEventHandler; // Optional common input event handler
d2f1d9ef	128	AliVEventHandler *fOutputEventHandler; // Optional common output event handler
d2f1d9ef	129	AliVEventHandler *fMCtruthEventHandler; // Optional common MC Truth event handler
6bb2b24f	130	Long64_t fCurrentEntry; //! Current processed entry in the tree
8c0ab8e8	131	Long64_t fNSysInfo; // Event frequency for collecting system information
6bb2b24f	132	EAliAnalysisExecMode fMode; // Execution mode
	133	Bool_t fInitOK; // Initialisation done
	134	UInt_t fDebug; // Debug level
13ef3bb0	135	TString fSpecialOutputLocation; // URL/path where the special outputs will be copied
6bb2b24f	136	TObjArray *fTasks; // List of analysis tasks
	137	TObjArray *fTopTasks; // List of top tasks
	138	TObjArray *fZombies; // List of zombie tasks
	139	TObjArray *fContainers; // List of all containers
	140	TObjArray *fInputs; // List of containers with input data
	141	TObjArray *fOutputs; // List of containers with results
5daf9fd2	142
c52c2132	143	static AliAnalysisManager *fgAnalysisManager; //! static pointer to object instance
13ef3bb0	144	ClassDef(AliAnalysisManager,3) // Analysis manager class
d3106602	145	};
d3106602	146	#endif