386f5f983aa5a8294114a4d937ab10586a0e04af
[u/mrichter/AliRoot.git] / PHOS / AliPHOSGetter.h
1 #ifndef ALIPHOSGETTER_H
2 #define ALIPHOSGETTER_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
8 //_________________________________________________________________________
9 //  A singleton that returns various objects 
10 //  Should be used on the analysis stage to avoid confusing between different
11 //  branches of reconstruction tree: e.g. reading RecPoints and TS made from 
12 //  another set of RecPoints.
13 // 
14 //  The objects are retrived from folders.  
15 //*-- Author: Yves Schutz (SUBATECH) & Dmitri Peressounko (RRC KI & SUBATECH)
16 //    
17
18
19 // --- ROOT system ---
20 #include "TClonesArray.h"
21 #include "TFolder.h"  
22 #include "TTree.h"
23 #include "TFile.h"
24 class TString ;
25 class TParticle ;
26 class TTask ;
27
28 // --- Standard library ---
29 #include <stdlib.h>
30 #include <iostream.h>
31
32 // --- AliRoot header files ---
33
34 #include "AliRun.h"
35 #include "AliPHOS.h" 
36 #include "AliPHOSHit.h" 
37 #include "AliPHOSDigit.h"
38 #include "AliPHOSEmcRecPoint.h"
39 #include "AliPHOSCpvRecPoint.h"
40 #include "AliPHOSTrackSegment.h"
41 #include "AliPHOSRecParticle.h"
42 class AliPHOSGeometry ;
43 class AliPHOSDigitizer ;
44 class AliPHOSSDigitizer ;
45 class AliPHOSClusterizer ;
46 class AliPHOSTrackSegmentMaker ;
47 class AliPHOSPID ;
48
49 class AliPHOSGetter : public TObject {
50   
51  public:
52   
53   AliPHOSGetter(){    // ctor: this is a singleton, the ctor should never be called but cint needs it as public
54     cerr << "ERROR: AliPHOSGetter is a singleton default ctor not callable" << endl ;
55     abort() ; 
56   } 
57   AliPHOSGetter(const AliPHOSGetter & obj) {
58     // cpy ctor requested by Coding Convention 
59     // but not yet needed
60     abort() ; 
61   } 
62   
63   AliPHOSGetter & operator = (const AliPHOSGetter & ) {
64     // assignement operator requested by coding convention, but not needed
65     abort() ;
66     return *this ; 
67   }
68   virtual ~AliPHOSGetter() ; 
69
70   //=========== Instantiators ================
71   static AliPHOSGetter * GetInstance(const char* headerFile,
72                                      const char* branchTitle = "Default",
73                                      const Bool_t toSplit = kFALSE ) ; 
74   static AliPHOSGetter * GetInstance() ; 
75
76   //=========== General information about run ==============
77   const Int_t  MaxEvent() const    { return static_cast<Int_t>(gAlice->TreeE()->GetEntries()) ; }
78   const Int_t  EventNumber() const { return static_cast<Int_t>(gAlice->GetEvNumber()) ; }
79   const Bool_t BranchExists(const TString tree) const ; 
80   
81   //========== PHOSGeometry and PHOS ============= 
82   const AliPHOS *         PHOS() ;  
83   const AliPHOSGeometry * PHOSGeometry() ; 
84
85   //========== Methods to read something from file ==========
86   void   Event(const Int_t event, const char * opt = "HSDRP") ;    
87   void   Track(const Int_t itrack) ;
88   void   ReadTreeS(TTree * treeS,Int_t input) ; //Method to be used when 
89                                                 //digitizing is under the control ofAliRunDigitizer, 
90                                                 //which opens all files etc.
91   //========== Alarms ======================
92   TFolder * Alarms() const { return dynamic_cast<TFolder*>(ReturnO("Alarms", 0)) ; }
93   const TObjArray *  Alarms(const char * name ) const { return dynamic_cast<const TObjArray*>(ReturnO("Alarms", name)) ; }
94   const TTask * QATasks(const char * name = 0) const { return ReturnT("QATasks", name) ; }
95
96   //-----------------now getter's data--------------------------------------
97
98   //=========== Primaries ============
99   TTree *           TreeK(TString filename="") ; 
100   TClonesArray *    Primaries(void) const { return dynamic_cast<TClonesArray*>(ReturnO("Primaries")) ; }
101   const TParticle * Primary(Int_t index) const ;
102   const Int_t       NPrimaries()const { return fNPrimaries; }
103   const TParticle * Secondary(TParticle * p, Int_t index=1) const ;  
104  
105   //=========== Hits =================
106   TTree *               TreeH(TString filename="") ; 
107   const TClonesArray *  Hits(void) { return dynamic_cast<const TClonesArray*>(ReturnO("Hits")) ; }
108   const AliPHOSHit *    Hit(Int_t index)  { return dynamic_cast<const AliPHOSHit*>(Hits()->At(index) );}
109   
110   //=========== SDigits ==============
111   TTree *                    TreeS(TString filename="") ; 
112   TClonesArray *             SDigits(const char * name = 0, const char * file=0) { 
113     return dynamic_cast<TClonesArray*>(ReturnO("SDigits", name, file)) ;   }
114   //const AliPHOSDigit *  SDigit(Int_t index) { return static_cast<const AliPHOSDigit *>(SDigits()->At(index)) ;} !!! why no such method ?
115   const AliPHOSSDigitizer *  SDigitizer(const char * name =0) const { 
116     return (const AliPHOSSDigitizer *) ReturnT("SDigitizer", name) ;   // here static or dynamic cast does not work ! why ?
117   }
118
119   //========== Digits ================
120   TTree *                   TreeD(TString filename="") ; 
121   TClonesArray *            Digits(const char * name = 0)const  { 
122     return dynamic_cast<TClonesArray*>(ReturnO("Digits", name)) ;   }
123 //const AliPHOSDigit *  Digit(Int_t index) { return static_cast<const AliPHOSDigit *>(Digits()->At(index)) ;} !!! why no such method ?
124   const AliPHOSDigitizer *  Digitizer(const char * name = 0) const { 
125     return (const AliPHOSDigitizer*)(ReturnT("Digitizer", name)) ;   }
126   
127   //========== RecPoints =============
128   //TTree *                    TreeR(TString filename="") ; !!! why no such method ? 
129   TObjArray *                EmcRecPoints(const char * name = 0) {
130     return dynamic_cast<TObjArray*>(ReturnO("EmcRecPoints", name)) ;   }
131 //const AliPHOSEmcRecPoint *  EmcRecPoint(Int_t index) { return static_cast<const AliPHOSEmcRecPoint *>(EmcRecPoints()->At(index)) ;} !!! why no such method ?
132   TObjArray *                CpvRecPoints(const char * name = 0) { 
133     return dynamic_cast<TObjArray*>(ReturnO("CpvRecPoints", name)) ;   }    
134 //const AliPHOSCpvRecPoint *  CpvRecPoint(Int_t index) { return static_cast<const AliPHOSCpvRecPoint *>(EmcCpvPoints()->At(index)) ;} !!! why no such method ?
135   const AliPHOSClusterizer * Clusterizer (const char * name =0) const { 
136     return (const AliPHOSClusterizer*)(ReturnT("Clusterizer", name)) ;   // here static or dynamic cast does not work ! why ?
137 }
138   
139   //========== TrackSegments ==========
140   TClonesArray * TrackSegments(const char * name = 0) { 
141     return static_cast<TClonesArray*>(ReturnO("TrackSegments", name)) ;   }
142   const AliPHOSTrackSegmentMaker * TrackSegmentMaker (const char * name =0) const { 
143     return (const AliPHOSTrackSegmentMaker*)(ReturnT("TrackSegmentMaker", name)) ;   }
144   
145   //========== RecParticles ===========
146   TClonesArray * RecParticles(const char * name = 0) { 
147     return static_cast<TClonesArray*>(ReturnO("RecParticles", name)) ;   }
148   const AliPHOSPID * PID(const char * name =0) const { 
149     return (const AliPHOSPID*)(ReturnT("PID", name)) ;  // here static or dynamic cast does not work ! why ?
150  }
151
152   //-----------------Auxiliary methods: cleaners-----------------
153   void  RemoveTask(TString opt, TString name) const ;
154   void  RemoveObjects(TString opt, TString name) const ;
155   void  RemoveSDigits() const ;  
156
157   //----------------Auxiliary methods: miscellana----------------
158   void CloseFile() ;  
159   const TFolder * Folder(const TString what) const ;
160   const Bool_t HasFailed() const { return fFailed ; }
161   void ListBranches(Int_t event=0) const ;
162   void NewBranch(TString name, Int_t event = 0) ; 
163   Bool_t NewFile(TString name) ;
164   TFolder * SDigitsFolder() { return dynamic_cast<TFolder*>(fSDigitsFolder->FindObject("PHOS")) ; }  
165   void SetDebug(Int_t level) {fDebug = level;} // Set debug level
166   void SetRecParticlesTitle(const TString title) { fRecParticlesTitle = title ; }
167   
168   //------------Auxiliary methods: Posters--------------------
169   const Bool_t PostPrimaries(void ) const ;  
170   const Bool_t PostHits(void ) const ;  
171   const Bool_t PostSDigits(      const char * name,  const char * file = 0) const ;  
172   const Bool_t PostDigits(       const char * name ) const ;  
173   const Bool_t PostRecPoints(    const char * name ) const ;  
174   const Bool_t PostTrackSegments(const char * name) const ;  
175   const Bool_t PostRecParticles( const char * name) const ;  
176   const Bool_t PostClusterizer( const char * name) const ;  
177   const Bool_t PostClusterizer(AliPHOSClusterizer * clu) const ;  
178   const Bool_t PostSDigitizer (AliPHOSSDigitizer * sdigitizer) const ;  
179   const Bool_t PostSDigitizer ( const char * name, const char * file ) const ;  
180   const Bool_t PostDigitizer (AliPHOSDigitizer * digitizer) const ;  
181   const Bool_t PostDigitizer  ( const char * name) const ;  
182   const Bool_t PostTrackSegmentMaker(AliPHOSTrackSegmentMaker * tsm) const ;  
183   const Bool_t PostTrackSegmentMaker(const char * name ) const ;  
184   const Bool_t PostPID  (AliPHOSPID * pid) const ;  
185   const Bool_t PostPID  (const char * name ) const ;  
186   const Bool_t PostQA   (void) const ;
187
188 private:
189   
190   AliPHOSGetter(const char* headerFile, const char* branchTitle ="Default", const Bool_t toSplit = kFALSE) ; 
191   TObject * ReturnO(TString what, TString name=0, TString file=0) const ; 
192   const TTask * ReturnT(TString what,TString name=0) const ; 
193   void DefineBranchTitles(char* branch, char* branchTitle) ;
194   Int_t ReadTreeD(const Int_t event) ;
195   Int_t ReadTreeH(void) ;
196   Int_t ReadTreeR(const Int_t event) ;
197   Int_t ReadTreeS(const Int_t event) ;
198   void ReadTreeQA(void) ;
199   void ReadPrimaries(void) ;
200   void CleanWhiteBoard(void) ;
201   void CloseSplitFiles(void) ;
202   void SetTitle(const char * title) ;
203
204   TObject** PrimariesRef(void) const ;
205   TObject** HitsRef(void) const ;
206   TObject** SDigitsRef(const char * name, const char * file = 0 ) const;
207   TObject** DigitsRef (const char * name)   const ;
208   TObject** EmcRecPointsRef (const char * name) const ;
209   TObject** CpvRecPointsRef (const char * name) const ;
210   TObject** TrackSegmentsRef(const char * name)   const ;
211   TObject** RecParticlesRef (const char * name)   const ;
212   TObject** AlarmsRef (void)   const ;
213
214   TObject** SDigitizerRef (const char * name) const ; 
215   TObject** DigitizerRef  (const char * name) const ; 
216   TObject** ClusterizerRef(const char * name) const ; 
217   TObject** TSMakerRef    (const char * name) const ; 
218   TObject** PIDRef        (const char * name) const ; 
219
220  private:
221
222   static TFile * fFile;           //! 
223   Bool_t         fToSplit ;              //! Do we work in the split mode
224   TString        fHeaderFile ;           //! File in which gAlice lives
225   TString        fBranchTitle ;          //!
226   TString        fTrackSegmentsTitle ;   //! 
227   TString        fTrackSegmentsFileName ;//! 
228   TString        fRecPointsTitle ;       //!
229   TString        fRecPointsFileName ;    //!
230   TString        fRecParticlesTitle ;    //!
231   TString        fRecParticlesFileName ; //!
232   TString        fDigitsTitle ;          //! TDirectory tempo(gDirectory) 
233   TString        fDigitsFileName ;       //! TDirectory tempo(gDirectory) 
234   TString        fSDigitsTitle ;         //!
235   TString        fSDigitsFileName ;      //!
236   Bool_t         fFailed ;            //! set if file not opend or galice not found
237   Int_t          fDebug ;             //! Debug level
238   AliRun *       fAlice ;             //! needed to read TreeK if in an other file than fHeaderFile
239   Int_t          fNPrimaries ;        //! # of primaries  
240   TObjArray *    fPrimaries ;         //! list of lists of primaries-for the case of mixing
241   TFolder *      fModuleFolder ;      //!Folder that contains the modules 
242   TFolder *      fPrimariesFolder ;   //!Folder that contains the Primary Particles 
243   TFolder *      fHitsFolder ;        //!Folder that contains the Hits 
244   TFolder *      fSDigitsFolder ;     //!Folder that contains the SDigits 
245   TFolder *      fDigitsFolder ;      //!Folder that contains the Digits 
246   TFolder *      fRecoFolder ;        //!Folder that contains the reconstructed objects (RecPoints, TrackSegments, RecParticles) 
247   TFolder *      fQAFolder ;          //!Folder that contains the QA objects  
248   TFolder *      fTasksFolder ;       //!Folder that contains the Tasks (sdigitizer, digitizer, reconstructioner)
249    
250   static AliPHOSGetter * fgObjGetter; // pointer to the unique instance of the singleton 
251
252   ClassDef(AliPHOSGetter,1)  // Algorithm class that provides methods to retrieve objects from a list knowing the index 
253
254 };
255
256 #endif // AliPHOSGETTER_H
257
258