new functionality and new class added
[u/mrichter/AliRoot.git] / MUON / READMEmchda.txt
1 // $Id$
2
3 /*! 
4
5 \page README_mchda Tracking DA
6  
7 The detector algorithms are implemented for the Muon Tracking in the AliRoot framework.
8 We currently have 3 DAs for MCH :
9
10 - MUONTRKPEDda.cxx for PEDESTAL runs, running at the end of data taking on each LDC.
11 - MUONTRKGAINda.cxx for CALIBRATION runs, running at the end of data taking on each LDC.
12 - MUONTRKOCCda.cxx for PHYSICS runs, running during data taking on each LDC.
13
14 \section da_s1 The Muon Tracking Calibration
15
16 The Muon tracking chambers needs three types of calibration in order to work properly 
17 (to be more precise pedestals are required, gains are needed to get the best charge measurement possible, and the occupancy
18  is needed in order not to spend all the reconstruction time in hot-spots). 
19
20 \subsection da_ss1 Pedestals
21
22 The front-end electronics performs an online zero suppression using a threshold level.
23 Those threshold levels for all channels (~ 1 million) have to be computed in a dedicated
24 PEDESTALS runs. During this runs the zero suppression is OFF and the pedestal level and the noise is obtained for each channel. The threshold for the FEE is obtained adding the pedestal level to 3 sigmas of the noise. 
25
26 The typical ECS sequence for pedestals is :
27
28 - Switch ON the electronics LV
29 - Boot the CROCUS 
30 - Configuration 
31 - Saving Configuration in an ascii file then transferring in the File eXchange Server (FXS)
32 - Zero suppression OFF
33 - Data taking (typically 400 events)
34 - The DA computes the mean and sigma (it runs in each LDC)
35 - The DA writes one ASCII file per LDC with the results in the File Exchange Server
36
37 Then the SHUTTLE process the ASCII files and store the result on the OCDB (Keyword=PEDESTALS)
38 Only configuration files corresponding to a change of the Muon Tracker configuration are written in the FXS (Keyword=CONFIG).
39
40
41 \subsection da_ss2 Electronics gain
42
43 In order to perform the required spatial resolution or the tracking chambers (~ 100 microns),
44 we need to calibrate the gain of each channel. The gain is computed using dedicated runs where
45 a signal (DAC) is send to the chambers FEE. 
46
47 The typical ECS sequence for calibration is :
48
49 - Switch ON the electronics LV
50 - Boot the CROCUS 
51 - Configuration 
52 - Zero suppression OFF
53 - Loop of 11 data taking (typically 400 events) each with a different signal (DAC=0-200- 400-800-1200-1600-2000-2500-3000-3500-4000)
54 - The DA computes the mean and sigma (it runs in each LDC) for each run
55 - At the end of the last run, the DA computes, by using a fitting procedure, linear and parabolic gain parameters, and writes results in one ASCII file per LDC. Every ascii files are transferred in the FXS.
56
57 Then the SHUTTLE process the ASCII files and store the result on the OCDB (KEYWORD=GAINS)
58
59 \subsection da_ss3 Occupancy
60
61 For PHYSICS (or STANDALONE) runs, the MUONTRKOCCda, which is a monitoring DA, keep track of how many times
62  each channel has been hit during the run. The output is an ASCII file containing the needed information to 
63  compute the occupancy values. This file is written to the DAQ FXS so the SHUTTLE can transfer it to the OCDB.
64
65 \section da_s2 Using the DA Online
66
67 \subsection da_ss1 Pedestals
68
69 The syntax is: MUONTRKPEDda.exe "raw data file"
70
71 Two input files located in the DAQ Detector database (DetDB) are needed:
72
73 - muontrkpedvalues is built in flight in CONFIGURATION_PED.sh (ECS script) and contains two parameters "config" and "writeconfig"
74   config = 1 if configuration file has to be used (OnLine case)
75   config = 0 if not (OffLine case for the time being)
76   writeconfig=0 if configuration is unchanged
77   writeconfig=1 if configuration is changed , then new config. file is written in DetDB
78
79 - config_ldc-MTRK-S3-0 : configuration file name corresponding to MuonTracker Station 3 if (for example) DA is running on ldc-MTRK-S3-0
80
81 - DA validation: see Header of MUONTRKPEDda.cxx for reference run, and corresponding input mutrkpedvalues and configuration files are located in path=/afs/cern.ch/user/j/jcharvet/public/DA_validation
82
83 \subsection da_ss2 Electonics gain
84
85 The syntax is: MUONTRKGAINda.exe "raw data file"
86
87 Two input files located in the DAQ Detector database (DetDB) are needed:
88
89 - muontrkcalibvalues: which attributes to each the run index (1->11) its corrresponding DAC value. The other parameters are used to tune the fit procedure (for expert). The last parameter indicates the number of events to be read: if "0" all events in the run are read, if not the parameter indicates the maximum number of events to be read. 
90 Default values are listed below
91
92 \verbatim
93 1 0                     
94 2 200
95 3 400
96 4 800
97 5 1200
98 6 1600
99 7 2000
100 8 2500
101 9 3000
102 10 3500
103 11 4000
104 1                                               
105 6
106 0
107 1
108 1
109 0
110 \endverbatim
111
112  - config_ldc-MTRK-S3-0 : configuration file name corresponding to MuonTracker station 3 if (for example) DA is running on ldc-MTRK-S3-0 
113
114 - DA validation: Header of MUONTRKGAINda.cxx shows the list of the 11 reference runs, and corresponding input mutrkcalibvalues and configuration files are located in path=/afs/cern.ch/user/j/jcharvet/public/DA_validation
115
116 \section da_s3 Using the DA Offline
117  
118 The DAs normally runs with a RAW data DATE format as input
119 The development of an Offline version is under way.
120
121 Nevertheless, Pedestal runs can be analysed locally, but without detector configuration file.  If you get a file in root format (e.g. from alien), you can de-rootify it using the
122   "deroot" program which is part of aliroot. 
123 Note that PED and GAIN DAs work with ROOT input files as well.
124
125 You have a line command help. To have it just type :
126
127 \verbatim
128 > MUONTRKPEDda.exe -h
129
130 ******************* ./MUONTRKPEDda.exe usage **********************
131 Online (called from ECS) : ./MUONTRKPEDda.exe <raw data file> (no inline options)
132
133 ./MUONTRKPEDda.exe can be used locally only with options (without DiMuon configuration file)
134 ./MUONTRKPEDda.exe -options, the available options are :
135 -h help                    (this screen)
136
137  Input
138 -f <raw data file>         (default = )
139
140  Output
141 -a <Flat ASCII file>       (default = MUONTRKPEDda.ped)
142
143  Options
144 -m <max date events>       (default = 1000000)
145 -s <skip events>           (default = 0)
146 -n <max events>            (default = 1000000)
147
148 \endverbatim
149
150   
151 \section da_s4 In case of trouble
152
153 Please contact :
154
155 Jean-Luc Charvet : jean-luc.charvet@cern.ch 
156 or
157 Alberto Baldisseri : a.baldisseri@cea.fr
158 or
159 Laurent Aphecetche : laurent.aphecetche@subatech.in2p3.fr (for OCC DA)
160
161 This chapter is defined in the READMEmchda.txt file.
162 */
163