ANALYSIS/AliAnalysisManager.h

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