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