]> git.uio.no Git - u/mrichter/AliRoot.git/blob - PHOS/AliPHOSGetter.h
Coding Conventions & Cleanup
[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 "TObject.h"  
21 class TParticle ;
22 class TTree ; 
23
24 // --- Standard library ---
25
26 // --- AliRoot header files ---
27 #include "AliConfig.h" 
28 #include "AliPHOSLoader.h" 
29 #include "AliPHOSHit.h" 
30 #include "AliPHOSDigit.h"
31 #include "AliPHOSEmcRecPoint.h" 
32 #include "AliPHOSCpvRecPoint.h" 
33 #include "AliPHOSTrackSegment.h" 
34 #include "AliPHOSRecParticle.h" 
35 #include "AliPHOSDigitizer.h"
36 #include "AliPHOSSDigitizer.h"
37 class AliPHOS ;  
38 class AliPHOSGeometry ;
39 class AliPHOSClusterizer ;
40 class AliPHOSTrackSegmentMaker ;  
41 class AliPHOSPID ; 
42 class AliPHOSBeamTestEvent ;
43 class AliESD ; 
44
45 class AliPHOSGetter : public TObject {
46   
47 public:  
48   AliPHOSGetter(){    // ctor: this is a singleton, the ctor should never be called but cint needs it as public
49     Fatal("ctor", "AliPHOSGetter is a singleton default ctor not callable") ;
50   } 
51 protected :
52   AliPHOSGetter(Int_t /*i*/){    // special constructor for onflight 
53
54   } 
55 private:
56   AliPHOSGetter(const char* headerFile,
57                 const char* version = AliConfig::GetDefaultEventFolderName(),
58                 Option_t * openingOption = "READ") ;
59
60 public:
61   AliPHOSGetter(const AliPHOSGetter & obj) : TObject(obj) {
62     // cpy ctor requested by Coding Convention 
63     Fatal("cpy ctor", "not implemented") ;
64   } 
65   
66   AliPHOSGetter & operator = (const AliPHOSGetter & ) {
67     // assignement operator requested by coding convention, but not needed
68     Fatal("operator =", "not implemented") ;
69     return *this ; 
70   }
71   virtual ~AliPHOSGetter() ; 
72   
73   //=========== Instantiators ================
74   static AliPHOSGetter * Instance(const char* headerFile,
75                                   const char* version = AliConfig::GetDefaultEventFolderName(),
76                                   Option_t * openingOption = "READ" ) ; 
77   static AliPHOSGetter * Instance() ; 
78   
79   static void Print() ; 
80   
81   //=========== General information about run ==============
82   virtual Bool_t IsLoaded(TString tree) const { return fLoadingStatus.Contains(tree) ; } 
83   virtual void   SetLoaded(TString tree) { fLoadingStatus += tree ; } 
84   
85   virtual Int_t  MaxEvent() const ; 
86   virtual Int_t  EventNumber() const ; 
87   virtual Bool_t VersionExists(TString & opt) const ; 
88   virtual UShort_t EventPattern(void) const ; 
89   virtual Float_t  BeamEnergy(void) const ;
90   
91   //========== PHOSGeometry and PHOS ============= 
92   virtual AliPHOS *         PHOS() const  ;  
93   virtual AliPHOSGeometry * PHOSGeometry() const ; 
94   
95   //========== Methods to read something from file ==========
96   virtual void   Event(Int_t event, const char * opt = "HSDRTP") ;    
97   virtual void   Track(Int_t itrack) ;
98  
99   
100   //-----------------now getter's data--------------------------------------
101   AliPHOSCalibrationDB * CalibrationDB(){return  fcdb; }
102   void ReadCalibrationDB(const char * /*name*/, const char * /*filename*/){ ;}
103   void SetCalibrationDB(AliPHOSCalibrationDB * cdb) {fcdb = cdb ;}
104   
105   //=========== Primaries ============
106   virtual TClonesArray *    Primaries(void) ;
107   virtual TParticle * Primary(Int_t index) const ;
108   virtual Int_t       NPrimaries()const { return fNPrimaries; }
109   virtual TParticle * Secondary(const TParticle * p, Int_t index=1) const ;  
110   
111   //=========== Hits =================
112   virtual TClonesArray *  Hits(void)  ; 
113   virtual AliPHOSHit *    Hit(Int_t index) { return dynamic_cast<AliPHOSHit*>(Hits()->At(index) );}
114   virtual TTree *         TreeH() const ; 
115   
116   //=========== SDigits ==============
117   virtual TClonesArray *      SDigits() ;  
118   virtual AliPHOSDigit *      SDigit(Int_t index) { return static_cast<AliPHOSDigit *>(SDigits()->At(index)) ;} 
119   virtual TTree *             TreeS() const ; 
120   virtual AliPHOSSDigitizer * SDigitizer() ;  
121   
122   virtual TString             GetSDigitsFileName() const { return PhosLoader()->GetSDigitsFileName() ; }  
123   virtual Int_t               LoadSDigits(Option_t* opt="") const { return PhosLoader()->LoadSDigits(opt) ; }
124   virtual Int_t               LoadSDigitizer(Option_t* opt="") const { return  PhosLoader()->LoadSDigitizer(opt) ; }
125   virtual Int_t               WriteSDigits(Option_t* opt="") const  { return PhosLoader()->WriteSDigits(opt) ; }
126   virtual Int_t               WriteSDigitizer(Option_t* opt="") const {
127     return  PhosLoader()->WriteSDigitizer(opt) ; }
128   
129   //========== Digits ================
130   virtual TClonesArray * Digits() ;
131   virtual AliPHOSDigit * Digit(Int_t index) { return static_cast<AliPHOSDigit *>(Digits()->At(index)) ;} 
132   virtual TTree *        TreeD() const ; 
133   virtual AliPHOSDigitizer * Digitizer() ;
134   virtual TString             GetDigitsFileName() const { return PhosLoader()->GetDigitsFileName() ; }  
135   virtual Int_t               LoadDigits(Option_t* opt="") const { return PhosLoader()->LoadDigits(opt) ; }
136   virtual Int_t               LoadDigitizer(Option_t* opt="") const {
137     return  PhosLoader()->LoadDigitizer(opt) ; }
138   virtual Int_t               WriteDigits(Option_t* opt="") const { return PhosLoader()->WriteDigits(opt) ; }
139   virtual Int_t               WriteDigitizer(Option_t* opt="") const {
140     return  PhosLoader()->WriteDigitizer(opt) ; }
141
142   //Methods to distinguish raw and simulated digits
143   virtual Bool_t              IsRawDigits(void) const {return fRawDigits;}
144   virtual void                SetRawDigits(Bool_t isRaw = kTRUE){fRawDigits = isRaw;}
145   
146   //========== RecPoints =============
147   virtual TObjArray *           EmcRecPoints() ;
148   virtual AliPHOSEmcRecPoint *  EmcRecPoint(Int_t index) { return static_cast<AliPHOSEmcRecPoint *>(EmcRecPoints()->At(index)) ;} 
149   virtual TObjArray *           CpvRecPoints() ; 
150   virtual AliPHOSCpvRecPoint *  CpvRecPoint(Int_t index) { return static_cast<AliPHOSCpvRecPoint *>(CpvRecPoints()->At(index)) ;} 
151   virtual TTree *               TreeR() const ;
152   virtual AliPHOSClusterizer * Clusterizer() ;
153   virtual TString               GetRecPointsFileName() const { return PhosLoader()->GetRecPointsFileName() ; } 
154   virtual Int_t                 LoadRecPoints(Option_t* opt="") const { return PhosLoader()->LoadRecPoints(opt) ; }
155   virtual Int_t                 LoadClusterizer(Option_t* opt="") const {
156     return  PhosLoader()->LoadClusterizer(opt) ; }
157   virtual Int_t                 WriteRecPoints(Option_t* opt="") const { return PhosLoader()->WriteRecPoints(opt) ; }
158   virtual Int_t                 WriteClusterizer(Option_t* opt="") const {
159     return  PhosLoader()->WriteClusterizer(opt) ; }
160   
161   //========== TrackSegments   TClonesArray * TrackSegments(const char * name = 0) { 
162   virtual TClonesArray *           TrackSegments() ;
163   virtual AliPHOSTrackSegment *  TrackSegment(Int_t index) { return static_cast<AliPHOSTrackSegment *>(TrackSegments()->At(index)) ;} 
164   virtual TTree *               TreeT() const ;
165   virtual AliPHOSTrackSegmentMaker * TrackSegmentMaker() ;
166   virtual TString               GetTracksFileName() const { return PhosLoader()->GetTracksFileName() ; } 
167   virtual Int_t                 LoadTracks(Option_t* opt="") const { return PhosLoader()->LoadTracks(opt) ; }
168   virtual Int_t                 LoadTrackSegementMaker(Option_t* opt="") const {
169     return  PhosLoader()->LoadTrackSegmentMaker(opt) ; }
170   virtual Int_t                 WriteTracks(Option_t* opt="") const { return PhosLoader()->WriteTracks(opt) ; }
171   virtual Int_t                 WriteTrackSegmentMaker(Option_t* opt="") const {
172     return  PhosLoader()->WriteTracker(opt) ; }
173   
174   //========== RecParticles ===========
175   virtual TClonesArray *         RecParticles() ;
176   virtual AliPHOSRecParticle *   RecParticle(Int_t index) { return static_cast<AliPHOSRecParticle *>(RecParticles()->At(index)) ;} 
177   virtual TTree *               TreeP() const ;
178   virtual AliPHOSPID * PID() ;
179   virtual TString               GetRecParticlesFileName() const { return PhosLoader()->GetRecParticlesFileName() ; } 
180   virtual Int_t                 LoadRecParticles(Option_t* opt="") const { return PhosLoader()->LoadRecParticles(opt) ; }
181   virtual Int_t                 LoadPID(Option_t* opt="") const {
182     return  PhosLoader()->LoadPID(opt) ; }
183   virtual Int_t                 WriteRecParticles(Option_t* opt="") const { return PhosLoader()->WriteRecParticles(opt) ; }
184   virtual Int_t                 WritePID(Option_t* opt="") const {
185     return  PhosLoader()->WritePID(opt) ; }
186
187   //========== Raw ===========
188   virtual Int_t ReadRaw(Int_t event) ; 
189
190   void SetDebug(Int_t level) {fgDebug = level;} // Set debug level 
191   virtual void PostClusterizer(AliPHOSClusterizer * clu) 
192     const{PhosLoader()->PostClusterizer(clu) ; }
193   virtual void PostPID(AliPHOSPID * pid) 
194     const{PhosLoader()->PostPID(pid) ; }
195   virtual void PostTrackSegmentMaker(AliPHOSTrackSegmentMaker * tr) 
196     const{PhosLoader()->PostTrackSegmentMaker(tr) ; }
197   virtual void PostSDigitizer (AliPHOSSDigitizer * sdigitizer) 
198     const {PhosLoader()->PostSDigitizer(sdigitizer);}    
199   virtual void PostDigitizer (AliPHOSDigitizer * digitizer)    
200     const {PhosLoader()->PostDigitizer(digitizer);}
201   
202   virtual TString Version() const  { return PhosLoader()->GetTitle() ; } 
203   virtual AliPHOSLoader * PhosLoader() const { return  fgPhosLoader ; }
204   virtual void Reset() ;
205   
206   virtual AliESD * ESD() const { return fESD ; }
207   
208 private:
209   
210   Int_t ReadTreeD(void) ;
211   Int_t ReadTreeH(void) ;
212   Int_t ReadTreeR(void) ;
213   Int_t ReadTreeT(void) ;
214   Int_t ReadTreeS(void) ;
215   Int_t ReadTreeP(void) ;
216
217   Int_t ReadTreeE(Int_t event) ;    
218   Bool_t OpenESDFile() ;
219   void ReadPrimaries(void) ;
220
221
222 private:
223   
224   AliPHOSBeamTestEvent * fBTE ;           //! Header if BeamTest Event
225   static Int_t          fgDebug ;             //! Debug level
226   
227   TString           fLoadingStatus ;     //! tells which trees are loaded
228   Int_t             fNPrimaries ;        //! # of primaries  
229   TClonesArray *    fPrimaries ;         //! list of lists of primaries
230   TFile *           fESDFile ;           //! ESD file
231   TString           fESDFileName ;       //! ESD File Name
232   AliESD *          fESD ;               //! ESD object
233   TTree *           fESDTree ;           //! ESD Tree
234   
235   Bool_t            fRawDigits ;         //!
236
237   AliPHOSCalibrationDB * fcdb ;       //!
238   
239   static AliPHOSLoader * fgPhosLoader ; // the loader for the NewIO
240   
241   enum EDataTypes{kHits,kSDigits,kDigits,kRecPoints,kTracks,kNDataTypes};
242
243  protected:
244   static AliPHOSGetter * fgObjGetter; // pointer to the unique instance of the singleton 
245   
246   
247   ClassDef(AliPHOSGetter,1)  // Algorithm class that provides methods to retrieve objects from a list knowing the index 
248     
249     };
250
251 #endif // AliPHOSGETTER_H