Load pythia libraries.
[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 /** @file    AliFMDReconstructor.h
16     @author  Christian Holm Christensen <cholm@nbi.dk>
17     @date    Mon Mar 27 12:47:09 2006
18     @brief   FMD reconstruction 
19 */
20
21 //____________________________________________________________________
22 // Header guards in the header files speeds up the compilation
23 // considerably.  Please leave them in. 
24 #ifndef ALIRECONSTRUCTOR_H
25 # include <AliReconstructor.h>
26 #endif
27
28 #include "AliLog.h"
29
30 //____________________________________________________________________
31 class TTree;
32 class TClonesArray;
33 class AliFMDDigit;
34 class AliRawReader;
35 class AliESDEvent;
36 class AliESDFMD;
37 class TH1;
38
39
40 /** @defgroup FMD_rec Reconstruction */
41 //____________________________________________________________________
42 /** @brief This is a class that reconstructs AliFMDRecPoint objects from of
43     Digits.  
44     This class reads either digits from a TClonesArray or raw data
45     from a DDL file (or similar), and applies calibrations to get
46     psuedo-inclusive multiplicities per strip.
47
48     @ingroup FMD_rec
49  */
50 class AliFMDReconstructor: public AliReconstructor 
51 {
52 public:
53   /** CTOR */
54   AliFMDReconstructor();
55   /** DTOR */
56   virtual ~AliFMDReconstructor();
57
58   /** Initialize the reconstructor.  Here, we initialize the geometry
59       manager, and finds the local to global transformations from the
60       geometry.   The calibration parameter manager is also
61       initialized (meaning that the calibration parameters is read
62       from CDB).
63   */
64   virtual void   Init();
65   /** Flag that we can convert raw data into digits. 
66       @return always @c true */
67   virtual Bool_t HasDigitConversion() const { return kTRUE; }
68   /** Convert raw data read from the AliRawReader @a reader into
69       digits.  This is done using AliFMDRawReader and
70       AliFMDAltroReader.  The digits are put in the passed TTree @a
71       digitsTree. 
72       @param reader     Raw reader. 
73       @param digitsTree Tree to store read digits in. */
74   virtual void   ConvertDigits(AliRawReader* reader, TTree* digitsTree) const;
75   /** Reconstruct one event from the digits passed in @a digitsTree.
76       The member function creates AliFMDRecPoint objects and stores
77       them on the output tree @a clusterTree.  An FMD ESD object is
78       created in parallel. 
79       @todo Make sure we get a vertex. 
80       @param digitsTree  Tree holding the digits of this event
81       @param clusterTree Tree to store AliFMDRecPoint objects in. */
82   virtual void   Reconstruct(TTree* digitsTree, TTree* clusterTree) const;
83   /** Not used */
84   virtual void   Reconstruct(AliRawReader *, TTree*) 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                          AliESDEvent* esd) const;
94   /** Forwards to above member function */
95   virtual void   FillESD(AliRawReader*, TTree* clusterTree, 
96                          AliESDEvent* esd) const;
97   /** Not used */
98   virtual void   SetESD(AliESDEvent* esd) { fESD = esd; }
99   /** Set the noise factor 
100       @param f Factor to use */
101   virtual void SetNoiseFactor(Float_t f=3) { fNoiseFactor = f; }
102   /** Set whether we should do angle correction or nor 
103       @param use If true, do angle correction */
104   virtual void SetAngleCorrect(Bool_t use=kTRUE) { fAngleCorrect = use; }
105   /** Set whether we want to do diagnostics.  If this is enabled, a
106       file named @c FMD.Diag.root will be made.  It contains a set of
107       histograms for each event, filed in separate directories in the
108       file.  The histograms are 
109       @verbatim 
110       diagStep1   Read ADC vs. Noise surpressed ADC 
111       diagStep2   Noise surpressed ADC vs. calculated Energy dep.
112       diagStep3   Energy deposition vs. angle corrected Energy dep.
113       diagStep4   Energy deposition vs. calculated multiplicity
114       diagAll     Read ADC vs. calculated multiplicity
115       @endverbatim 
116       @param use If true, make the diagnostics file */
117   void SetDiagnose(Bool_t use=kTRUE) { fDiagnostics = use; }
118 protected:
119   /** Copy CTOR 
120       @param other Object to copy from. */
121   AliFMDReconstructor(const AliFMDReconstructor& other);
122   /** Assignment operator 
123       @param other Object to assign from
124       @return reference to this object */
125   AliFMDReconstructor& operator=(const AliFMDReconstructor& other);
126   /** Try to get the vertex from either ESD or generator header.  Sets
127       @c fCurrentVertex to the found Z posistion of the vertex (if 
128       found), and sets the flag @c fVertexType accordingly */
129   virtual void GetVertex() const;
130   /** Process AliFMDDigit objects in @a digits.  For each digit, find
131       the psuedo-rapidity @f$ \eta@f$, azimuthal angle @f$ \varphi@f$,
132       energy deposited @f$ E@f$, and psuedo-inclusive multiplicity @f$
133       M@f$.
134       @param digits Array of digits. */
135   virtual void     ProcessDigits(TClonesArray* digits) const;
136   /** Substract pedestals from raw ADC in @a digit
137       @param digit Digit data
138       @return Pedestal subtracted ADC count. */
139   virtual UShort_t SubtractPedestal(AliFMDDigit* digit) const;
140   /** Converts number of ADC counts to energy deposited.   This is
141       done by 
142       @f[
143       E_i = A_i g_i
144       @f]
145       where @f$ A_i@f$ is the pedestal subtracted ADC counts, and @f$
146       g_i@f$ is the gain for the @f$ i^{\mbox{th}}@f$ strip. 
147       @param digit Raw data
148       @param eta   Psuedo-rapidity of digit.
149       @param count Pedestal subtracted ADC counts
150       @return Energy deposited @f$ E_i@f$ */
151   virtual Float_t  Adc2Energy(AliFMDDigit* digit, Float_t eta, 
152                               UShort_t count) const;
153   /** Converts an energy signal to number of particles. In this
154       implementation, it's done by 
155       @f[
156       M_i = E_i / E_{\mbox{MIP}}
157       @f]
158       where @f$ E_i@f$ is the energy deposited, and @f$
159       E_{\mbox{MIP}}@f$ is the average energy deposited by a minimum
160       ionizing particle
161       @param digit Raw data
162       @param edep Energy deposited @f$ E_i@f$
163       @return Psuedo-inclusive multiplicity @f$ M@f$ */
164   virtual Float_t  Energy2Multiplicity(AliFMDDigit* digit, Float_t edep) const;
165   /** Calculate the physical coordinates psuedo-rapidity @f$ \eta@f$,
166       azimuthal angle @f$ \varphi@f$ of the strip corresponding to
167       the digit @a digit.   This is done by using the information
168       obtained, and previously cached by AliFMDGeometry, from the
169       TGeoManager. 
170       @param digit Digit.
171       @param eta   On return, psuedo-rapidity @f$ \eta@f$
172       @param phi   On return, azimuthal angle @f$ \varphi@f$ */
173   virtual void     PhysicalCoordinates(AliFMDDigit* digit, Float_t& eta, 
174                                        Float_t& phi) const;
175   
176   enum Vertex_t {
177     kNoVertex,   // Got no vertex
178     kGenVertex,  // Got generator vertex 
179     kESDVertex   // Got ESD vertex 
180   };
181   mutable TClonesArray* fMult;          // Cache of RecPoints
182   mutable Int_t         fNMult;         // Number of entries in fMult 
183   mutable TTree*        fTreeR;         // Output tree 
184   mutable Float_t       fCurrentVertex; // Z-coordinate of primary vertex
185   mutable AliESDFMD*    fESDObj;        // ESD output object
186   Float_t               fNoiseFactor;   // Factor of noise to check
187   Bool_t                fAngleCorrect;  // Whether to angle correct
188   mutable Vertex_t      fVertexType;    // What kind of vertex we got
189   AliESDEvent*          fESD;           // ESD object(?)
190   Bool_t                fDiagnostics;   // Wheter to do diagnostics
191   TH1*                  fDiagStep1;     // Diagnostics histogram
192   TH1*                  fDiagStep2;     // Diagnostics histogram
193   TH1*                  fDiagStep3;     // Diagnostics histogram
194   TH1*                  fDiagStep4;     // Diagnostics histogram
195   TH1*                  fDiagAll;       // Diagnostics histogram
196 private:
197    
198   ClassDef(AliFMDReconstructor, 3)  // class for the FMD reconstruction
199 }; 
200 #endif
201 //____________________________________________________________________
202 //
203 // Local Variables:
204 //   mode: C++
205 // End:
206 //
207 // EOF
208 //