1 README file for ALICE Forward Multiplicity Detector Off-line Code
2 =================================================================
7 This file contains a short overview of the FMD code. It is by no
8 means authoritative - only the code is good for that. However, I'll
9 try to explain things a bit here.
14 There are 4 libraries build for the FMD. These are
17 This contains the basic stuff, like data classes and managers.
20 This contains code used by the simulation only. That includes the
21 detector class AliFMD and it's derivatives. It also contains the
22 code for building the geometry, as well as the digitisers and raw
26 Code needed for the reconstruction. This include the reconstruction
27 code itself, as well as a raw data reader.
30 This is a special library that contains various utility classes for
31 the FMD expert/developer/tester. It includes code to read all data
32 produced by the FMD, a simple event display, and code to make fake
33 calibration and alignment data. This library is _not_ loaded by
34 aliroot automatically. The user has to load it herself:
36 gSystem->Load("libFMDutil.so");
38 The content of these libraries is detailed more below.
43 This currently (18th or March 2006) contains the classes
48 Base class for digits, real digits, and summable digits. The
49 are all data classes that holds the ADC value(s) for a single
53 A map of booleans, one for each strip.
56 A map of unsigned short integers, one for each strip.
62 3 classes that holds the parameters for each of the 3
63 FMD sub-detectors. These derive from AliFMDDetector, and are
64 managed by AliFMDGeometry. Each of these also contains the
65 translation from sensor reference frame to global reference
69 Parameters for the FMD rings (inner and outer type). These are
70 managed by AliFMDGeometry.
73 Manager of FMD geometry data. All code queries this manager
74 for geometry parameters, so that the data is always consistent.
77 Manager of FMD parameters, like calibration parameters. This
78 class fetches data from CDB if necessary. All code queries
79 this manager for parameters, so that the data is always
86 Containers of calibration parameters. These correspond to the
87 pedestal and its width, the gain of each strip, the
88 oversampling rate used in read-out, and the map from hardware
95 This currently (18th or March 2006) contains the classes
98 Cache of energy deposited and total number of hits for each
99 strip. The digitiser AliFMDDigitizer uses this to store
100 simulation data before making digits.
103 A hit in the FMD active elements, as described by the
104 simulation back-end during transport.
109 Simulation drivers for the FMD. AliFMD is the base
110 class. AliFMDv0 corresponds to a simulation where no hits are
111 created, but the material distribution is right. AliFMDv1 is
112 like AliFMDv0, except that hits are produced.
114 AliFMDGeometryBuilder
115 Build the FMD geometry in terms of TGeo objects. The
116 information for building the geometry is retrieved from
122 Base class for the digitisers. AliFMDDigitizer makes `real'
123 digits (AliFMDDigit) from hits, and AliFMDSDigitizer makes
124 summable digits from hits.
127 Writes a pseudo raw data file from the digits created by the
128 digitisers. It uses the AliFMDAltroMapping from
129 AliFMDParameters to make the mapping from detector coordinates
130 to hardware addresses.
135 This currently (18th or March 2006) contains the classes
138 Reconstruct (in a naiive way) the charged particle
139 multiplicity in the FMD strips. This also writes an
140 AliESDFMD object to the ESD files (that class is in libESD).
143 Reconstructed point in the FMD. These objects are made
148 Classes to read raw data files.
153 This currently (18th or March 2006) contains the classes
160 Base class, and concrete classes to read in FMD generated
161 data. These provide a simple and unified way of getting the
162 data. Hooks are defined to process hits, tracks, digits, and
163 reconstructed points, as well as geometry and ESD data. See
164 for example the scripts `DrawHits.C', `DrawHitsDigits.C',
165 `DrawHitsRecs.C', `DrawDigitsRecs.C' in the `scripts'
169 Simple event display for FMD data, including hits, digits,
170 reconstructed points and ESD data.
174 Classes to write fake (or dummy) calibration and alignment
175 data. These derive from TTask. The usage of these classes
179 f.Set... // Set parameters if needed
185 Alla Maevskaya <Alla.Maevskaia@cern.ch>
186 Christian Holm Christensen <cholm@nbi.dk>
188 ----------------------------------------------------------------------
193 LocalWords: libFMDbase libFMDsim AliFMD libFMDutil aliroot gSystem naiive ESD
194 LocalWords: CDB AliFMDGeometry AliFMDDetector AliFMDUShortMap AliFMDBoolMap
195 LocalWords: AliFMDBaseDigit AliFMDDigit AliFMDSDigit AliFMDRing AliFMDEdepMap
196 LocalWords: AliFMDParameters AliFMDCalibPedestal AliFMDCalibGain AliFMDHit
197 LocalWords: AliFMDCalibSampleRate AliFMDAltroMapping AliFMDv AliFMDDigitizer
198 LocalWords: AliFMDGeometryBuilder AliFMDBaseDigitizer AliFMDSDigitizer TGeo
199 LocalWords: AliFMDRawWriter libFMDrec AliESDFMD AliFMDReconstructor libESD
200 LocalWords: AliFMDRecPoint AliFMDRawStream AliFMDRawReader AliFMDInput TTask
201 LocalWords: AliFMDInputHits AliFMDInputDigits AliFMDInputSDigits Maevskaya
202 LocalWords: AliFMDInputRecPoints AliFMDDisplay AliFMDCalibFaker Holm booleans
203 LocalWords: AliFMDAlignFaker