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