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