[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 TFile;
class AliAnalysisSelector;
class AliAnalysisDataContainer;
class AliAnalysisTask;
class AliVEventHandler;
class AliVEventPool;
class AliAnalysisGrid;


class AliAnalysisManager : public TNamed {

public:

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

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

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

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

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

   virtual Bool_t      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);
   TFile              *OpenProofFile(AliAnalysisDataContainer *cont, const char *option);
   static TFile       *OpenFile(AliAnalysisDataContainer *cont, const char *option, Bool_t ignoreProof=kFALSE);
   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                GetAnalysisTypeString(TString &type) const;                    
   Bool_t              IsUsingDataSet() const  {return TObject::TestBit(kUseDataSet);}

   void                RegisterExtraFile(const char *fname);
   void                SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
   void                SetCurrentEntry(Long64_t entry) {fCurrentEntry = entry;}
   static void         SetCommonFileName(const char *name) {fgCommonFileName = name;}
   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);
   void                SetOutputEventHandler(AliVEventHandler*  handler);
   void                SetMCtruthEventHandler(AliVEventHandler* handler) {fMCtruthEventHandler = handler;}
   void                SetGridHandler(AliAnalysisGrid *handler) {fGridHandler = handler;}
   void                SetEventPool(AliVEventPool* epool) {fEventPool = epool;}
   void                SetNSysInfo(Long64_t nevents) {fNSysInfo = nevents;}
   void                SetSelector(AliAnalysisSelector *sel) {fSelector = sel;}
   AliVEventHandler*   GetInputEventHandler()   {return fInputEventHandler;}
   AliVEventHandler*   GetOutputEventHandler()  {return fOutputEventHandler;}
   AliVEventHandler*   GetMCtruthEventHandler() {return fMCtruthEventHandler;}
   static const char  *GetCommonFileName()      {return fgCommonFileName.Data();}
   AliAnalysisDataContainer *GetCommonInputContainer() {return fCommonInput;}
   AliAnalysisDataContainer *GetCommonOutputContainer() {return fCommonOutput;}
   AliAnalysisGrid*    GetGridHandler()         {return fGridHandler;}
   AliVEventPool*      GetEventPool()           {return fEventPool;}
   Bool_t              GetFileFromWrapper(const char *filename, TList *source);
   TString             GetExtraFiles() const {return fExtraFiles;}

   // 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;
   Bool_t               ValidateOutputFiles() 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
   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
   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
   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

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