[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 TStopwatch;
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),
   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);
   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 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;                    
   static const char  *GetCommonFileName()        {return fgCommonFileName.Data();}
   AliAnalysisDataContainer *
                       GetCommonInputContainer()  {return fCommonInput;}
   AliAnalysisDataContainer *
                       GetCommonOutputContainer() {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()             {return fEventPool;}
   Bool_t              GetFileFromWrapper(const char *filename, TList *source);
   AliAnalysisGrid*    GetGridHandler()           {return fGridHandler;}
   TObjArray          *GetInputs() const          {return fInputs;}
   AliVEventHandler*   GetInputEventHandler()     {return fInputEventHandler;}
   AliVEventHandler*   GetMCtruthEventHandler()   {return fMCtruthEventHandler;}
   AliVEventHandler*   GetOutputEventHandler()    {return fOutputEventHandler;}
   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;}
   Bool_t              IsUsingDataSet() const     {return TObject::TestBit(kUseDataSet);}
   void                SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
   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* epool)         {fEventPool = epool;}
   void                SetGridHandler(AliAnalysisGrid *handler)   {fGridHandler = handler;}
   void                SetInputEventHandler(AliVEventHandler*  handler);
   void                SetMCtruthEventHandler(AliVEventHandler* handler) {fMCtruthEventHandler = handler;}
   void                SetNSysInfo(Long64_t nevents)              {fNSysInfo = nevents;}
   void                SetOutputEventHandler(AliVEventHandler*  handler);
   void                SetSelector(AliAnalysisSelector *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                 FinishAnalysis();
   void                 PrintStatus(Option_t *option="all") const;
   static void          ProgressBar(const char *opname, Long64_t current, Long64_t size, TStopwatch *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);}

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