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