]> git.uio.no Git - u/mrichter/AliRoot.git/blob - FMD/AliFMDReconstructor.h
Added a lot of Doxygen documentation
[u/mrichter/AliRoot.git] / FMD / AliFMDReconstructor.h
1 #ifndef ALIFMDRECONSTRUCTOR_H
2 #define ALIFMDRECONSTRUCTOR_H
3 //
4 //  Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights
5 //  reserved. 
6 //
7 //  See cxx source for full Copyright notice                               
8 //
9 //  AliFMDReconstructor.h 
10 //  Task Class for making TreeR for FMD                        
11 //
12 //-- Authors: Evgeny Karpechev (INR) and Alla Maevskaia (INR)
13 //   Latest changes by Christian Holm Christensen <cholm@nbi.dk>
14 /* $Id$ */
15
16 //____________________________________________________________________
17 // Header guards in the header files speeds up the compilation
18 // considerably.  Please leave them in. 
19 #ifndef ALIRECONSTRUCTOR_H
20 # include <AliReconstructor.h>
21 #endif
22
23 //____________________________________________________________________
24 class TTree;
25 class TClonesArray;
26 class AliFMDDigit;
27 class AliRawReader;
28 class AliRunLoader;
29 class AliESD;
30 class AliESDFMD;
31
32 /** @defgroup FMD_rec Reconstruction */
33 //____________________________________________________________________
34 /** This is a class that reconstructs AliFMDRecPoint objects from of
35     Digits.  This class reads either digits from a TClonesArray or raw
36     data from a DDL file (or similar), and applies calibrations to get
37     psuedo-inclusive multiplicities per strip.
38     @ingroup FMD_rec
39  */
40 class AliFMDReconstructor: public AliReconstructor 
41 {
42 public:
43   /** CTOR */
44   AliFMDReconstructor();
45   /** Copy CTOR 
46       @param other Object to copy from. */
47   AliFMDReconstructor(const AliFMDReconstructor& other);
48   /** DTOR */
49   virtual ~AliFMDReconstructor();
50   /** Assignment operator 
51       @param other Object to assign from
52       @return reference to this object */
53   AliFMDReconstructor& operator=(const AliFMDReconstructor& other);
54
55   /** Initialize the reconstructor.  Here, we initialize the geometry
56       manager, and finds the local to global transformations from the
57       geometry.   The calibration parameter manager is also
58       initialized (meaning that the calibration parameters is read
59       from CDB).   Next, we try to get some information about the run
60       from the run loader passed. 
61       @param runLoader Run loader to use to load and store data. 
62   */
63   virtual void   Init(AliRunLoader* runLoader);
64   /** Flag that we can convert raw data into digits. 
65       @return always @c true */
66   virtual Bool_t HasDigitConversion() const { return kTRUE; }
67   /** Convert raw data read from the AliRawReader @a reader into
68       digits.  This is done using AliFMDRawReader and
69       AliFMDAltroReader.  The digits are put in the passed TTree @a
70       digitsTree. 
71       @param reader     Raw reader. 
72       @param digitsTree Tree to store read digits in. */
73   virtual void   ConvertDigits(AliRawReader* reader, TTree* digitsTree) const;
74   /** Flag that we can do one-event reconstruction. 
75       @return always @c true  */
76   virtual Bool_t HasLocalReconstruction() const { return kTRUE; }
77   /** Reconstruct one event from the digits passed in @a digitsTree.
78       The member function creates AliFMDRecPoint objects and stores
79       them on the output tree @a clusterTree.  An FMD ESD object is
80       created in parallel. 
81       @todo Make sure we get a vertex. 
82       @param digitsTree  Tree holding the digits of this event
83       @param clusterTree Tree to store AliFMDRecPoint objects in. */
84   virtual void   Reconstruct(TTree* digitsTree, TTree* clusterTree) const;
85   /** Put in the ESD data, the FMD ESD data.  The object created by
86       the Reconstruct member function is copied to the ESD object. 
87       @param digitsTree   Tree of digits for this event - not used
88       @param clusterTree  Tree of reconstructed points for this event
89       - not used. 
90       @param esd ESD object to store data in. 
91   */
92   virtual void   FillESD(TTree* digitsTree, TTree* clusterTree, 
93                          AliESD* esd) const;
94   /** Not used */
95   virtual void   SetESD(AliESD* esd) { fESD = esd; }
96      
97 private:
98   /** Hide base classes unused function */
99   void Reconstruct(AliRawReader*, TTree*) const;
100   /** Hide base classes unused function */
101   void Reconstruct(AliRunLoader*) const;
102   /** Hide base classes unused function */
103   void Reconstruct(AliRunLoader*, AliRawReader*) const;
104   /** Hide base classes unused function */
105   void FillESD(AliRawReader*, TTree*, AliESD*) const;
106   /** Hide base classes unused function */
107   void FillESD(AliRunLoader*, AliESD*) const;
108   /** Hide base classes unused function */
109   void FillESD(AliRunLoader*, AliRawReader*, AliESD*) const;
110   
111 protected:
112   /** Process AliFMDDigit objects in @a digits.  For each digit, find
113       the psuedo-rapidity @f$ \eta@f$, azimuthal angle @f$ \varphi@f$,
114       energy deposited @f$ E@f$, and psuedo-inclusive multiplicity @f$
115       M@f$.
116       @param digits Array of digits. */
117   virtual void     ProcessDigits(TClonesArray* digits) const;
118   /** Substract pedestals from raw ADC in @a digit
119       @param digit Digit data
120       @return Pedestal subtracted ADC count. */
121   virtual UShort_t SubtractPedestal(AliFMDDigit* digit) const;
122   /** Converts number of ADC counts to energy deposited.   This is
123       done by 
124       @f[
125       E_i = A_i g_i
126       @f]
127       where @f$ A_i@f$ is the pedestal subtracted ADC counts, and @f$
128       g_i@f$ is the gain for the @f$ i^{\mbox{th}}@f$ strip. 
129       @param digit Raw data
130       @param eta   Psuedo-rapidity of digit.
131       @param count Pedestal subtracted ADC counts
132       @return Energy deposited @f$ E_i@f$ */
133   virtual Float_t  Adc2Energy(AliFMDDigit* digit, Float_t eta, 
134                               UShort_t count) const;
135   /** Converts an energy signal to number of particles. In this
136       implementation, it's done by 
137       @f[
138       M_i = E_i / E_{\mbox{MIP}}
139       @f]
140       where @f$ E_i@f$ is the energy deposited, and @f$
141       E_{\mbox{MIP}}@f$ is the average energy deposited by a minimum
142       ionizing particle
143       @param digit Raw data
144       @param edep Energy deposited @f$ E_i@f$
145       @return Psuedo-inclusive multiplicity @f$ M@f$ */
146   virtual Float_t  Energy2Multiplicity(AliFMDDigit* digit, Float_t edep) const;
147   /** Calculate the physical coordinates psuedo-rapidity @f$ \eta@f$,
148       azimuthal angle @f$ \varphi@f$ of the strip corresponding to
149       the digit @a digit.   This is done by using the information
150       obtained, and previously cached by AliFMDGeometry, from the
151       TGeoManager. 
152       @param digit Digit.
153       @param eta   On return, psuedo-rapidity @f$ \eta@f$
154       @param phi   On return, azimuthal angle @f$ \varphi@f$ */
155   virtual void     PhysicalCoordinates(AliFMDDigit* digit, Float_t& eta, 
156                                        Float_t& phi) const;
157   
158   mutable TClonesArray* fMult;          // Cache of RecPoints
159   mutable Int_t         fNMult;         // Number of entries in fMult 
160   mutable TTree*        fTreeR;         // Output tree 
161   mutable Float_t       fCurrentVertex; // Z-coordinate of primary vertex
162   mutable AliESDFMD*    fESDObj;        // ESD output object
163   AliESD*               fESD;
164   
165   ClassDef(AliFMDReconstructor, 0)  // class for the FMD reconstruction
166 }; 
167 #endif
168 //____________________________________________________________________
169 //
170 // Local Variables:
171 //   mode: C++
172 // End:
173 //
174 // EOF
175 //