Removing classes for raw data -
[u/mrichter/AliRoot.git] / MUON / README
CommitLineData
50837721 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
88cb7938 18==========================================================
19Please add to this README file all information concerning
20config files, simulation, digitalization, clusterization,
21reconstruction and macro analysis
22
6b1e4b22 23==========================================================
24 How to check that your aliroot is working well
25==========================================================
8c4c70f6 26There is a script file AlirootRun_MUONtest.sh which
6b1e4b22 27allows for simulating, reconstructing and making the
28invariant analysis of the generated Upsilon (1S).
29The used configuration file is Config.C in MUON
30directory.
8c4c70f6 31You have to type :
32source $ALICE_ROOT/MUON/AlirootRun_MUONtest.sh
c57f3c5b 33The results of this test are saved in test_out/ directory.
60fff730 34Please note that the CDB (Condition DataBase) is now always *required*
35to perform either simulation or reconstruction. For the moment, a version
36 of that CDB is stored in CVS, so you should have one already in MUON/Calib
37subdirectories.
6b1e4b22 38
7f42a16f 39==========================================================
40 How to check that your aliroot is working VERY well
41==========================================================
42There is a script file AlirootRun_MUONlongtest.sh which
43allows for simulating, reconstructing and making the
44-+invariant analysis of the generated Upsilon (1S).
45This script generates a large number of Upsilon (20k)
46in order to access differential quantities.
47The used configuration file is Config.C in MUON
48directory.
49One should really run this script to check if the MUON
50code can process a large number of events WITHOUT errors,
51in particular before making important commits !!
52
53You have to type :
54$ALICE_ROOT/MUON/AlirootRun_MUONtestlong.sh
55The results of this test are saved in testlong_out/ directory
56and will be kept in CVS
57
58(NOTE: the macros performing the calculations/plots MUONefficiency.C
59and MUONplotEfficiency.C are also able to handle J/Psi if
60Config.C is modified accordingly )
61
88cb7938 62==========================================================
7985603c 63 How to run a MUON generation
88cb7938 64==========================================================
65aliroot
fc1fafa5 66root [0] gAlice->Run(10,"$ALICE_ROOT/MUON/Config.C");
88cb7938 67
681 single muon of 7 GeV/c in the MUON spectrometer
69acceptance will be simulated using geant3.
70Hit information will be store in the root file in the
71execution directory.
88cb7938 72If you want to change the option or to define a new directory
73for hits, you have to do the following before:
74root [0] gAlice->SetConfigFunction("Config( \"/home/martinez/aliroot/work_NewIO/test/\" , \"box\" );");
75
88cb7938 76============================================================
77 How to run MUONCheck macro
78============================================================
79To check the content of a root data file, the MUONCheck
80provides a ascii output on screen.
81
82To compile MUONCheck.C
2058bf30 83.includepath $ALICE_ROOT/STEER
84.includepath $ALICE_ROOT/MUON
bf485fb9 85.includepath $ALICE_ROOT/MUON/mapping
2058bf30 86.L $ALICE_ROOT/MUON/MUONCheck.C++
bf17dbfd 87To Load
88gSystem->Load("$ALICE_ROOT/MUON/MUONCheck_C.so")
2058bf30 89
278a86d5 90To print Kine : (default file is galice.root )
7d6677d7 91MUONkine() or MUONkine(##,"galice.root") for the event number ##
88cb7938 92
93To print hits : (default file is galice.root if not MUONhits("toto.root""); )
7d6677d7 94MUONhits() or MUONhits(##,"galice.root") for the event number ##
88cb7938 95
96To print digits : (default file is galice.root)
7d6677d7 97MUONdigits() or MUONdigits(##,"galice.root") for the event number ##
c57f3c5b 98
99To print sdigits : (default file is galice.root)
100MUONsdigits() or MUONsdigits(##,"galice.root") for the event number ##
88cb7938 101
102To print rawcluster : (default file is galice.root)
7d6677d7 103MUONrecpoints() or MUONrecpoints(##,"galice.root") for the event number ##
88cb7938 104
105To print trigger : (default file is galice.root)
7d6677d7 106MUONrectrigger() or MUONrectrigger(##,"galice.root") for the event number ##
2b32c661 107
108....
88cb7938 109
6570c14d 110============================================================
111 How to check the Geometry with the new Geometrical modeler
112 ftp://root.cern.ch/root/doc/chapter16.pdf
113 http://agenda.cern.ch/fullAgenda.php?ida=a05212
114============================================================
115gAlice->Init("$ALICE_ROOT/MUON/Config.C");
116gGeoManager->GetMasterVolume()->Draw();
117
02d8f072 118
b3ba6823 119============================================================
120 How to check the overlap with the new Geometrical modeler
121 ftp://root.cern.ch/root/doc/chapter16.pdf
122 http://agenda.cern.ch/fullAgenda.php?ida=a05212
123============================================================
124gAlice->Init("$ALICE_ROOT/MUON/Config.C");
125gGeoManager->CheckOverlaps();
126gGeoManager->PrintOverlaps();
127
7985603c 128============================================================
129 How to run MUONdisplay
130============================================================
1eccde20 131First you need to perform a full simulation:
7985603c 132generation, digitalisation and clusterisation
cd0f8cc8 133To run MUONdisplay with Root 5.04/00 you need to get a fix in
134the gpad/src/TPad.cxx from Root CVS:
135 cvs update -r 1.200 gpad/src/TPad.cxx
136and recompile root.
137
7985603c 138.L $ALICE_ROOT/MUON/MUONdisplay.C
139MUONdisplay(0,"galice.root")
140
02d8f072 141============================================================
142 Tracking parameters, cuts, energy loss and physics processes
143============================================================
144Tracking parameters in MUON are automatically defined by GEANT
145MUON takes the default values of CUTs and physics processes
146defined by the Config files, except for the gas mixture medium
147of the tracking chambers. The CUT's and physics processes of
148the gas mixture medium is then defined in the galice.cuts file
149in the data directory. In particular ILOSS parameter MUST be
150equal unity (1) in order simulate a realistic energy loss
151distribution (mean value and fluctuations) in the active gas.
a88eb0d0 152
153============================================================
154 Tracking of particle in the magnetic field
155============================================================
156GEANT has two ways for tracking charged particles in the
157magnetic field: HELIX et RKUTA.
158HELIX is faster and works well if the gradient of magnetic
159field is small.
160For MUON, HELIX is a not a good approximation and we must
161use RKUTA to get the optimal mass resolution of the
162spectrometer. The choice of HELIX or RKUTA is done in the
163config file when the magnetic field is defined:
164 AliMagFMaps* field = new AliMagFMaps("Maps","Maps", TRACKING, FACTOR, MAXB, AliMagFMaps::k4kG);
165 gAlice->SetField(field);
166TRACKING must be 1 for RKUTA and 2 for HELIX (the default value for aliroot is 2 (HELIX))
167FACTOR allows you to set the magnetic field to 0, just putting FACTOR=0. Default value is 1.
168MAXB is the maximum magnetic field which is 10.T
2b32c661 169
f4f795ed 170===========================================================
171 MUON cocktail for physics ..............
172===========================================================
173There is a MUON cocktail generator of the muon sources in the
174EVGEN directory. This class derives from AliGenCocktail.
175In the init of this class I have filled the cocktail with
176the muon sources: J/Psi, Upsilon, Open Charm, Open Beauty,
177Pion, Kaons. The code needs only the production cross section
178at 4pi (for the moment this values are in the code since I
179prefere them do not be modified), and the code calculates the
180rate of particles in the acceptance, making the scaling based
181on the number of collisions for the hard probes and on the
182number of participants for soft sources: Pions and Kaons.
183
184In the Genereate of this class all entries in the cocktail
185are called and we define a "primordial trigger" with requires
186a minimum number of muons above a Pt cut in the required acceptance.
187In order to normalized to the real number of simulated events,
188there are 2 data members in the class fNsuceeded adn fNGenerate
189which tell us what is the biais source.
190
191Enclose an example to use this generator:
192AliGenMUONCocktail * gener = new AliGenMUONCocktail();
193gener->SetPtRange(1.,100.); // Transverse momentum range
194gener->SetPhiRange(0.,360.); // Azimuthal angle range
195gener->SetYRange(-4.0,-2.4);
196gener->SetMuonPtCut(1.);
197gener->SetMuonThetaCut(171.,178.);
198gener->SetMuonMultiplicity(2);
35e21dec 199gener->SetImpactParameterRange(0.,5.); // 10% most centra PbPb collisions
f4f795ed 200gener->SetVertexSmear(kPerTrack);
201gener->SetOrigin(0,0,0); // Vertex position
202gener->SetSigma(0,0,0.0); // Sigma in (X,Y,Z) (cm) on IP position
203gener->Init();
204
a2da7817 205================================================================
69be760c 206 csh Script for the full reconstruction with raw data generator
a2da7817 207================================================================
208The rawdata generation and analysis is working with the new segmentation.
209So the config file must use the version "AliMUONFactoryV3"
210
211Generation
212The method AliSimulation::SetWriteRawData("MUON") enables on
213the muon rawdata generation
214aliroot -b << EOF
215AliSimulation MuonSim("$ALICE_ROOT/MUON/Config.C")
216MuonSim.SetWriteRawData("MUON")
217MuonSim.Run(10)
218.q
219EOF
220
221Reconstruction
222aliroot -b << EOF
223AliReconstruction MuonRec("galice.root");
224MuonRec.SetInput("$YOUR_WORKING_DIRECTORY/"); Do not forget the slash at the end!
225MuonRec.SetRunVertexFinder(kFALSE);
226MuonRec.SetRunLocalReconstruction("MUON");
227MuonRec.SetRunTracking("");
228MuonRec.SetFillESD("MUON");
8e0ae46c 229MuonRec.SetOption("MUON", "VS"); // to use VS cluster finder
230// MuonRec.SetOption("MUON", "VS Original"); // to run VS and original track finder
231// MuonRec.SetOption("MUON", "Combi"); // to run combined cluster / track finder
232MMuonRec.Run();
a2da7817 233.q
234EOF
235
a88eb0d0 236
b8dc484b 237
238============================================================
239 How to run MUONRecoCheck macro
240============================================================
241To check the muon reconstruction by comparing the reconstructed tracks
242with the reference tracks made of "AliTrackReference" for the hits and
243kinematic informations (TParticle) for the vertex.
244This macro can be used to check the track reconstruction e.g. efficiency,
245momentum resolution ... but also to make physics analysis whenever
246track identification is needed.
247
248To compile MUONRecoCheck.C
249.includepath $ALICE_ROOT/STEER
250.includepath $ALICE_ROOT/MUON
251.L $ALICE_ROOT/MUON/MUONRecoCheck.C+
252
253// To run MUONRecoCheck
254MUONRecoCheck(nEvent,"galice.root"); // nEvent = nb of events
255
29fc2c86 256
257============================================================
258 How to run MUONTracker macro
259============================================================
260To make the track reconstruction directly from AliTrackReference hits
261which are recorded in TrackRefs.root during the simulation.
262It can be used to check the reconstruction without clusterization.
263
264To compile MUONTracker.C
265.includepath $ALICE_ROOT/STEER
266.includepath $ALICE_ROOT/MUON
267.L $ALICE_ROOT/MUON/MUONTracker.C+
268
269// To run MUONTracker
270MUONTracker(iEventMin,iEventMax,"galice.root"); // iEventMin: first event
fc1fafa5 271
272===========================================================
273 Macro MUONGenerateGeometryData.C
274===========================================================
275
d228b279 276Macro for generating the geometry data files
277and mis-alignment data.
278
279Geometry data files:
280- MUON/data/volpath.dat file contains the volume paths
281for all alignable objects (modules & detection
282elements).
283- MUON/data/transform.dat file contains the transformations
284data (translation and rotation) for all alignable objects
285(modules & detection elements)
65087afe 286- MUON/data/svmap.dat file contains all the information to link
fc1fafa5 287each geant volume (it can be extended to other virtual MC) with
288a detection element. The point here is that a given detection
d228b279 289element, i.e. a slat chamber can consist of more geant volumes.
fc1fafa5 290the correspondence is then defined in an input file.
65087afe 291Each time there is a change in the definition of MC geometry, these
fc1fafa5 292input files must be re-generated via the macro
293MUONGenerateGeometryData.C
294
295To be run from aliroot:
296.x MUONGenerateGeometryData.C
297
298The generated files do not replace the existing ones
299but have different names (with extension ".out").
65087afe 300Replacement with new files has to be done manually.
29fc2c86 301
d228b279 302If the appropiate flags are set (zeroAlign, resMisAlign and/or fullMisAlign)
303zero, residual and/or full misalignment data are generated in a
304local CDB folder (defaults are ResMisAlignCDB and FullMisAlignCDB
305in the working directory). Inside the local CDB the path for the
306alignment data is (and must be) "MUON/Align/Data/".
307Residual misalignment: Default is our current estimate of
308misalignment after all our alignment procedure has been applied.
309Full misalignment: Default is our current estimate of initial
310misalignment.
311
312==========================================================
313How to simulate events with misaligned geometry in local CDB
314==========================================================
315
316If you want to use a misaligned geometry to simulate some
317events you can use a local CDB. For this need to follow
318the next steps:
319
320- Generate misaligned data in local CDB.
321You can use MUONGenerateGeometryData.C as described above in
322the corresponding section. Let's assume you used the default
323residual misalignment settings, then you have a local CDB in
324your working directory called ResMisAlignCDB containing
325misalignement data (ResMisAlignCDB/MUON/Align).
326
327- Copy the calibration data in your local CDB.
328cp -r $ALICE_ROOT/MUON/Calib ResMisAlignCDB/MUON
329
330- Tell AliSimulation you want to use your local CDB for MUON
331To do this you need to instantiate the AliCDBManager, set the
332default storage and set the specific storage for MUON, before
333instantiating AliSimulation (see for example the commented
334lines AlirootRun_MUONtest.sh).
335
336aliroot -b >& testSim.out << EOF
337AliCDBManager* man = AliCDBManager::Instance();
338man->SetDefaultStorage("local://$ALICE_ROOT");
339man->SetSpecificStorage("MUON","local://ResMisAlignCDB");
340AliSimulation MuonSim("$ALICE_ROOT/MUON/Config.C");
341MuonSim.SetWriteRawData("MUON");
342MuonSim.Run(10);
343.q
344EOF
29fc2c86 345
cd85a354 346==========================================================
347 How to Merge events
348==========================================================
349
350You can merge 2 types of simulated events. For example,
351you can simulate Hijing events, and then simulate muons
352merging both.
353
354Merging is done at the sdigits level, so Kinematics files
355of the merged events will just correspond to the
356Config.C simulated file (not to Config_HIJING.C).
357
358You must, first, do the Hijing simulation and store it
359in directory $HIJING_SIM. Note that for merging you
360won't need Kinematics files of the Hijing simulation...
361
362Hijing simulation
363
364aliroot -b << EOF
365AliSimulation HijingSim("$HIJING_SIM/Config_HIJING.C")
366HijingSim.Run(5)
367.q
368EOF
369
370
371Then you can do muon simulation and reconstruction
372merging both simulated events. In next example, we are
373merging 20 times each Hijing event in order to simulate
374100 muons merged with 5 Hijing events.
375
376
377aliroot -b << EOF
378AliSimulation MuonSim("$ALICE_ROOT/MUON/Config.C")
379MuonSim.MergeWith("$HIJING_SIM/galice.root",20) //parameters are the Hijing simulation file and the number of times we use each Hijing event
380MuonSim.Run(100) // number of muon (Config.C) events
381.q
382EOF
383
384
385aliroot -b << EOF
386TPluginManager * pluginmanager = gROOT->GetPluginManager()
387pluginmanager->AddHandler("AliReconstructor","MUON","AliMUONReconstructor","MUON","AliMUONReconstructor()")
388AliReconstruction MuonRec("galice.root")
389MuonRec.SetRunTracking("")
390MuonRec.SetRunVertexFinder(kFALSE)
391MuonRec.SetRunLocalReconstruction("MUON")
392MuonRec.SetFillESD("MUON")
393MuonRec.Run()
394.q
395EOF
396
60fff730 397==========================================================
398 How to play with the CDB
399==========================================================
400
401If you'd like to see how the CDB is created, please have a look at the
402MUONCDB.C (work in progress, though).
403
d228b279 404==========================================================
405...on track numbering
406==========================================================
407
408All generated particles, including primary and secondary
409particles are put on the stack. The secondary particles are kept
410in the stack only if they gave a hit in *any* of the ALICE detectors
411The number of all particles placed on the stack for a given event
412can be obtained with
413Int_t nPart = AliStack::GetNtrack();
414Looping from 0 to nPart via AliStack::Particle(ipart)
415gives the particle listing as obtained from the particle generator (primaries)
416and Monte Carlo (secondaries).
417
418The particle response in the detector, a hit, is registered
419in the hits tree and the hits are filled with each primary track.
420The total number of "tracks" (fills of the tree) can be obtained
421with ntracks = AliMUONData::GetNtracks() and is usually smaller than "nPart".
422Since particles can also deposit hits in other detectors than
423the MUON spectrometer, there will be many "tracks" (fills) in the hit-tree
424without a hit in MUON.
425
426The correspondence between "track ID" in the hits-tree ("itr") and the
427particle ID for particles on the stack (i.e. generated particles) can be
428obtained via:
429for (Int_t itr = 0; itr < ntracks; itr++) {
430 MUONData->GetTrack(itr); //track "itr" of the hits-tree
431 Int_t nhitstot = MUONData->Hits()->GetEntriesFast();
432 AliMUONHit* mHit;
433 for (Int_t ihit=0; ihit<nhitstot; ihit++) {
434 mHit = static_cast<AliMUONHit*>(MUONData->Hits()->At(ihit));
435 Int_t id = muonHit->Track(); //gives particle ID on stack
436 TParticle* particle = gAlice->Stack()->Particle(id);
437 }
438}
439
440During the procedure to go from hits to digits, the hits
441are summed up such that more than one track can contribute
442to a given digit. As a consequence the method
443Int_t AliMUONDigit::Track(Int_t trackID)
444takes an argument, where "trackID" runs from 0 to
445AliMUONDigit::Ntracks() to provide the reference to *all*
446tracks that contributed to it. The returned track ID is the one
447referred to in the hit-tree. To know which is the generated particle
448that deposited a given digit one has to follow the sequence of the kind:
449
450
451mDigit = static_cast<AliMUONDigit*>(digits->At(idigit));
452for (int tr = 0; tr < mDigit->Ntracks(); tr++){
453 Int_t hitTrackID = mDigit->Track(tr);
454 MUONData->GetTrack(hitTrackID);
455 mHit = static_cast<AliMUONHit*>(MUONData->Hits()->At(0));
456 //just take first hit of given track
457 Int_t numPart = mHit->Track(); //gives ID of particle on the stack
458 Int_t idTrack = mHit->Particle(); //gives flavour code of the particle
459}
460In this example, for simplicity, only the first hit of a
461hit-track is used to check the particle ID.
462
88cb7938 463===========================================================
464 Still working ..............
465===========================================================