Coding conventions (Christian)
[u/mrichter/AliRoot.git] / FMD / AliFMD.h
CommitLineData
d28dcc0d 1#ifndef ALIFMD_H
2#define ALIFMD_H
4347b38f 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 */
c2fc1258 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*/
9f662337 15/** @mainpage ALICE FMD Off-line code
f8616692 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)
9b48326f 24 - @ref script (see also @ref FMD_script)
f8616692 25 - @ref quick
26 - @ref authors
27
9f662337 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.
f8616692 56
9f662337 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
9b48326f 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
f8616692 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
9f662337 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 */
3da30618 205
37c4363a 206//____________________________________________________________________
207//
208// Manager class for the FMD - Base class.
088f8e79 209// AliFMDv1, AliFMDv0, and AliFMDAlla
210// provides concrete implementations.
211// This class is sooooo crowded
37c4363a 212//
9f662337 213#ifndef ALIDETECTOR_H
4347b38f 214# include <AliDetector.h>
215#endif
1a1fdef7 216class TBranch;
217class TClonesArray;
218class TBrowser;
bf000c32 219class TMarker3DBox;
1a1fdef7 220class AliDigitizer;
54240c8d 221class AliFMDHit;
4347b38f 222
223//____________________________________________________________________
9f662337 224/** @class AliFMD AliFMD.h <FMD/AliFMD.h>
225 @brief Forward Multiplicity Detector based on Silicon wafers.
226 This class is the driver for especially simulation.
227
228 The Forward Multiplicity Detector consists of 3 sub-detectors FMD1,
229 FMD2, and FMD3, each of which has 1 or 2 rings of silicon sensors.
230
231 This is the base class for all FMD manager classes.
232
233 The actual code is done by various separate classes. Below is
234 diagram showing the relationship between the various FMD classes
235 that handles the simulation
236
237 @verbatim
238 +----------+ +----------+
239 | AliFMDv1 | | AliFMDv0 |
240 +----------+ +----------+
241 | | +-----------------+
242 +----+--------------+ +--| AliFMDDigitizer |
243 | | +-----------------+
244 | +---------------------+ |
245 | +--| AliFMDBaseDigitizer |<--+
246 V 1 | +---------------------+ |
247 +--------+<>--+ | +------------------+
248 | AliFMD | +--| AliFMDSDigitizer |
249 +--------+<>--+ +------------------+
250 1 | +---------------------+
251 +--| AliFMDReconstructor |
252 +---------------------+
253 @endverbatim
254
255 - AliFMD
256 This defines the interface for the various parts of AliROOT that
257 uses the FMD, like AliFMDSimulator, AliFMDDigitizer,
258 AliFMDReconstructor, and so on.
259 - AliFMDv0
260 This is a concrete implementation of the AliFMD interface.
261 It is the responsibility of this class to create the FMD
262 geometry.
263 - AliFMDv1
264 This is a concrete implementation of the AliFMD interface.
265 It is the responsibility of this class to create the FMD
266 geometry, process hits in the FMD, and serve hits and digits to
267 the various clients.
268 - AliFMDSimulator
269 This is the base class for the FMD simulation tasks. The
270 simulator tasks are responsible to implment the geoemtry, and
271 process hits.
272 - AliFMDReconstructor
273 This is a concrete implementation of the AliReconstructor that
274 reconstructs pseudo-inclusive-multiplicities from digits (raw or
275 from simulation)
276
277 Calibration and geometry parameters are managed by separate
278 singleton managers. These are AliFMDGeometry and
279 AliFMDParameters. Please refer to these classes for more
280 information on these.
281 */
4347b38f 282class AliFMD : public AliDetector
283{
fe4da5cc 284public:
9f662337 285 /** Default constructor. Do not use. */
fe4da5cc 286 AliFMD();
9f662337 287 /** Normal constructor
288 @param name Name of object.
289 @param title Title of object. */
1a1fdef7 290 AliFMD(const char *name, const char *title);
9f662337 291 /** Copy constructor
292 @param other Object to copy from */
56b1929b 293 AliFMD(const AliFMD& other);
9f662337 294 /** Destructor */
4347b38f 295 virtual ~AliFMD();
9f662337 296 /** Assignment operator
297 @param other Object to assign from
298 @return Reference to this object */
56b1929b 299 AliFMD& operator=(const AliFMD& other);
9f662337 300 /** Wheter to make a detailed geometry
301 @param use If true, make detailed geometry */
54240c8d 302 void UseDetailed(Bool_t use=kTRUE) { fDetailed = use; }
4ac75127 303
9f662337 304 /** @{*/
305 /** @name GEometry ANd Tracking (GEANT :-) */
306 /** Define the geometry. This is done by asking the manager
307 AliFMDGeometry to construct the geometry. This in turn calls
308 AliFMDGeometryBuilder. */
4347b38f 309 virtual void CreateGeometry();
9f662337 310 /** Create the tracking mediums used by the FMD. This associates
311 the tracking mediums defined with the FMD in the
312 TVirtualMCApplication (AliMC).
313
314 The defined mediums are
315 - @c FMD @c Si$ Silicon (active medium in sensors)
316 - @c FMD @c C$ Carbon fibre (support cone for FMD3 and vacuum pipe)
317 - @c FMD @c Al$ Aluminium (honeycomb support plates)
318 - @c FMD @c PCB$ Printed Circuit Board (FEE board with VA1_3)
319 - @c FMD @c Chip$ Electronics chips (currently not used)
320 - @c FMD @c Air$ Air (Air in the FMD)
321 - @c FMD @c Plastic$ Plastic (Support legs for the hybrid cards)
322 */
4347b38f 323 virtual void CreateMaterials();
9f662337 324 /** Initialize this detector */
fe4da5cc 325 virtual void Init();
9f662337 326 /** This member function is called when ever a track deposites
327 energy (or similar) in an FMD tracking medium. In this base
328 class this member function is pure abstract. In concrete
329 sub-classes, the member function may make hits or other
330 stuff. */
4347b38f 331 virtual void StepManager() = 0;
9f662337 332 /** Called at the end of each simulation event. If the debug level
333 is high enough a list of @e bad hits is printed. */
54240c8d 334 virtual void FinishEvent();
9f662337 335 /** @}*/
54240c8d 336
9f662337 337 /** @{*/
338 /** @name Graphics and event display */
339 /** Build simple ROOT TNode geometry for event display. With the new
340 geometry modeller, TGeoManager, this seems rather redundant. */
4347b38f 341 virtual void BuildGeometry();
9f662337 342 /** Draw a shaded view of the Forward multiplicity detector. This
343 isn't really useful anymore. */
4347b38f 344 virtual void DrawDetector();
9f662337 345 /** Calculate the distance from the mouse to the FMD on the screen
346 Dummy routine */
02a27b50 347 virtual Int_t DistancetoPrimitive(Int_t px, Int_t py);
9f662337 348 /** Store x, y, z of all hits in memory for display.
349 Normally, the hits are drawn using TPolyMarker3D - however, that
350 is not very useful for the FMD. Therefor, this member function
351 is overloaded to make TMarker3D, via the class AliFMDPoints.
352 AliFMDPoints is a local class.
353 @param track the track number to load the hits for */
bf000c32 354 virtual void LoadPoints(Int_t track);
9f662337 355 /** @}*/
bf000c32 356
9f662337 357 /** @{ */
358 /** @name Hit and digit management */
359 /* Create Tree branches for the FMD.
360 @param opt One of
361 - @c H Make a branch of TClonesArray of AliFMDHit's
362 - @c D Make a branch of TClonesArray of AliFMDDigit's
363 - @c S Make a branch of TClonesArray of AliFMDSDigit's */
4347b38f 364 virtual void MakeBranch(Option_t *opt=" ");
9f662337 365 /** Set the TClonesArray to read hits into.
366 @param b The branch to containn the hits */
4347b38f 367 virtual void SetHitsAddressBranch(TBranch *b);
9f662337 368 /** Set branch address for the Hits, Digits, and SDigits Tree. */
4347b38f 369 virtual void SetTreeAddress();
9f662337 370 /** Get the array of summable digits
371 @return summable digits */
4347b38f 372 virtual TClonesArray* SDigits() { return fSDigits; }
9f662337 373 /** Reset the array of summable digits */
4347b38f 374 virtual void ResetSDigits();
9f662337 375 /** Add a hit to the hits tree
376 @param track Track #
f8616692 377 @param vol Volume parameters, interpreted as
9f662337 378 - ivol[0] [UShort_t ] Detector #
379 - ivol[1] [Char_t ] Ring ID
380 - ivol[2] [UShort_t ] Sector #
381 - ivol[3] [UShort_t ] Strip #
382 @param hits Hit information
383 - hits[0] [Float_t ] Track's X-coordinate at hit
384 - hits[1] [Float_t ] Track's Y-coordinate at hit
385 - hits[3] [Float_t ] Track's Z-coordinate at hit
386 - hits[4] [Float_t ] X-component of track's momentum
387 - hits[5] [Float_t ] Y-component of track's momentum
388 - hits[6] [Float_t ] Z-component of track's momentum
389 - hits[7] [Float_t ] Energy deposited by track
390 - hits[8] [Int_t ] Track's particle Id #
391 - hits[9] [Float_t ] Time when the track hit */
4347b38f 392 virtual void AddHit(Int_t track, Int_t *vol, Float_t *hits);
9f662337 393 /** Add a hit to the list
394 @param track Track #
395 @param detector Detector # (1, 2, or 3)
396 @param ring Ring ID ('I' or 'O')
397 @param sector Sector # (For inner/outer rings: 0-19/0-39)
398 @param strip Strip # (For inner/outer rings: 0-511/0-255)
399 @param x Track's X-coordinate at hit
400 @param y Track's Y-coordinate at hit
401 @param z Track's Z-coordinate at hit
402 @param px X-component of track's momentum
403 @param py Y-component of track's momentum
404 @param pz Z-component of track's momentum
405 @param edep Energy deposited by track
406 @param pdg Track's particle Id #
407 @param t Time when the track hit
f8616692 408 @param len Track length through the material.
409 @param stopped Whether track was stopped or disappeared */
54240c8d 410 virtual AliFMDHit* AddHitByFields(Int_t track,
69b696b9 411 UShort_t detector,
412 Char_t ring,
413 UShort_t sector,
414 UShort_t strip,
415 Float_t x=0,
416 Float_t y=0,
417 Float_t z=0,
418 Float_t px=0,
419 Float_t py=0,
420 Float_t pz=0,
421 Float_t edep=0,
422 Int_t pdg=0,
088f8e79 423 Float_t t=0,
424 Float_t len=0,
425 Bool_t stopped=kFALSE);
9f662337 426 /** Add a digit to the Digit tree
427 @param digits
428 - digits[0] [UShort_t] Detector #
429 - digits[1] [Char_t] Ring ID
430 - digits[2] [UShort_t] Sector #
431 - digits[3] [UShort_t] Strip #
432 - digits[4] [UShort_t] ADC Count
433 - digits[5] [Short_t] ADC Count, -1 if not used
434 - digits[6] [Short_t] ADC Count, -1 if not used
435 @param notused Not used */
69b696b9 436 virtual void AddDigit(Int_t *digits, Int_t* notused=0);
9f662337 437 /** add a real digit
438 @param detector Detector # (1, 2, or 3)
439 @param ring Ring ID ('I' or 'O')
440 @param sector Sector # (For inner/outer rings: 0-19/0-39)
441 @param strip Strip # (For inner/outer rings: 0-511/0-255)
442 @param count1 ADC count (a 10-bit word)
443 @param count2 ADC count (a 10-bit word), or -1 if not used
444 @param count3 ADC count (a 10-bit word), or -1 if not used */
69b696b9 445 virtual void AddDigitByFields(UShort_t detector=0,
446 Char_t ring='\0',
447 UShort_t sector=0,
448 UShort_t strip=0,
449 UShort_t count1=0,
450 Short_t count2=-1,
451 Short_t count3=-1);
9f662337 452 /** Add a digit to the Digit tree
453 @param digits
454 - digits[0] [UShort_t] Detector #
455 - digits[1] [Char_t] Ring ID
456 - digits[2] [UShort_t] Sector #
457 - digits[3] [UShort_t] Strip #
458 - digits[4] [UShort_t] ADC Count
459 - digits[5] [Short_t] ADC Count, -1 if not used
460 - digits[6] [Short_t] ADC Count, -1 if not used */
4347b38f 461 virtual void AddSDigit(Int_t *digits);
9f662337 462 /** add a summable digit - as coming from data
463 @param detector Detector # (1, 2, or 3)
f8616692 464 @param ring Ring ID ('I' or 'O')
465 @param sector Sector # (For inner/outer rings: 0-19/0-39)
466 @param strip Strip # (For inner/outer rings: 0-511/0-255)
467 @param edep Energy deposited
9f662337 468 @param count1 ADC count (a 10-bit word)
f8616692 469 @param count2 ADC count (a 10-bit word), or -1 if not used
470 @param count3 ADC count (a 10-bit word), or -1 if not used */
69b696b9 471 virtual void AddSDigitByFields(UShort_t detector=0,
472 Char_t ring='\0',
473 UShort_t sector=0,
474 UShort_t strip=0,
475 Float_t edep=0,
476 UShort_t count1=0,
477 Short_t count2=-1,
478 Short_t count3=-1);
9f662337 479 /** @}*/
4347b38f 480
9f662337 481 /** @{ */
482 /** @name Digitisation */
483 /** Create a digitizer object
484 @param manager Digitization manager
485 @return a newly allocated AliFMDDigitizer */
c92eb8ad 486 virtual AliDigitizer* CreateDigitizer(AliRunDigitizer* manager) const;
9f662337 487 /** Create AliFMDDigit's from AliFMDHit's. This is done by creating
488 an AliFMDDigitizer object, and executing it. */
4347b38f 489 virtual void Hits2Digits();
9f662337 490 /** Create AliFMDSDigit's from AliFMDHit's. This is done by creating
491 an AliFMDSDigitizer object, and executing it. */
4347b38f 492 virtual void Hits2SDigits();
9f662337 493 /** @}*/
4347b38f 494
9f662337 495 /** @{ */
496 /** @name Raw data */
497 /** Turn digits into raw data. This uses the class AliFMDRawWriter
498 to do the job. Please refer to that class for more
499 information. */
4347b38f 500 virtual void Digits2Raw();
9f662337 501 /** @}*/
4347b38f 502
9f662337 503 /** @{ */
504 /** @name Utility */
505 /** Browse this object
506 @param b Browser to show this object in */
4347b38f 507 void Browse(TBrowser* b);
9f662337 508 /** @}*/
4347b38f 509protected:
9f662337 510 /** Initialize hit array if not already done, and return pointert.
511 @return Hit array */
56b1929b 512 TClonesArray* HitsArray();
9f662337 513 /** Initialize digit array if not already done, and return pointert.
514 @return Digit array */
56b1929b 515 TClonesArray* DigitsArray();
9f662337 516 /** Initialize summable digit array if not already done, and return
517 pointert.
518 @return Summable digit array */
56b1929b 519 TClonesArray* SDigitsArray();
520
56b1929b 521 TClonesArray* fSDigits; // Summable digits
522 Int_t fNsdigits; // Number of digits
1a1fdef7 523 Bool_t fDetailed; // Use detailed geometry
4ac75127 524 Bool_t fUseOld; // Use old approx geometry
4ac75127 525 Bool_t fUseAssembly; // Use divided volumes
1a1fdef7 526
54e415a8 527 enum {
528 kSiId, // ID index of Si medium
529 kAirId, // ID index of Air medium
530 kPlasticId, // ID index of Plastic medium
531 kPcbId, // ID index of PCB medium
532 kSiChipId, // ID index of Si Chip medium
533 kAlId, // ID index of Al medium
534 kCarbonId, // ID index of Carbon medium
535 kCopperId, // ID index of Copper Medium
536 kKaptonId // ID index of Kapton Medium
537 };
538
54e415a8 539 TObjArray* fBad; //! debugging - bad hits
1a1fdef7 540
394d8216 541 ClassDef(AliFMD,11) // Base class FMD entry point
fe4da5cc 542};
dc8af42e 543
4347b38f 544#endif
545//____________________________________________________________________
546//
0d0e6995 547// Local Variables:
548// mode: C++
549// End:
550//
4347b38f 551// EOF
552//