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