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