AliAnalysisManager.h

Go to the documentation of this file.

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


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

class TClass;
class TTree;
class TFile;
class TFileCollection;
class TStopwatch;
class TMap;
class AliAnalysisSelector;
class AliAnalysisDataContainer;
class AliAnalysisFileDescriptor;
class AliAnalysisTask;
class AliVEventHandler;
class AliVEventPool;
class AliAnalysisGrid;
class AliAnalysisStatistics;
class AliVfriendEvent;
class AliVEvent;

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),
   kUseProgressBar   = BIT(20),
   kTrueNotify       = BIT(21),
   kTasksInitialized = BIT(22),
   kCollectThroughput= BIT(23)
};

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

   AliAnalysisManager(const AliAnalysisManager& other);
   AliAnalysisManager& operator=(const AliAnalysisManager& other);
   
   // Event loop control
   Bool_t              EventLoop(Long64_t nevents);
   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, const char *extaod="");
   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, TTree * const tree, 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);
   Long64_t            StartAnalysis(const char *type, TFileCollection* dataset, Long64_t nentries=1234567890, Long64_t firstentry=0);
   Long64_t            StartAnalysis(const char *type, 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;}
   static Int_t        LoadMacro(const char *filename, Int_t *error = 0, Bool_t check = kFALSE);
   EAliAnalysisExecMode 
                       GetAnalysisType() const    {return fMode;}
   void                GetAnalysisTypeString(TString &type) const;                    
   Bool_t              GetAutoBranchLoading() const {return fAutoBranchHandling;} 
   Long64_t            GetCacheSize() const       {return fCacheSize;}
   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;}
   Bool_t              GetAsyncReading() const {return fAsyncReading;}
   TString             GetExtraFiles() const      {return fExtraFiles;}
   AliVEventPool*      GetEventPool()  const      {return fEventPool;}
   Bool_t              GetFileFromWrapper(const char *filename, const TList *source);
   const char         *GetFileInfoLog() const     {return fFileInfoLog.Data();}
   static Int_t        GetRunFromAlienPath(const char *path);
   AliAnalysisGrid*    GetGridHandler()           {return fGridHandler;}
   TObjArray          *GetInputs() const          {return fInputs;}
   AliVEventHandler*   GetInputEventHandler() const   {return fInputEventHandler;}
   AliVEventHandler*   GetMCtruthEventHandler() const {return fMCtruthEventHandler;}
   Int_t               GetNsysInfo() const        {return fNSysInfo;}
   AliVEventHandler*   GetOutputEventHandler() const  {return fOutputEventHandler;}
   TObjArray          *GetOutputs() const         {return fOutputs;}
   TObjArray          *GetParamOutputs() const    {return fParamCont;}
   TObjArray          *GetExchangeContainers() const {return fExchangeCont;}
   Int_t               GetRunFromPath() const     {return fRunFromPath;}
   const char         *GetRequestedBranches() const {return fRequestedBranches.Data();}
   TObjArray          *GetTasks() const           {return fTasks;}
   TObjArray          *GetTopTasks() const        {return fTopTasks;}
   TTree              *GetTree() const            {return fTree;}
   TObjArray          *GetZombieTasks() const     {return fZombies;}
   static const char  *GetGlobalStr(const char *key, Bool_t &valid);
   static Int_t        GetGlobalInt(const char *key, Bool_t &valid);
   static Double_t     GetGlobalDbl(const char *key, Bool_t &valid);
   TMap               *GetGlobals()               {return fGlobals;}
   static Bool_t       IsMacroLoaded(const char * filename);
   Bool_t              IsMCLoop() const           {return fMCLoop;}
   static Bool_t       IsPipe(std::ostream &out);
   Bool_t              IsProofMode() const        {return (fMode==kProofAnalysis)?kTRUE:kFALSE;}
   Bool_t              IsRemote() const           {return fIsRemote;}
   Bool_t              IsCollectThroughput()      {return TObject::TestBit(kCollectThroughput);}
   Bool_t              IsUsingDataSet() const     {return TObject::TestBit(kUseDataSet);}
   void                LoadBranch(const char *n)  { if(fAutoBranchHandling) return; DoLoadBranch(n); }
   void                RunLocalInit();
   void                SetAnalysisType(EAliAnalysisExecMode mode) {fMode = mode;}
   void                SetAutoBranchLoading(Bool_t b) { fAutoBranchHandling = b; }
   void                SetCurrentEntry(Long64_t entry)            {fCurrentEntry = entry;}
   void                SetCacheSize(Long64_t size)                {fCacheSize = size;}
   void                SetCollectSysInfoEach(Int_t nevents=0)     {fNSysInfo = nevents;}
   void                SetCollectThroughput(Bool_t flag)          {Changed(); TObject::SetBit(kCollectThroughput,flag);}
   static void         SetCommonFileName(const char *name)        {fgCommonFileName = name;}
   void                SetDebugLevel(UInt_t level);
   void                SetDisableBranches(Bool_t disable=kTRUE)   {Changed(); TObject::SetBit(kDisableBranches,disable);}
   void                SetAsyncReading(Bool_t flag=kTRUE)    {fAsyncReading = flag;}
   void                SetExternalLoop(Bool_t flag)               {Changed(); TObject::SetBit(kExternalLoop,flag);}
   void                SetMCLoop(Bool_t flag=kTRUE)               {fMCLoop = flag;}
   void                SetEventPool(AliVEventPool* const epool)   {Changed(); fEventPool = epool;}
   void                SetFileInfoLog(const char *name) {TObject::SetBit(kCollectThroughput,kTRUE); fFileInfoLog = name;}
   void                SetGridHandler(AliAnalysisGrid * const handler) {Changed(); fGridHandler = handler;}
   void                SetInputEventHandler(AliVEventHandler* const handler);
   void                SetMCtruthEventHandler(AliVEventHandler* const handler) {Changed(); fMCtruthEventHandler = handler;}
   void                SetNSysInfo(Long64_t nevents)              {fNSysInfo = nevents;}
   void                SetOutputEventHandler(AliVEventHandler* const handler);
   void                SetRunFromPath(Int_t run)                  {fRunFromPath = run;}
   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                SetUseProgressBar(Bool_t flag, Int_t freq=1);
   void                SetSpecialOutputLocation(const char *loc)  {fSpecialOutputLocation = loc;}
   static void         SetGlobalStr(const char *key, const char *value);
   static void         SetGlobalInt(const char *key, Int_t value);
   static void         SetGlobalDbl(const char *key, Double_t value);
   

   // 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;
   Int_t                GetTaskIndex(const AliAnalysisTask *task) 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
   void                 AddBranches(const char *branches);
   void                 AddStatisticsTask(UInt_t offlineMask=0);
   void                 CheckBranches(Bool_t load=kFALSE);
   Bool_t               CheckTasks() const;
   void                 CountEvent(Int_t ninput, Int_t nprocessed, Int_t nfailed, Int_t naccepted);
   Bool_t               InitAnalysis();
   Bool_t               IsInitialized() const {return fInitOK;}
   Bool_t               IsTrainInitialized() const {return TObject::TestBit(kTasksInitialized);}
   Bool_t               IsExternalLoop() const {return TObject::TestBit(kExternalLoop);}
   Bool_t               IsEventLoop() const {return TObject::TestBit(kEventLoop);}
   Bool_t               IsSkipTerminate() const {return TObject::TestBit(kSkipTerminate);}
   Bool_t               MustClean() const {return fMustClean;}
   void                 SetMustClean(Bool_t flag=kTRUE) {fMustClean = flag;}
   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);
   void                 AddStatisticsMsg(const char *line);
   const char          *GetStatisticsMsg() const {return fStatisticsMsg.Data();}
   const AliAnalysisStatistics *GetStatistics() const {return fStatistics;}
   void                 SetStatistics(AliAnalysisStatistics *stat) {fStatistics = stat;}
   void                 WriteStatisticsMsg(Int_t nevents);
   Int_t                GetNcalls() const {return fNcalls;}
   Bool_t               ValidateOutputFiles() const;
   
   static const char*   GetOADBPath();

   void                 ApplyDebugOptions();
   void                 AddClassDebug(const char *className, Int_t debugLevel);
   
   // Security
   Bool_t               IsLocked() const {return fLocked;}
   void                 Lock();
   void                 UnLock();
   void                 Changed();
   void                 InitInputData(AliVEvent* esdEvent, AliVfriendEvent* esdFriend);
protected:
   void                 CreateReadCache();
   void                 ImportWrappers(TList *source);
   void                 InputFileFromTree(TTree * const tree, TString &fname);
   void                 SetEventLoop(Bool_t flag=kTRUE) {TObject::SetBit(kEventLoop,flag);}
   void                 DoLoadBranch(const char *name);

private:
   TTree                  *fTree;                
   AliVEventHandler       *fInputEventHandler;   
   AliVEventHandler       *fOutputEventHandler;  
   AliVEventHandler       *fMCtruthEventHandler; 
   AliVEventPool          *fEventPool;           
   Long64_t                fCurrentEntry;        
   Long64_t                fNSysInfo;            
   EAliAnalysisExecMode    fMode;                
   Bool_t                  fInitOK;              
   Bool_t                  fMustClean;           
   Bool_t                  fIsRemote;            
   Bool_t                  fLocked;              
   Bool_t                  fMCLoop;              
   UInt_t                  fDebug;               
   TString                 fSpecialOutputLocation; 
   TObjArray              *fTasks;               
   TObjArray              *fTopTasks;            
   TObjArray              *fZombies;             
   TObjArray              *fContainers;          
   TObjArray              *fInputs;              
   TObjArray              *fOutputs;             
   TObjArray              *fParamCont;           
   TObjArray              *fExchangeCont;        
   TObjArray              *fDebugOptions;        
   TObjArray              *fFileDescriptors;     
   AliAnalysisFileDescriptor *fCurrentDescriptor; 
   AliAnalysisDataContainer *fCommonInput;       
   AliAnalysisDataContainer *fCommonOutput;      
   AliAnalysisSelector    *fSelector;            
   AliAnalysisGrid        *fGridHandler;         
   TString                 fExtraFiles;          
   TString                 fFileInfoLog;         
   Bool_t                  fAutoBranchHandling;  
   Bool_t                  fAsyncReading;        
   THashTable              fTable;               
   Int_t                   fRunFromPath;         
   Int_t                   fNcalls;              
   Long64_t                fMaxEntries;          
   Long64_t                fCacheSize;           
   static Int_t            fPBUpdateFreq;        
   TString                 fStatisticsMsg;       
   TString                 fRequestedBranches;   
   AliAnalysisStatistics  *fStatistics;          
   TMap                   *fGlobals;             
   TStopwatch             *fIOTimer;             
   TStopwatch             *fCPUTimer;            
   TStopwatch             *fInitTimer;           
   Double_t                fIOTime;              
   Double_t                fCPUTime;             
   Double_t                fInitTime;            
   static TString          fgCommonFileName;     
   static TString          fgMacroNames;         
   static AliAnalysisManager *fgAnalysisManager; 
   ClassDef(AliAnalysisManager, 21)  // Analysis manager class
};   
#endif