STEER/AliRunLoader.h

   1 #ifndef ALIRUNLoader_H
   2 #define ALIRUNLoader_H
   3
   4 //___________________________________________________________________
   5 /////////////////////////////////////////////////////////////////////
   6 //                                                                 //
   7 //  class AliRunLoader                                             //
   8 //                                                                 //
   9 //  This class aims to be the only one interface for manging data  //
  10 //  It stores Loaders for all modules which knows the filenames    //
  11 //  of the data files to be stored.                                //
  12 //  It aims to substitude AliRun in automatic managing of data     //
  13 //  positioning thus there won't be necessity of loading gAlice    //
  14 //  from file in order to get fast access to the data              //
  15 //                                                                 //
  16 //  Logical place to put the specific Loader to the given          //
  17 //  detector is detector  itself (i.e ITSLoader in ITS).           //
  18 //  But, to load detector object one need to load gAlice, and      //
  19 //  by the way all other detectors with their geometrieces and     //
  20 //  so on. So, if one need to open TPC clusters there is no        //
  21 //  principal nedd to read everything.                             //
  22 //                                                                 //
  23 /////////////////////////////////////////////////////////////////////
  24
  25 #include <TNamed.h>
  26
  27 #include "AliConfig.h"
  28 #include "AliLoader.h"
  29 #include "AliDataLoader.h"
  30 #include "AliLog.h"
  31
  32 class TFile;
  33 class TString;
  34 class TFolder;
  35 class TObjArray;
  36 class TTree;
  37 class TTask;
  38 class TParticle;
  39
  40 class AliRun;
  41 class AliLoader;
  42 class AliDetector;
  43 class AliHeader;
  44 class AliStack;
  45 class AliRunDigitizer;
  46 class AliCDBEntry;
  47
  48
  49 class AliRunLoader: public TNamed
  50 {
  51   public:
  52
  53     AliRunLoader();
  54     AliRunLoader(const char* topfoldername);
  55     AliRunLoader(TFolder* topfolder);
  56     AliRunLoader(const AliRunLoader &rl);
  57     AliRunLoader & operator = (const AliRunLoader &rl)
  58       {rl.Copy(*this); return *this;}
  59
  60     virtual ~AliRunLoader();
  61
  62     static AliRunLoader* Open(const char* filename = "galice.root",
  63                               const char* eventfoldername = AliConfig::GetDefaultEventFolderName(),
  64                   Option_t* option = "READ");
  65
  66     Int_t       GetEventNumber() const {return fCurrentEvent;}
  67
  68     Int_t       GetEvent(Int_t evno);//sets the event number and reloads data in folders properly
  69     Int_t       GetNextEvent(){return GetEvent(fCurrentEvent+1);}//gets next event
  70     Int_t       SetEventNumber(Int_t evno); //cleans folders and sets the root dirs in files (do not reload data)
  71     Int_t       SetNextEvent(){return SetEventNumber(fCurrentEvent+1);}
  72
  73     Int_t       GetNumberOfEvents();
  74
  75     AliCDBEntry* GetCDBEntry(const char* name) const;
  76
  77     void        MakeTree(Option_t *option);
  78     void        MakeHeader();
  79     void        MakeStack();
  80
  81     Int_t       LoadgAlice();
  82     Int_t       LoadHeader();
  83     Int_t       LoadKinematics(Option_t* option = "READ");
  84     Int_t       LoadTrackRefs(Option_t* option = "READ");
  85
  86     void        UnloadHeader();
  87     void        UnloadKinematics();
  88     void        UnloadgAlice();
  89     void        UnloadTrackRefs();
  90
  91     void        SetKineFileName(const TString& fname){fKineDataLoader->SetFileName(fname);}
  92     void        SetTrackRefsFileName(const TString& fname){fTrackRefsDataLoader->SetFileName(fname);}
  93
  94     TTree*      TreeE() const; //returns the tree from folder; shortcut method
  95     AliHeader*  GetHeader() const;
  96
  97     AliStack*   Stack() const {return fStack;}
  98
  99     TTree*      TreeK() const; //returns the tree from folder; shortcut method
 100     TTree*      TreeTR() const; //returns the tree from folder; shortcut method
 101
 102     AliRun*     GetAliRun()const;
 103
 104     Int_t       WriteGeometry(Option_t* opt="");
 105     Int_t       WriteHeader(Option_t* opt="");
 106     Int_t       WriteAliRun(Option_t* opt="");
 107     Int_t       WriteKinematics(Option_t* opt="");
 108     Int_t       WriteTrackRefs(Option_t* opt="");
 109     Int_t       WriteRunLoader(Option_t* opt="");
 110
 111     Int_t       WriteHits(Option_t* opt="");
 112     Int_t       WriteSDigits(Option_t* opt="");
 113     Int_t       WriteDigits(Option_t* opt="");
 114     Int_t       WriteRecPoints(Option_t* opt="");
 115     Int_t       WriteTracks(Option_t* opt="");
 116
 117     Int_t       LoadHits(Option_t* detectors = "all",Option_t* opt = "RAED");
 118     Int_t       LoadSDigits(Option_t* detectors = "all",Option_t* opt = "RAED");
 119     Int_t       LoadDigits(Option_t* detectors = "all",Option_t* opt = "RAED");
 120     Int_t       LoadRecPoints(Option_t* detectors = "all",Option_t* opt = "RAED");
 121     Int_t       LoadTracks(Option_t* detectors = "all",Option_t* opt = "RAED");
 122     Int_t       LoadRecParticles(Option_t* detectors = "all",Option_t* opt = "RAED");
 123
 124     void        UnloadHits(Option_t* detectors = "all");
 125     void        UnloadSDigits(Option_t* detectors = "all");
 126     void        UnloadDigits(Option_t* detectors = "all");
 127     void        UnloadRecPoints(Option_t* detectors = "all");
 128     void        UnloadTracks(Option_t* detectors = "all");
 129     void        UnloadRecParticles(Option_t* detectors = "all");
 130     void        UnloadAll(Option_t* detectors = "all");
 131
 132     void        AddLoader(AliLoader* loader);
 133     void        AddLoader(AliDetector* det);
 134     AliLoader*  GetLoader(const char* detname) const;
 135     AliLoader*  GetLoader(AliDetector* det) const;
 136     Int_t       SetEventFolderName(const TString& name = AliConfig::GetDefaultEventFolderName());//sets top folder name for this run; of alread
 137     void        CleanFolders();//removes all abjects from folder structure
 138     void        CleanDetectors();
 139     void        CleanKinematics(){Clean(fgkKineContainerName);}
 140     void        CleanTrackRefs(){Clean(fgkTrackRefsContainerName);}
 141
 142     void        RemoveEventFolder(); //remove folder structure from top folder
 143     void        SetCompressionLevel(Int_t cl);
 144     void        SetKineComprLevel(Int_t cl);
 145     void        SetTrackRefsComprLevel(Int_t cl);
 146
 147     TFolder*    GetEventFolder() const {return fEventFolder;}
 148     void        CdGAFile();
 149
 150     void        MakeTrackRefsContainer();
 151     void        SetDirName(TString& dirname);
 152     Int_t       GetFileOffset() const;
 153     void        SetNumberOfEventsPerFile(Int_t nevpf){fNEventsPerFile = nevpf;}
 154
 155     void        SetDigitsFileNameSuffix(const TString& suffix);//adds the suffix before ".root",
 156                                                                //e.g. TPC.Digits.root -> TPC.DigitsMerged.root
 157                                                                //made on Jiri Chudoba demand
 158     TString     GetFileName() const;//returns name of galice file
 159     const TObjArray* GetArrayOfLoaders() const {return fLoaders;}
 160     void Cd(){fgRunLoader = this;}
 161     void Synchronize();
 162
 163     AliLoader*    GetDetectorLoader(const char* detname);
 164     TTree*        GetTreeH(const char* detname, Bool_t maketree);
 165     TTree*        GetTreeS(const char* detname, Bool_t maketree);
 166     TTree*        GetTreeD(const char* detname, Bool_t maketree);
 167     TTree*        GetTreeR(const char* detname, Bool_t maketree);
 168     TTree*        GetTreeT(const char* detname, Bool_t maketree);
 169     TTree*        GetTreeP(const char* detname, Bool_t maketree);
 170
 171   /******************************************/
 172   /*****   Public S T A T I C Stuff   *******/
 173   /******************************************/
 174     static AliRunLoader* GetRunLoader(const char* eventfoldername);
 175     static AliRunLoader* GetRunLoader(){return fgRunLoader;}
 176     static AliLoader*    GetDetectorLoader(const char* detname, const char* eventfoldername);
 177     static TTree*        GetTreeH(const char* detname, Bool_t maketree, const char* eventfoldername);
 178     static TTree*        GetTreeS(const char* detname, Bool_t maketree, const char* eventfoldername);
 179     static TTree*        GetTreeD(const char* detname, Bool_t maketree, const char* eventfoldername);
 180     static TTree*        GetTreeR(const char* detname, Bool_t maketree, const char* eventfoldername);
 181     static TTree*        GetTreeT(const char* detname, Bool_t maketree, const char* eventfoldername);
 182     static TTree*        GetTreeP(const char* detname, Bool_t maketree, const char* eventfoldername);
 183
 184 //    static AliRunDigitizer* GetRunDigitizer();
 185 //  Tasks are supposed to be singletons, that is why following methods are static
 186     static TTask*           GetRunDigitizer();        //
 187     static TTask*           GetRunSDigitizer();       //
 188     static TTask*           GetRunReconstructioner(); //
 189     static TTask*           GetRunTracker();          //
 190     static TTask*           GetRunPIDTask();          //
 191     static TTask*           GetRunQATask();           //
 192
 193     static TString GetRunLoaderName () {return fgkRunLoaderName;}
 194     static TString GetHeaderContainerName () {return fgkHeaderContainerName;}
 195     static TString GetKineContainerName () {return fgkKineContainerName;}
 196     static TString GetTrackRefsContainerName () {return fgkTrackRefsContainerName;}
 197     static TString GetHeaderBranchName () {return fgkHeaderBranchName;}
 198     static TString GetKineBranchName () {return fgkKineBranchName;}
 199     static TString GetGAliceName () {return fgkGAliceName;}
 200
 201 protected:
 202     /**********************************************/
 203     /************    PROTECTED      ***************/
 204     /*********        D A T A          ************/
 205     /**********************************************/
 206
 207     TObjArray     *fLoaders;          //  List of Detectors
 208     TFolder       *fEventFolder;      //!top folder for this run
 209
 210     Int_t          fCurrentEvent;//!Number of current event
 211
 212     TFile         *fGAFile;//!  pointer to main file with AliRun and Run Loader -> galice.root
 213     AliHeader     *fHeader;//!  pointer to header
 214     AliStack      *fStack; //!  pointer to stack
 215
 216     AliDataLoader *fKineDataLoader;// kinematics data loader
 217     AliDataLoader *fTrackRefsDataLoader;//track reference data loader
 218
 219     Int_t          fNEventsPerFile;  //defines number of events stored per one file
 220     TString        fUnixDirName;    //! name of unix path to directory that contains event
 221     static const TString   fgkDefaultKineFileName;//default file name with kinamatics
 222     static const TString   fgkDefaultTrackRefsFileName;//default file name with kinamatics
 223
 224
 225     /*********************************************/
 226     /************    PROTECTED      **************/
 227     /*********     M E T H O D S       ***********/
 228     /*********************************************/
 229
 230     void           SetGAliceFile(TFile* gafile);//sets the pointer to gAlice file
 231     Int_t          OpenKineFile(Option_t* opt);
 232     Int_t          OpenTrackRefsFile(Option_t* opt);
 233
 234     Int_t          OpenDataFile(const TString& filename,TFile*& file,TDirectory*& dir,Option_t* opt,Int_t cl);
 235     void           SetUnixDir(const TString& udirname);
 236     const TString  SetFileOffset(const TString& fname);//adds the proper number before .root
 237     void           SetDetectorAddresses();
 238
 239   private:
 240     void  GetListOfDetectors(const char * namelist,TObjArray& pointerarray) const;
 241
 242     void  CleanHeader(){Clean(fgkHeaderContainerName);}
 243     void  Clean(const TString& name);
 244
 245     Int_t SetEvent();
 246
 247     static AliRunLoader* fgRunLoader; //pointer to the AliRunLoader instance
 248
 249 private:
 250     void Copy(TObject &arun) const;
 251
 252     static const TString   fgkRunLoaderName;          //default name of the run loader
 253     static const TString   fgkHeaderContainerName;    //default name of the kinematics container (TREE) name - TreeE
 254     static const TString   fgkKineContainerName;      //default name of the kinematics container (TREE) name - TreeK
 255     static const TString   fgkTrackRefsContainerName; //default name of the track references container (TREE) name - TreeTR
 256     static const TString   fgkHeaderBranchName;       //default name of the branch containing the header
 257     static const TString   fgkKineBranchName;         //default name of the branch with kinematics
 258     static const TString   fgkGAliceName;             //default name for gAlice file
 259
 260     ClassDef(AliRunLoader,1)
 261 };
 262
 263 #endif