Added documentation of each file.
[u/mrichter/AliRoot.git] / FMD / AliFMD.h
1 #ifndef ALIFMD_H
2 #define ALIFMD_H
3 /* Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights
4  * reserved. 
5  *
6  * Latest changes by Christian Holm Christensen <cholm@nbi.dk>
7  *
8  * See cxx source for full Copyright notice                               
9  */
10 /** @file    AliFMD.h
11     @author  Christian Holm Christensen <cholm@nbi.dk>
12     @date    Sun Mar 26 17:59:37 2006
13     @brief   Declaration of AliFMD detector driver 
14 */
15 /** @mainpage ALICE FMD Off-line code 
16     
17     @b Contents 
18     - @ref intro 
19     - @ref structure 
20       - @ref base  (see also @ref FMD_base)
21       - @ref sim   (see also @ref FMD_sim)
22       - @ref rec   (see also @ref FMD_rec)
23       - @ref util  (see also @ref FMD_util)
24     - @ref script  (see also @ref FMD_script)
25     - @ref quick
26     - @ref authors
27     
28     @section intro Introduction:
29
30     This file contains a short overview of the FMD code.   It is by no 
31     means authoritative  - only the code is good for that.  However,
32     I'll try to explain things a bit here. 
33
34     @section structure Structure:
35
36     There are 4 libraries build for the FMD.  These are 
37
38     - libFMDbase: This contains the basic stuff, like data classes and
39       managers.
40     - libFMDsim: This contains code used by the simulation only.  That
41       includes the detector class AliFMD and it's derivatives.  It
42       also contains the code for building the geometry, as well as the
43       digitisers and raw data writer.
44     - libFMDrec: Code needed for the reconstruction.  This include the
45       reconstruction code itself, as well as a raw data reader.
46     - libFMDutil: This is a special library that contains various
47       utility classes for the FMD expert/developer/tester.  It
48       includes code to read all data produced by the FMD, a simple
49       event display, and code to make fake calibration and alignment
50       data.  This library is @e not loaded by aliroot
51       automatically. The user has to load it herself:
52       @code 
53       gSystem->Load("libFMDutil.so");
54       @endcode
55     The content of these libraries is detailed more below. 
56     
57     @subsection base libFMDbase:
58
59     This currently (18th or March 2006) contains the classes 
60
61     - AliFMDBaseDigit, AliFMDDigit, AliFMDSDigit: Base class for
62       digits, real digits, and summable digits.  The are all data
63       classes that holds the ADC value(s) for a single strip.
64     - AliFMDBoolMap: A map of booleans, one for each strip.
65     - AliFMDUShortMap: A map of unsigned short integers, one for each
66       strip.
67     - AliFMDDetector, AliFMD1, AliFMD2, AliFMD3: 3 classes that holds
68       the parameters for each of the 3 FMD sub-detectors.  These
69       derive from AliFMDDetector, and are managed by AliFMDGeometry.
70       Each of these also contains the translation from sensor
71       reference frame to global reference frame.
72     - AliFMDRing: Parameters for the FMD rings (inner and outer type).
73       These are managed by AliFMDGeometry.
74     - AliFMDGeometry: Manager of FMD geometry data. All code queries
75       this manager for geometry parameters, so that the data is always
76       consistent.  
77     - AliFMDParameters: Manager of FMD parameters, like calibration
78       parameters.  This class fetches data from CDB if necessary.
79       All code queries this manager for parameters, so that the data
80       is always consistent. 
81     - AliFMDCalibPedestal, AliFMDCalibGain, AliFMDCalibSampleRate,
82       AliFMDAltroMapping: Containers of calibration parameters.  These
83       correspond to the pedestal and its width, the gain of each
84       strip, the oversampling rate used in read-out, and the map from
85       hardware address to detector.
86     - AliFMDAltroIO, AliFMDAltroReader, AliFMDAltroWriter: Low-level
87       classes to do input/output on ALTRO formated buffers. 
88
89   
90
91     @subsection sim libFMDsim:
92
93     This currently (18th or March 2006) contains the classes 
94
95     - AliFMDEdepMap: Cache of energy deposited and total number of
96       hits for each strip.  The digitiser AliFMDDigitizer uses this to
97       store simulation data before making digits.
98     - AliFMDHit: A hit in the FMD active elements, as described by the
99       simulation back-end during transport.
100     - AliFMD, AliFMDv0, AliFMDv1: Simulation drivers for the FMD.
101       AliFMD is the base class. AliFMDv0 corresponds to a simulation
102       where no hits are created, but the material distribution is
103       right.  AliFMDv1 is like AliFMDv0, except that hits are
104       produced.
105     - AliFMDGeometryBuilder: Build the FMD geometry in terms of TGeo
106       objects.  The information for building the geometry is retrieved
107       from AliFMDGeometry.
108     - AliFMDBaseDigitizer, AliFMDDigitizer, AliFMDSDigitizer: Base
109       class for the digitisers.  AliFMDDigitizer makes `real' digits
110       (AliFMDDigit) from hits, and AliFMDSDigitizer makes summable
111       digits from hits.
112     - AliFMDRawWriter: Writes a pseudo raw data file from the digits
113       created by the digitisers.  It uses the AliFMDAltroMapping from
114       AliFMDParameters to make the mapping from detector coordinates
115       to hardware addresses.
116
117     @subsection rec libFMDrec:
118
119     This currently (18th or March 2006) contains the classes 
120
121     - AliFMDReconstructor: Reconstruct (in a naiive way) the charged
122       particle multiplicity in the FMD strips.  This also writes an
123       AliESDFMD object to the ESD files (that class is in libESD).
124
125     - AliFMDRecPoint: Reconstructed point in the FMD.  These objects
126       are made AliFMDReconstructor. 
127
128     - AliFMDRawReader: Classes to read raw data files. 
129
130     @subsection util libFMDutil:
131
132     This currently (18th or March 2006) contains the classes 
133
134     - AliFMDInput, AliFMDInputHits, AliFMDInputDigits,
135       AliFMDInputSDigits, AliFMDInputRecPoints: Base class, and
136       concrete classes to read in FMD generated data.  These provide a
137       simple and unified way of getting the data.  Hooks are defined
138       to process hits, tracks, digits, and reconstructed points, as
139       well as geometry and ESD data.   See for example the scripts
140       @c DrawHits.C, @c DrawHitsDigits.C, @c DrawHitsRecs.C, @c
141       DrawDigitsRecs.C in the @c FMD/scripts sub-directory.
142
143     - AliFMDDisplay: Simple event display for FMD data, including
144       hits, digits, reconstructed points and ESD data. 
145
146     - AliFMDCalibFaker, AliFMDAlignFaker: Classes to write fake (or
147       dummy) calibration and alignment  data.  These derive from
148       TTask.  
149
150     @section script Scripts 
151     
152     Most scripts live in @c FMD/scripts.  The notiable exceptions are 
153     @ref Simulate.C, @ref Reconstruct.C, and @ref Config.C 
154
155     @section quick Quick start 
156
157     First, install ROOT.  Then Install TGeant3: 
158     @verbatim 
159     > cd ~/
160     > mkdir alice
161     > cd alice
162     > cvs -d :pserver:cvs@root.cern.ch:/user/cvs login 
163     Password: cvs
164     > cvs -d :pserver:cvs@root.cern.ch:/user/cvs co geant3
165     > cd geant3
166     > make 
167     @endverbatim 
168
169     Now you can install AliRoot 
170     @verbatim 
171     > cd ../
172     > cvs -d :pserver:cvs@alisoft.cern.ch:/soft/cvsroot login
173     Password: <empty>
174     > cvs -d :pserver:cvs@alisoft.cern.ch:/soft/cvsroot co AliRoot
175     > cd AliRoot
176     > export ALICE_TARGET=`root-config --arch`
177     > export ALICE=${HOME}/alice
178     > export ALICE_ROOT=${ALICE}/AliRoot
179     > export ALICE_LEVEL=new
180     > export LD_LIBRARY_PATH=${ALICE_ROOT}/lib/tgt_${ALICE_TERGET}:${LD_LIBRARY_PATH}
181     > export PATH=${ALICE_ROOT}/bin/tgt_${ALICE_TERGET}:${PATH}
182     > export G3SYS=${ALICE}/geant3
183     > make 
184     @endverbatim 
185     
186     To simulate one event, do something like 
187
188     @verbatim 
189     > aliroot ${ALICE_ROOT}/FMD/Simulate.C
190     @endverbatim 
191
192     To reconstruct the generated event, do 
193     @verbatim 
194     > aliroot ${ALICE_ROOT}/FMD/Reconstruct.C
195     @endverbatim 
196
197     Now, open the file `AliESDs.root' in AliRoot, and browse through  that. 
198
199     @section authors Authors:
200
201     - Alla Maevskaya            <Alla.Maevskaia@cern.ch>        
202     - Christian Holm Christensen        <cholm@nbi.dk>
203 */
204 /** @defgroup FMD_sim Simulation */
205
206 //____________________________________________________________________
207 //
208 //  Manager class for the FMD - Base class.
209 //  AliFMDv1, AliFMDv0, and AliFMDAlla 
210 //  provides concrete implementations. 
211 //  This class is sooooo crowded
212 //
213 #ifndef ALIDETECTOR_H  
214 # include <AliDetector.h>
215 #endif
216 #ifndef ROOT_TBranch
217 # include <TBranch.h>
218 #endif
219 class TBranch;
220 class TClonesArray;
221 class TBrowser;
222 class TMarker3DBox;
223 class AliDigitizer;
224 class AliFMDHit;
225
226 //____________________________________________________________________
227 /** @class AliFMD AliFMD.h <FMD/AliFMD.h>
228     @brief Forward Multiplicity Detector based on Silicon wafers. 
229     This class is the driver for especially simulation. 
230
231     The Forward Multiplicity Detector consists of 3 sub-detectors FMD1,
232     FMD2, and FMD3, each of which has 1 or 2 rings of silicon sensors. 
233                                                           
234     This is the base class for all FMD manager classes. 
235                        
236     The actual code is done by various separate classes.   Below is
237     diagram showing the relationship between the various FMD classes
238     that handles the simulation
239
240     @verbatim
241           +----------+   +----------+   
242           | AliFMDv1 |   | AliFMDv0 |   
243           +----------+   +----------+   
244                |              |                    +-----------------+
245           +----+--------------+                 +--| AliFMDDigitizer |
246           |                                     |  +-----------------+
247           |           +---------------------+   |
248           |        +--| AliFMDBaseDigitizer |<--+
249           V     1  |  +---------------------+   |
250      +--------+<>--+                            |  +------------------+
251      | AliFMD |                                 +--| AliFMDSDigitizer |    
252      +--------+<>--+                               +------------------+       
253                1  |  +---------------------+
254                   +--| AliFMDReconstructor |
255                      +---------------------+
256     @endverbatim
257                      
258     -  AliFMD 
259        This defines the interface for the various parts of AliROOT that
260        uses the FMD, like AliFMDSimulator, AliFMDDigitizer, 
261        AliFMDReconstructor, and so on. 
262     -  AliFMDv0
263        This is a concrete implementation of the AliFMD interface. 
264        It is the responsibility of this class to create the FMD
265        geometry.
266     -  AliFMDv1 
267        This is a concrete implementation of the AliFMD interface. 
268        It is the responsibility of this class to create the FMD
269        geometry, process hits in the FMD, and serve hits and digits to
270        the various clients. 
271     -  AliFMDSimulator
272        This is the base class for the FMD simulation tasks.   The
273        simulator tasks are responsible to implment the geoemtry, and
274        process hits. 
275     -  AliFMDReconstructor
276        This is a concrete implementation of the AliReconstructor that
277        reconstructs pseudo-inclusive-multiplicities from digits (raw or
278        from simulation)
279
280     Calibration and geometry parameters are managed by separate
281     singleton managers.  These are AliFMDGeometry and
282     AliFMDParameters.  Please refer to these classes for more
283     information on these.    
284  */
285 class AliFMD : public AliDetector 
286 {
287 public:
288   /** Default constructor.  Do not use. */
289   AliFMD();
290   /** Normal constructor 
291       @param name  Name of object.
292       @param title Title of object. */
293   AliFMD(const char *name, const char *title);
294   /** Copy constructor 
295       @param other Object to copy from */
296   AliFMD(const AliFMD& other);
297   /** Destructor */
298   virtual ~AliFMD(); 
299   /** Assignment operator 
300       @param other Object to assign from
301       @return Reference to this object  */
302   AliFMD& operator=(const AliFMD& other);
303   /** Wheter to make a detailed geometry
304       @param use If true, make detailed geometry  */
305   void UseDetailed(Bool_t use=kTRUE) { fDetailed = use; }
306   
307   /** @{*/
308   /** @name GEometry ANd Tracking (GEANT :-) */
309   /** Define the geometry.  This is done by asking the manager
310       AliFMDGeometry to construct the geometry.  This in turn calls
311       AliFMDGeometryBuilder.   */
312   virtual void   CreateGeometry();
313   /** Create the tracking mediums used by the FMD.  This associates
314       the tracking mediums defined with the FMD in the
315       TVirtualMCApplication (AliMC). 
316       
317       The defined mediums are 
318       - @c FMD @c Si$   Silicon (active medium in sensors)
319       - @c FMD @c C$    Carbon fibre (support cone for FMD3 and vacuum pipe)
320       - @c FMD @c Al$   Aluminium (honeycomb support plates)
321       - @c FMD @c PCB$  Printed Circuit Board (FEE board with VA1_3)
322       - @c FMD @c Chip$ Electronics chips (currently not used)
323       - @c FMD @c Air$  Air (Air in the FMD)
324       - @c FMD @c Plastic$ Plastic (Support legs for the hybrid cards)
325   */
326   virtual void   CreateMaterials(); 
327   /** Initialize this detector */
328   virtual void   Init();
329   /** This member function is called when ever a track deposites
330       energy (or similar) in an FMD tracking medium.  In this base
331       class this member function is pure abstract.   In concrete
332       sub-classes, the member function may make hits or other
333       stuff. */ 
334   virtual void   StepManager() = 0;
335   /** Called at the end of each simulation event.  If the debug level
336       is high enough a list of @e bad hits is printed. */
337   virtual void   FinishEvent();
338   /** @}*/
339   
340   /** @{*/
341   /** @name Graphics and event display */
342   /** Build simple ROOT TNode geometry for event display. With the new
343       geometry modeller, TGeoManager, this seems rather redundant. */
344   virtual        void   BuildGeometry();
345   /** Draw a shaded view of the Forward multiplicity detector.  This 
346       isn't really useful anymore. */
347   virtual        void   DrawDetector();
348   /** Calculate the distance from the mouse to the FMD on the screen
349       Dummy routine */
350   virtual        Int_t  DistanceToPrimitive(Int_t px, Int_t py);
351   /** Store x, y, z of all hits in memory for display. 
352       Normally, the hits are drawn using TPolyMarker3D - however, that
353       is not very useful for the FMD.  Therefor, this member function
354       is overloaded to make TMarker3D, via the class AliFMDPoints.
355       AliFMDPoints is a local class. 
356       @param track the track number to load the hits for */
357   virtual        void   LoadPoints(Int_t track);
358   /** @}*/
359   
360   /** @{ */
361   /** @name Hit and digit management */
362   /* Create Tree branches for the FMD.
363      @param opt  One of 
364      - @c H Make a branch of TClonesArray of AliFMDHit's
365      - @c D Make a branch of TClonesArray of AliFMDDigit's
366      - @c S Make a branch of TClonesArray of AliFMDSDigit's */
367   virtual void          MakeBranch(Option_t *opt=" ");
368   /** Set the TClonesArray to read hits into.
369       @param b The branch to containn the hits */
370   virtual void          SetHitsAddressBranch(TBranch *b);
371   /** Set branch address for the Hits, Digits, and SDigits Tree. */
372   virtual void          SetTreeAddress();
373   /** Get the array of summable digits
374       @return summable digits */
375   virtual TClonesArray* SDigits() { return fSDigits; }        
376   /** Reset the array of summable digits */
377   virtual void          ResetSDigits();
378   /** Add a hit to the hits tree 
379       @param  track  Track #
380       @param  vol Volume parameters, interpreted as 
381       - ivol[0]  [UShort_t ] Detector # 
382       - ivol[1]  [Char_t   ] Ring ID 
383       - ivol[2]  [UShort_t ] Sector #
384       - ivol[3]  [UShort_t ] Strip # 
385       @param hits Hit information 
386       - hits[0]  [Float_t  ] Track's X-coordinate at hit 
387       - hits[1]  [Float_t  ] Track's Y-coordinate at hit
388       - hits[3]  [Float_t  ] Track's Z-coordinate at hit
389       - hits[4]  [Float_t  ] X-component of track's momentum             
390       - hits[5]  [Float_t  ] Y-component of track's momentum             
391       - hits[6]  [Float_t  ] Z-component of track's momentum            
392       - hits[7]  [Float_t  ] Energy deposited by track                  
393       - hits[8]  [Int_t    ] Track's particle Id # 
394       - hits[9]  [Float_t  ] Time when the track hit */
395   virtual void          AddHit(Int_t track, Int_t *vol, Float_t *hits);
396   /** Add a hit to the list
397       @param track     Track #
398       @param detector  Detector # (1, 2, or 3)                      
399       @param ring      Ring ID ('I' or 'O')
400       @param sector    Sector # (For inner/outer rings: 0-19/0-39)
401       @param strip     Strip # (For inner/outer rings: 0-511/0-255)
402       @param x         Track's X-coordinate at hit
403       @param y         Track's Y-coordinate at hit
404       @param z         Track's Z-coordinate at hit
405       @param px        X-component of track's momentum 
406       @param py        Y-component of track's momentum
407       @param pz        Z-component of track's momentum
408       @param edep      Energy deposited by track
409       @param pdg       Track's particle Id #
410       @param t         Time when the track hit 
411       @param len       Track length through the material. 
412       @param stopped   Whether track was stopped or disappeared */
413   virtual AliFMDHit*    AddHitByFields(Int_t    track, 
414                                        UShort_t detector, 
415                                        Char_t   ring, 
416                                        UShort_t sector, 
417                                        UShort_t strip, 
418                                        Float_t  x=0,
419                                        Float_t  y=0, 
420                                        Float_t  z=0,
421                                        Float_t  px=0, 
422                                        Float_t  py=0, 
423                                        Float_t  pz=0,
424                                        Float_t  edep=0,
425                                        Int_t    pdg=0,
426                                        Float_t  t=0, 
427                                        Float_t  len=0, 
428                                        Bool_t   stopped=kFALSE);
429   /** Add a digit to the Digit tree 
430       @param digits
431       - digits[0]  [UShort_t] Detector #
432       - digits[1]  [Char_t]   Ring ID
433       - digits[2]  [UShort_t] Sector #
434       - digits[3]  [UShort_t] Strip #
435       - digits[4]  [UShort_t] ADC Count 
436       - digits[5]  [Short_t]  ADC Count, -1 if not used
437       - digits[6]  [Short_t]  ADC Count, -1 if not used 
438       @param notused Not used */
439   virtual        void   AddDigit(Int_t *digits, Int_t* notused=0);
440   /** add a real digit
441       @param detector  Detector # (1, 2, or 3)                      
442       @param ring         Ring ID ('I' or 'O')
443       @param sector       Sector # (For inner/outer rings: 0-19/0-39)
444       @param strip        Strip # (For inner/outer rings: 0-511/0-255)
445       @param count1    ADC count (a 10-bit word)
446       @param count2    ADC count (a 10-bit word), or -1 if not used
447       @param count3    ADC count (a 10-bit word), or -1 if not used */
448   virtual        void   AddDigitByFields(UShort_t detector=0, 
449                                          Char_t   ring='\0', 
450                                          UShort_t sector=0, 
451                                          UShort_t strip=0, 
452                                          UShort_t count1=0, 
453                                          Short_t  count2=-1, 
454                                          Short_t  count3=-1);
455   /** Add a digit to the Digit tree 
456       @param digits
457       - digits[0]  [UShort_t] Detector #
458       - digits[1]  [Char_t]   Ring ID
459       - digits[2]  [UShort_t] Sector #
460       - digits[3]  [UShort_t] Strip #
461       - digits[4]  [UShort_t] ADC Count 
462       - digits[5]  [Short_t]  ADC Count, -1 if not used
463       - digits[6]  [Short_t]  ADC Count, -1 if not used  */
464   virtual        void   AddSDigit(Int_t *digits);
465   /** add a summable digit - as coming from data
466       @param detector  Detector # (1, 2, or 3)                      
467       @param ring      Ring ID ('I' or 'O')
468       @param sector    Sector # (For inner/outer rings: 0-19/0-39)
469       @param strip     Strip # (For inner/outer rings: 0-511/0-255)
470       @param edep      Energy deposited   
471       @param count1    ADC count (a 10-bit word)
472       @param count2    ADC count (a 10-bit word), or -1 if not used 
473       @param count3    ADC count (a 10-bit word), or -1 if not used */
474   virtual        void   AddSDigitByFields(UShort_t detector=0, 
475                                           Char_t   ring='\0', 
476                                           UShort_t sector=0, 
477                                           UShort_t strip=0, 
478                                           Float_t  edep=0,
479                                           UShort_t count1=0, 
480                                           Short_t  count2=-1, 
481                                           Short_t  count3=-1);
482   /** @}*/
483
484   /** @{ */
485   /** @name Digitisation */
486   /** Create a digitizer object
487       @param manager Digitization manager
488       @return a newly allocated AliFMDDigitizer */
489   virtual AliDigitizer* CreateDigitizer(AliRunDigitizer* manager) const;
490   /** Create AliFMDDigit's from AliFMDHit's.  This is done by creating
491       an AliFMDDigitizer object, and executing it.  */
492   virtual        void   Hits2Digits();
493   /** Create AliFMDSDigit's from AliFMDHit's.  This is done by creating
494       an AliFMDSDigitizer object, and executing it.  */
495   virtual        void   Hits2SDigits();
496   /** @}*/
497
498   /** @{ */
499   /** @name Raw data */
500   /** Turn digits into raw data. This uses the class AliFMDRawWriter
501       to do the job.   Please refer to that class for more
502       information. */
503   virtual        void   Digits2Raw();
504   /** @}*/
505
506   /** @{ */
507   /** @name Utility */
508   /** Browse this object 
509       @param b Browser to show this object in */
510   void   Browse(TBrowser* b);
511   /** @}*/
512 protected:
513   /** Initialize hit array if not already done, and return pointert. 
514       @return Hit array */
515   TClonesArray*      HitsArray();
516   /** Initialize digit array if not already done, and return pointert. 
517       @return Digit array */
518   TClonesArray*      DigitsArray();
519   /** Initialize summable digit array if not already done, and return
520       pointert.  
521       @return Summable digit array */
522   TClonesArray*      SDigitsArray();
523
524   TClonesArray*      fSDigits;              // Summable digits
525   Int_t              fNsdigits;             // Number of digits  
526   Bool_t             fDetailed;             // Use detailed geometry
527   Bool_t             fUseOld;               // Use old approx geometry
528   Bool_t             fUseAssembly;          // Use divided volumes
529   
530   enum {
531     kSiId,                 // ID index of Si medium
532     kAirId,                // ID index of Air medium
533     kPlasticId,            // ID index of Plastic medium
534     kPcbId,                // ID index of PCB medium
535     kSiChipId,             // ID index of Si Chip medium
536     kAlId,                 // ID index of Al medium
537     kCarbonId,             // ID index of Carbon medium
538     kCopperId,             // ID index of Copper Medium
539     kKaptonId              // ID index of Kapton Medium
540   };  
541
542   TObjArray*         fBad;                  //! debugging - bad hits 
543   
544   ClassDef(AliFMD,11)     // Base class FMD entry point
545 };
546
547 #endif
548 //____________________________________________________________________
549 //
550 // Local Variables:
551 //   mode: C++
552 // End:
553 //
554 // EOF
555 //