Virtual member functions (T.Kuhr)
[u/mrichter/AliRoot.git] / STEER / AliLoader.h
1 #ifndef ALILOADER_H
2 #define ALILOADER_H
3
4 #include <TFolder.h>
5 #include <TObjArray.h>
6
7 //#include <AliConfig.h>
8 #include "AliDataLoader.h"
9
10 class TString;
11 class TFile;
12 class TTree;
13 class TTask;
14 class AliRunLoader;
15 class AliDigitizer;
16 class TDirectory;
17
18
19 //___________________________________________________________________
20 /////////////////////////////////////////////////////////////////////
21 //                                                                 //
22 //  class AliLoader                                                //
23 //                                                                 //
24 //  Base class for Loaders.                                        //
25 //  Loader provides base I/O fascilities for "standard" data.      //
26 //  Each detector has a laoder data member.                        //
27 //  Loader is always accessible via folder structure as well       //
28 //                                                                 //
29 /////////////////////////////////////////////////////////////////////
30
31 class AliLoader: public TNamed
32  {
33    public:
34     AliLoader();
35     AliLoader(const Char_t *detname,const Char_t *eventfoldername); //contructor with name of the top folder of the tree
36     AliLoader(const Char_t *detname,TFolder* eventfolder);
37     AliLoader(const AliLoader& source); //copy constructor
38     AliLoader& operator=(const AliLoader& source); //assignment operator
39
40     virtual ~AliLoader();//----------------- 
41  
42     virtual Int_t  GetEvent();//changes to root directory
43                              //relies on the event number defined in gAlice
44     virtual Int_t  SetEvent();//basically the same that GetEvent but do not post data to folders
45     virtual void   MakeTree(Option_t* opt);
46
47     //these methods are responsible for reading data
48     // 1. Opens the file (accordingly to gAlice->GetEvNumber()/Nevents per File
49     // 2. Changes to proper ROOT directory
50     // 3. Retrives data and posts to folders
51     //options: 
52     //   ""       - readonly file
53     //   "update" - update file
54     //   "recreate" 
55     AliDataLoader* GetHitsDataLoader()     const {return (AliDataLoader*)fDataLoaders->At(kHits);}
56     AliDataLoader* GetSDigitsDataLoader()  const {return (AliDataLoader*)fDataLoaders->At(kSDigits);}
57     AliDataLoader* GetDigitsDataLoader()   const {return (AliDataLoader*)fDataLoaders->At(kDigits);}
58     AliDataLoader* GetRecPointsDataLoader()const {return (AliDataLoader*)fDataLoaders->At(kRecPoints);}
59     AliDataLoader* GetTracksDataLoader()   const {return (AliDataLoader*)fDataLoaders->At(kTracks);}
60     AliDataLoader* GetRecParticlesDataLoader()const {return (AliDataLoader*)fDataLoaders->At(kRecParticles);}
61  
62     AliDataLoader* GetDataLoader(const char* name);
63         
64     
65     Int_t          SetEventFolder(TFolder* eventfolder);//sets the event folder
66     Int_t          Register(TFolder* eventFolder);//triggers creation of subfolders for a given detector
67       
68     TFolder*       GetTopFolder();  //returns top aliroot folder
69     TFolder*       GetEventFolder();//returns the folder that event is sitting
70     TFolder*       GetDataFolder(); //returns the folder that hits, sdigits, etc are sitting (this contains folders named like detectors)
71     TFolder*       GetDetectorDataFolder();//returns the folder that hits, sdigits, etc 
72                                      //are sitting for a given detector (subfolder of Data Folder)
73     TFolder*       GetModulesFolder();
74     TFolder*       GetTasksFolder();
75     TFolder*       GetQAFolder();
76    
77     TTask*         SDigitizer() const;//return detector SDigitizer()
78     AliDigitizer*  Digitizer() const;
79     TTask*         Reconstructioner() const;
80     TTask*         Tracker() const;
81     TTask*         PIDTask() const;
82     TTask*         QAtask(const char* name = 0x0) const;
83
84     TObject**      SDigitizerRef();
85     TObject**      DigitizerRef();
86     TObject**      ReconstructionerRef();
87     TObject**      TrackerRef();
88     TObject**      PIDTaskRef();
89     
90     virtual void   MakeHitsContainer() const {GetHitsDataLoader()->MakeTree();}
91     virtual void   MakeSDigitsContainer() const {GetSDigitsDataLoader()->MakeTree();}
92     virtual void   MakeDigitsContainer() const {GetDigitsDataLoader()->MakeTree();}
93     virtual void   MakeRecPointsContainer() const {GetRecPointsDataLoader()->MakeTree();}
94     virtual void   MakeTracksContainer() const {GetTracksDataLoader()->MakeTree();}
95     virtual void   MakeRecParticlesContainer() const {GetRecParticlesDataLoader()->MakeTree();}
96         
97     virtual void   CleanFolders();
98     virtual void   CloseFiles();
99
100     virtual Int_t  PostSDigitizer(TTask* sdzer) const;//adds it to Run SDigitizer
101     virtual Int_t  PostDigitizer(AliDigitizer* task) const;
102     virtual Int_t  PostReconstructioner(TTask* task) const;
103     virtual Int_t  PostTracker(TTask* task) const;
104     virtual Int_t  PostPIDTask(TTask* task) const;
105     
106     virtual Int_t  WriteSDigitizer(Option_t* opt="") const
107       {return GetSDigitsDataLoader()->GetBaseTaskLoader()->WriteData(opt);}
108     virtual Int_t  WriteDigitizer(Option_t* opt="") const
109       {return GetDigitsDataLoader()->GetBaseTaskLoader()->WriteData(opt);}
110     virtual Int_t  WriteReconstructioner(Option_t* opt="") const
111       {return GetRecPointsDataLoader()->GetBaseTaskLoader()->WriteData(opt);}
112     virtual Int_t  WriteTracker(Option_t* opt="") const
113       {return GetTracksDataLoader()->GetBaseTaskLoader()->WriteData(opt);}
114     virtual Int_t  WritePIDTask(Option_t* opt="") const
115       {return GetRecParticlesDataLoader()->GetBaseTaskLoader()->WriteData(opt);}
116
117     TTree*         TreeH() const
118       {return GetHitsDataLoader()->Tree();}      //returns the tree from folder; shortcut method
119     TTree*         TreeS() const
120       {return GetSDigitsDataLoader()->Tree();}   //returns the tree from folder; shortcut method
121     TTree*         TreeD() const
122       {return GetDigitsDataLoader()->Tree();}    //returns the tree from folder; shortcut method
123     TTree*         TreeR() const
124       {return GetRecPointsDataLoader()->Tree();} //returns the tree from folder; shortcut method
125     TTree*         TreeT() const
126       {return GetTracksDataLoader()->Tree();}    //returns the tree from folder; shortcut method
127     TTree*         TreeP() const
128       {return GetRecParticlesDataLoader()->Tree();} //returns the tree from folder; shortcut method
129
130     virtual Int_t  LoadHits(Option_t* opt=""){
131       Int_t status = GetHitsDataLoader()->Load(opt);
132       SetTAddrInDet();
133       return status;
134     }
135     virtual Int_t  LoadSDigits(Option_t* opt=""){
136       Int_t status = GetSDigitsDataLoader()->Load(opt);
137       SetTAddrInDet();
138       return status;
139     }
140     virtual Int_t  LoadDigits(Option_t* opt=""){
141       Int_t status = GetDigitsDataLoader()->Load(opt);
142       SetTAddrInDet();
143       return status;
144     }
145     
146
147     virtual Int_t  LoadRecPoints(Option_t* opt="") {
148       Int_t status = GetRecPointsDataLoader()->Load(opt);
149       SetTAddrInDet();
150       return status;
151     }
152     virtual Int_t  LoadTracks(Option_t* opt="") {
153       Int_t status = GetTracksDataLoader()->Load(opt);
154       SetTAddrInDet();
155       return status;
156     }
157     virtual Int_t  LoadRecParticles(Option_t* opt="") {
158       Int_t status = GetRecParticlesDataLoader()->Load(opt);
159       SetTAddrInDet();
160       return status;
161     }
162     
163     virtual Int_t  LoadSDigitizer(Option_t* opt="") const {
164       return GetSDigitsDataLoader()->GetBaseTaskLoader()->Load(opt);
165     }
166     virtual Int_t  LoadDigitizer(Option_t* opt="") const {
167       return GetDigitsDataLoader()->GetBaseTaskLoader()->Load(opt);
168     }
169     virtual Int_t  LoadReconstructioner(Option_t* opt="") const {
170       return GetRecPointsDataLoader()->GetBaseTaskLoader()->Load(opt);
171     }
172     virtual Int_t  LoadTracker(Option_t* opt="") const {
173       return GetTracksDataLoader()->GetBaseTaskLoader()->Load(opt);
174     }
175     virtual Int_t  LoadPIDTask(Option_t* opt="") const {
176       return GetRecParticlesDataLoader()->GetBaseTaskLoader()->Load(opt);
177     }
178
179     virtual void   UnloadHits() const {GetHitsDataLoader()->Unload();}
180     virtual void   UnloadSDigits() const {GetSDigitsDataLoader()->Unload();}
181     virtual void   UnloadDigits() const {GetDigitsDataLoader()->Unload();}
182     virtual void   UnloadRecPoints() const{GetRecPointsDataLoader()->Unload();}
183     virtual void   UnloadTracks() const {GetTracksDataLoader()->Unload();}
184     virtual void   UnloadRecParticles() const {GetRecParticlesDataLoader()->Unload();}
185     virtual void   UnloadAll();
186
187     virtual Int_t  ReloadHits() const {return GetHitsDataLoader()->Reload();}  //unload and load again Hits
188     virtual Int_t  ReloadSDigits() const {return GetSDigitsDataLoader()->Reload();} //unload and load again 
189     virtual Int_t  ReloadDigits() const {return GetDigitsDataLoader()->Reload();} //unload and load again 
190     virtual Int_t  ReloadRecPoints() const {return GetRecPointsDataLoader()->Reload();} //unload and load again 
191     virtual Int_t  ReloadTracks() const {return GetTracksDataLoader()->Reload();} //unload and load again 
192     virtual Int_t  ReloadRecParticles() const {return GetRecParticlesDataLoader()->Reload();} //unload and load again 
193     virtual Int_t  ReloadAll(); //unload and load again everything that was loaded 
194     
195   //these methods writes object from folder to proper file
196     virtual Int_t  WriteHits(Option_t* opt="") const;
197     virtual Int_t  WriteSDigits(Option_t* opt="") const;
198     virtual Int_t  WriteDigits(Option_t* opt="") const {return GetDigitsDataLoader()->WriteData(opt);}
199     virtual Int_t  WriteRecPoints(Option_t* opt="") const {return GetRecPointsDataLoader()->WriteData(opt);}
200     virtual Int_t  WriteTracks(Option_t* opt="") const {return GetTracksDataLoader()->WriteData(opt);}
201     virtual Int_t  WriteRecParticles(Option_t* opt="") const {return GetRecParticlesDataLoader()->WriteData(opt);}
202
203     
204   //void SetTopFolder(TString& str){}; //Sets root top folder for the run
205     
206     void           SetHitsFileName(const TString& fname) const 
207       {GetHitsDataLoader()->SetFileName(fname);}
208     void           SetSDigitsFileName(const TString& fname) const 
209       {GetSDigitsDataLoader()->SetFileName(fname);}
210     void           SetDigitsFileName(const TString& fname) const
211       {GetDigitsDataLoader()->SetFileName(fname);}
212     void           SetRecPointsFileName(const TString& fname) const
213       {GetRecPointsDataLoader()->SetFileName(fname);}
214     void           SetTracksFileName(const TString& fname) const
215       {GetTracksDataLoader()->SetFileName(fname);}
216     void           SetRecParticlesFileName(const TString& fname) const
217       {GetRecParticlesDataLoader()->SetFileName(fname);}
218
219     const TString& GetHitsFileName() const 
220       {return GetHitsDataLoader()->GetFileName();}
221     const TString& GetSDigitsFileName() const 
222       {return GetSDigitsDataLoader()->GetFileName();}
223     const TString& GetDigitsFileName() const
224       {return GetDigitsDataLoader()->GetFileName();}
225     const TString& GetRecPointsFileName() const
226       {return GetRecPointsDataLoader()->GetFileName();}
227     const TString& GetTracksFileName() const
228       {return GetTracksDataLoader()->GetFileName();}
229     const TString& GetRecParticlesFileName() const
230       {return GetRecParticlesDataLoader()->GetFileName();}
231    
232     virtual void  CleanHits() const
233       {GetHitsDataLoader()->Clean();}       //cleans hits from folder
234     virtual void  CleanSDigits() const
235       {GetSDigitsDataLoader()->Clean();}    //cleans digits from folder
236     virtual void  CleanDigits() const
237       {GetDigitsDataLoader()->Clean();}     //cleans sdigits from folder
238     virtual void  CleanRecPoints() const
239       {GetRecPointsDataLoader()->Clean();}  //cleans rec. points from folder
240     virtual void  CleanTracks() const
241       {GetTracksDataLoader()->Clean();}     //cleans tracks from folder
242     
243     virtual void  CleanSDigitizer();                    //cleans SDigitizer from folder
244     virtual void  CleanDigitizer();                     //cleans Digitizer from folder
245     virtual void  CleanReconstructioner();              //cleans Reconstructions (clusterizer) from folder
246     virtual void  CleanTracker();                       //cleans tracker from folder
247     virtual void  CleanPIDTask();              //cleans Reconstructions (clusterizer) from folder
248
249     virtual void  SetHitsFileOption(Option_t* newopt) const
250       {GetHitsDataLoader()->SetFileOption(newopt);}          //Sets Hits File Option in open
251     virtual void  SetSDigitsFileOption(Option_t* newopt) const
252       {GetSDigitsDataLoader()->SetFileOption(newopt);}    //Sets S. Digits File Option in open
253     virtual void  SetDigitsFileOption(Option_t* newopt) const
254       {GetDigitsDataLoader()->SetFileOption(newopt);}      //Sets Digits File Option in open
255     virtual void  SetRecPointsFileOption(Option_t* newopt) const
256       {GetRecPointsDataLoader()->SetFileOption(newopt);}//Sets Rec Ponoints File Option in open
257     virtual void  SetTracksFileOption(Option_t* newopt) const
258       {GetTracksDataLoader()->SetFileOption(newopt);}      //Sets Tracks File Option in open
259     virtual void  SetRecParticlesFileOption(Option_t* newopt) const
260       {GetRecParticlesDataLoader()->SetFileOption(newopt);}//Sets Rec Ponoints File Option in open
261     
262     virtual void  SetHitsComprLevel(Int_t cl) const
263       {GetHitsDataLoader()->SetCompressionLevel(cl);}
264     virtual void  SetDigitsComprLevel(Int_t cl) const
265       {GetSDigitsDataLoader()->SetCompressionLevel(cl);}
266     virtual void  SetSDigitsComprLevel(Int_t cl) const
267       {GetDigitsDataLoader()->SetCompressionLevel(cl);}
268     virtual void  SetRecPointsComprLevel(Int_t cl) const
269       {GetRecPointsDataLoader()->SetCompressionLevel(cl);}
270     virtual void  SetTracksComprLevel(Int_t cl) const
271       {GetTracksDataLoader()->SetCompressionLevel(cl);}
272     virtual void  SetRecParticlesComprLevel(Int_t cl) const
273       {GetRecParticlesDataLoader()->SetCompressionLevel(cl);}
274     
275     virtual void  SetCompressionLevel(Int_t cl);//Sets compression level in all the files
276     void          SetDirName(TString& name);//sets the directory name for all the I/O environment
277     
278     const TString& GetDetectorName() const{return fDetectorName;}//returns the name of the detector
279     AliRunLoader*  GetRunLoader();//gets the run-getter from event folder
280     
281     void          SetDigitsFileNameSuffix(const TString& suffix) const;//adds the suffix before ".root", 
282                                                           //e.g. TPC.Digits.root -> TPC.DigitsMerged.root
283                                                               //made on Jiri Chudoba demand
284     void Synchronize();
285
286     /**********************************************/
287     /***********     P U B L I C     **************/
288     /*********       S T A T I C       ************/
289     /*********         METHODS         ************/
290     /*********     They are used by    ************/
291     /*********** AliRunLoader as well**************/
292     /**********************************************/
293     static TDirectory* ChangeDir(TFile* file, Int_t eventno); //changes the root directory in "file" to directory corresponing to eventno
294     static Bool_t      TestFileOption(Option_t* opt);//checks is file is created from scratch
295     static Bool_t      IsOptionWritable(const TString& opt);
296     
297     static Int_t GetDebug() {return fgDebug;}
298     static void        SetDebug(Int_t deb = 1){fgDebug = deb;}//Sets debugging information
299     
300    protected:
301
302     /*********************************************/
303     /************    PROTECTED      **************/
304     /*********     M E T H O D S       ***********/
305     /*********************************************/
306     enum EDataTypes{kHits = 0,kSDigits,kDigits,kRecPoints,kTracks,kRecParticles,kNDataTypes};
307
308     //Opens hits file and jumps to directory cooresponding to current event.
309     //If dir does not exists try to create it
310     //opt is passed to TFile::Open
311     //reads data from the file and posts them into folder
312
313
314     virtual Int_t PostHits() const
315       {return GetHitsDataLoader()->GetBaseLoader(0)->Load();}
316     virtual Int_t PostSDigits() const
317       {return GetSDigitsDataLoader()->GetBaseLoader(0)->Load();}
318     virtual Int_t PostDigits() const
319       {return GetDigitsDataLoader()->GetBaseLoader(0)->Load();}
320     virtual Int_t PostRecPoints() const
321       {return GetRecPointsDataLoader()->GetBaseLoader(0)->Load();}
322     virtual Int_t PostTracks() const
323       {return GetTracksDataLoader()->GetBaseLoader(0)->Load();}
324     virtual Int_t PostRecParticles() const
325       {return GetRecParticlesDataLoader()->GetBaseLoader(0)->Load();}
326     
327     void          Clean();//calls clean for data loaders
328     void          Clean(const TString& name);//removes and deletes object from data folder 
329     
330     
331     TString       GetUnixDir() const;
332     TObject*      GetDetectorData(const char* name){return GetDetectorDataFolder()->FindObject(name);}
333     TObject**     GetDetectorDataRef(TObject* obj);
334     
335     void InitDefaults();
336     void ResetDataInfo();
337     
338     void SetTAddrInDet();//Call SetTreeAddress for corresponding detector
339
340     /**********************************************/
341     /************    PROTECTED      ***************/
342     /*********        D A T A          ************/
343     /**********************************************/
344   
345     TObjArray*    fDataLoaders; // array with data loaders each corresponds to 
346                                 // one data type (Hits, Digits, ...) 
347
348     TString       fDetectorName;//detector name that this loader belongs to
349     
350     TFolder*      fEventFolder; //! Folder with data that changes from event to event, even in single run
351     TFolder*      fDataFolder;  //!  Folder with data (hits, sdigits, etc, grouped in folders named like detectors
352     TFolder*      fDetectorDataFolder;//!Folder that contains the detector data
353     TFolder*      fModuleFolder;      //!Folder that contains the modules 
354
355     TFolder*      fTasksFolder;       //!Folder that contains the Tasks (sdigitizer, digitizer, reconstructioner)
356     TFolder*      fQAFolder;          //!Folder that contains the QA objects
357     
358  // file option varible was introduced because if TFile is created with "recreate" 
359  // stored option in TFile is "CREATE". We need to remeber "recreate" for
360  // Max events per file functionality
361
362     static const TString   fgkDefaultHitsContainerName;//default name of conatiner (TREE) for hits
363     static const TString   fgkDefaultDigitsContainerName;//default name of conatiner (TREE) for digits
364     static const TString   fgkDefaultSDigitsContainerName;//default name of conatiner (TREE) for Sdigits
365     static const TString   fgkDefaultRecPointsContainerName;//default name of conatiner (TREE) for Rec Points
366     static const TString   fgkDefaultTracksContainerName;//default name of conatiner (TREE) for Tracks
367     static const TString   fgkDefaultRecParticlesContainerName;//default name of conatiner (TREE) for Reconstructed Particles
368     static const TString   fgkLoaderBaseName;//base name of Loader: fDetectorName+fgkLoaderBaseName. i.e. PHOSLoader
369     
370    private:
371     //descendant classes should
372     //use protected interface methods to access these folders
373
374     static Int_t       fgDebug; //debug flag for loaders
375
376     ClassDef(AliLoader,2)
377  };
378 /******************************************************************/
379 /************************ I N L I N E S ***************************/
380 /******************************************************************/
381
382 inline TFolder* AliLoader::GetDetectorDataFolder()
383  {
384  //helper function which returns the folder of name "name" in data folder
385    if(!fDetectorDataFolder)
386     {
387       fDetectorDataFolder = dynamic_cast<TFolder*>(GetDataFolder()->FindObject(fDetectorName.Data()));
388       if(!fDetectorDataFolder)
389        {
390          Fatal("GetDetectorDataFolder",
391                "Can not find folder %s in folder %s. Aborting",
392                fDetectorName.Data(),GetDataFolder()->GetName());
393          return 0x0;
394        }
395       
396     }
397    return fDetectorDataFolder;
398  }
399
400 #endif