Removing output of hit pointers in AliMUONTrack class. New switch in ALiMUONv1 for...
[u/mrichter/AliRoot.git] / MUON / README
1 /**************************************************************************
2  * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
3  *                                                                        *
4  * Author: The ALICE Off-line Project.                                    *
5  * Contributors are mentioned in the code where appropriate.              *
6  *                                                                        *
7  * Permission to use, copy, modify and distribute this software and its   *
8  * documentation strictly for non-commercial purposes is hereby granted   *
9  * without fee, provided that the above copyright notice appears in all   *
10  * copies and that both the copyright notice and this permission notice   *
11  * appear in the supporting documentation. The authors make no claims     *
12  * about the suitability of this software for any purpose. It is          *
13  * provided "as is" without express or implied warranty.                  *
14  **************************************************************************/
15
16 /* $Id$ */
17
18 ==========================================================
19 Please add  to this README file all information concerning 
20 config files, simulation, digitalization, clusterization, 
21 reconstruction and macro analysis
22
23 ==========================================================
24  How to run a MUON generation
25 ==========================================================
26 aliroot
27 root [0] gAlice->Run(10,"$ALICE_ROOT/MUON/Config_MUON_test.C");
28
29 1 single muon of 7 GeV/c in the MUON spectrometer 
30 acceptance will be simulated using geant3. 
31 Hit information will be store in the root file in the
32 execution directory.
33 If you want to change the option or to define a new directory
34 for hits, you have to do the following before:
35 root [0] gAlice->SetConfigFunction("Config( \"/home/martinez/aliroot/work_NewIO/test/\" , \"box\" );"); 
36
37 ============================================================
38  How to run MUON Digitalization
39 ============================================================
40 To process the digitalization of hits the AliRunDigitizer 
41 framework is used:
42
43 AliRunDigitizer   * manager = new AliRunDigitizer(1,1);
44 manager->SetInputStream(0,"galice.root");
45 AliMUONDigitizerv1* dMUON   = new AliMUONDigitizerv1(manager)
46 manager->AddDigitizer(dMUON);
47 manager->Exec("deb");
48
49 ============================================================
50  How to run MUON RecPoint clusterization
51 ============================================================
52 aliroot -b << EOF
53 .includepath $ALICE_ROOT/STEER
54 .includepath $ALICE_ROOT/MUON
55 .L $ALICE_ROOT/MUON/MUONrawclusters.C++
56 MUONrawclusters("galice.root",0,9999); 
57 to Load
58 gSystem->Load("$ALICE_ROOT/MUON/MUONrawclusters_C.so")
59
60 ============================================================
61  How to run MUON Trigger
62 ============================================================
63 .includepath $ALICE_ROOT/STEER
64 .includepath $ALICE_ROOT/MUON
65 .L $ALICE_ROOT/MUON/MUONtrigger.C++
66 MUONtrigger("galice.root",0,9999); 
67 To Load
68 gSystem->Load("$ALICE_ROOT/MUON/MUONtrigger_C.so")
69 ============================================================
70  How to run MUON Tracking reconstruction (old output)
71 ===========================================================
72 .includepath $ALICE_ROOT/STEER
73 .includepath $ALICE_ROOT/MUON
74 .L $ALICE_ROOT/MUON/MUONrecoNtuple.C++
75 MUONrecoNtuple(0,9999,0,"galice.root") 
76 To Load   
77 gSystem->Load("$ALICE_ROOT/MUON/MUONrecoNtuple_C.so")
78 First event and last event are given by hand, but this will change.
79
80 ===========================================================
81  How to run MUON Tracking reconstruction (new output)
82 ===========================================================
83 .includepath $ALICE_ROOT/STEER
84 .includepath $ALICE_ROOT/MUON
85 .L $ALICE_ROOT/MUON/MUONTracker.C++
86 MUONTracker("galice.root",0,9999);    
87 To Load
88 gSystem->Load("$ALICE_ROOT/MUON/MUONTracker_C.so")
89 Output in MUON.Tracks.root using the new IO 
90 as a TClonesArray of AliMUONTrack
91
92 Note1.In the actual version (dec-03) the following data 
93 members  of ALiMUONTrack:  fgFitter, fEventReconstructor, 
94 and fTrackHitsPtr are not saved in the MUON.Track.root file
95
96 ============================================================
97  How to run MUONCheck macro
98 ============================================================
99 To check the content of a root data file, the MUONCheck
100 provides a ascii output on screen.
101
102 To compile MUONCheck.C
103 .includepath $ALICE_ROOT/STEER
104 .includepath $ALICE_ROOT/MUON
105 .L $ALICE_ROOT/MUON/MUONCheck.C++
106 To Load
107 gSystem->Load("$ALICE_ROOT/MUON/MUONCheck_C.so")
108
109 To print Kine : (default file is galice.root )
110 MUONkine()
111
112 To print hits : (default file is galice.root if not MUONhits("toto.root""); )
113 MUONhits()  
114
115 To print digits : (default file is galice.root)
116 MUONdigits()  
117
118 To print rawcluster : (default file is galice.root)
119 MUONrecpoints()
120
121 To print trigger : (default file is galice.root)
122 MUONTestTrigger()
123
124
125 ============================================================
126  How to check the Geometry
127 ============================================================
128 gAlice->Init("$ALICE_ROOT/MUON/Config_MUON_test.C");
129 .L $ALICE/geant3/TGeant3/G3GUI.C
130 G3GUI()
131
132
133 ============================================================
134  How to run MUONdisplay
135 ============================================================
136 First you need to perform a full simulation: 
137 generation, digitalisation and clusterisation
138 .L $ALICE_ROOT/MUON/MUONdisplay.C
139 MUONdisplay(0,"galice.root")
140
141 ============================================================
142  Tracking parameters, cuts, energy loss and physics processes
143 ============================================================
144 Tracking parameters in MUON are automatically defined by GEANT
145 MUON takes the default values of CUTs  and physics processes
146 defined by the Config files, except for the gas mixture medium 
147 of the tracking chambers. The CUT's and physics processes of
148 the gas mixture medium  is then defined in the galice.cuts file
149 in the data directory. In particular ILOSS parameter MUST be
150 equal unity (1) in order simulate a realistic energy loss
151 distribution (mean value and fluctuations) in the active gas.
152
153 ============================================================
154  Tracking of particle in the magnetic field
155 ============================================================
156 GEANT has two ways for tracking charged particles in the 
157 magnetic field: HELIX et RKUTA.
158 HELIX is faster and works well if the gradient of magnetic 
159 field is small. 
160 For MUON, HELIX is a not a good approximation and we must 
161 use RKUTA to get the optimal mass resolution of the 
162 spectrometer. The choice of HELIX or RKUTA is done in the
163 config file when the magnetic field is defined:
164   AliMagFMaps* field = new AliMagFMaps("Maps","Maps", TRACKING, FACTOR, MAXB, AliMagFMaps::k4kG);
165   gAlice->SetField(field);
166 TRACKING must be 1 for RKUTA and 2 for HELIX (the default value for aliroot is 2 (HELIX))
167 FACTOR allows you to set the magnetic field to 0, just putting FACTOR=0. Default value is 1.
168 MAXB is the maximum magnetic field which is 10.T
169
170 ===========================================================
171  Still working ..............
172 ===========================================================