MUON/README

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