[u/mrichter/AliRoot.git] / MUON / README

/**************************************************************************
 * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
 *                                                                        *
 * Author: The ALICE Off-line Project.                                    *
 * Contributors are mentioned in the code where appropriate.              *
 *                                                                        *
 * Permission to use, copy, modify and distribute this software and its   *
 * documentation strictly for non-commercial purposes is hereby granted   *
 * without fee, provided that the above copyright notice appears in all   *
 * copies and that both the copyright notice and this permission notice   *
 * appear in the supporting documentation. The authors make no claims     *
 * about the suitability of this software for any purpose. It is          *
 * provided "as is" without express or implied warranty.                  *
 **************************************************************************/

/* $Id$ */

==========================================================
Please add  to this README file all information concerning 
config files, simulation, digitalization, clusterization, 
reconstruction and macro analysis

==========================================================
 How to check that your aliroot is working well
==========================================================
There is a script file AlirootRun_MUONtest.script which 
allows for simulating, reconstructing and making the
invariant analysis of the generated Upsilon (1S).
The used configuration file is Config.C in MUON 
directory.
There you have to type :

source $ALICE_ROOT/MUON/AlirootRun_MUONtest.script

If you do not recover a few Upsilons in their mass region 
in the file MUONmassPlot.root

==========================================================
 How to run a MUON generation
==========================================================
aliroot
root [0] gAlice->Run(10,"$ALICE_ROOT/MUON/Config.C");

1 single muon of 7 GeV/c in the MUON spectrometer 
acceptance will be simulated using geant3. 
Hit information will be store in the root file in the
execution directory.
If you want to change the option or to define a new directory
for hits, you have to do the following before:
root [0] gAlice->SetConfigFunction("Config( \"/home/martinez/aliroot/work_NewIO/test/\" , \"box\" );"); 

============================================================
 How to run MUONCheck macro
============================================================
To check the content of a root data file, the MUONCheck
provides a ascii output on screen.

To compile MUONCheck.C
.includepath $ALICE_ROOT/STEER
.includepath $ALICE_ROOT/MUON
.includepath $ALICE_ROOT/MUON/mapping
.L $ALICE_ROOT/MUON/MUONCheck.C++
To Load
gSystem->Load("$ALICE_ROOT/MUON/MUONCheck_C.so")

To print Kine : (default file is galice.root )
MUONkine() or MUONkine("galice.root",##) for the event number ##

To print hits : (default file is galice.root if not MUONhits("toto.root""); )
MUONhits()  or MUONhits("galice.root",##) for the event number ##

To print digits : (default file is galice.root)
MUONdigits()  or MUONdigits("galice.root",##) for the event number ##

To print rawcluster : (default file is galice.root)
MUONrecpoints() or MUONrecpoints("galice.root",##) for the event number ##

To print trigger : (default file is galice.root)
MUONrectrigger() or MUONrectrigger("galice.root",##) for the event number ##

....

============================================================
 How to check the Geometry 
============================================================
gAlice->Init("$ALICE_ROOT/MUON/Config.C");
.L $ALICE/geant3/TGeant3/G3GUI.C
G3GUI()

============================================================
 How to check the Geometry with the new Geometrical modeler
 ftp://root.cern.ch/root/doc/chapter16.pdf
 http://agenda.cern.ch/fullAgenda.php?ida=a05212
============================================================
gAlice->Init("$ALICE_ROOT/MUON/Config.C");
gGeoManager->GetMasterVolume()->Draw();


============================================================
 How to run MUONdisplay
============================================================
First you need to perform a full simulation: 
generation, digitalisation and clusterisation
To run MUONdisplay with Root 5.04/00 you need to get a fix in
the gpad/src/TPad.cxx from Root CVS:
 cvs update -r 1.200 gpad/src/TPad.cxx
and recompile root. 

.L $ALICE_ROOT/MUON/MUONdisplay.C
MUONdisplay(0,"galice.root")

============================================================
 Tracking parameters, cuts, energy loss and physics processes
============================================================
Tracking parameters in MUON are automatically defined by GEANT
MUON takes the default values of CUTs  and physics processes
defined by the Config files, except for the gas mixture medium 
of the tracking chambers. The CUT's and physics processes of
the gas mixture medium  is then defined in the galice.cuts file
in the data directory. In particular ILOSS parameter MUST be
equal unity (1) in order simulate a realistic energy loss
distribution (mean value and fluctuations) in the active gas.

============================================================
 Tracking of particle in the magnetic field
============================================================
GEANT has two ways for tracking charged particles in the 
magnetic field: HELIX et RKUTA.
HELIX is faster and works well if the gradient of magnetic 
field is small. 
For MUON, HELIX is a not a good approximation and we must 
use RKUTA to get the optimal mass resolution of the 
spectrometer. The choice of HELIX or RKUTA is done in the
config file when the magnetic field is defined:
  AliMagFMaps* field = new AliMagFMaps("Maps","Maps", TRACKING, FACTOR, MAXB, AliMagFMaps::k4kG);
  gAlice->SetField(field);
TRACKING must be 1 for RKUTA and 2 for HELIX (the default value for aliroot is 2 (HELIX))
FACTOR allows you to set the magnetic field to 0, just putting FACTOR=0. Default value is 1.
MAXB is the maximum magnetic field which is 10.T

===========================================================
 MUON cocktail for physics ..............
===========================================================
There is a MUON cocktail generator of the muon sources in the
EVGEN directory. This class derives from AliGenCocktail.
In the init of this class I have filled the cocktail with 
the muon sources: J/Psi, Upsilon, Open Charm, Open Beauty, 
Pion, Kaons. The code needs only the production cross section 
at 4pi (for the moment this values are in the code since I 
prefere them do not be modified), and the code calculates the  
rate of particles in the acceptance, making the scaling based 
on the number of collisions for the hard probes and on the  
number of participants for soft sources: Pions and Kaons.

In the Genereate of this class all entries in the cocktail 
are called and we define a "primordial trigger" with requires 
a minimum number of muons above a Pt cut in the required acceptance.
In order to normalized to the real number of simulated events, 
there are 2 data members in the class fNsuceeded adn fNGenerate 
which tell us what is the biais source.

Enclose an example to use this generator:   
AliGenMUONCocktail * gener = new AliGenMUONCocktail();
gener->SetPtRange(1.,100.);       // Transverse momentum range  
gener->SetPhiRange(0.,360.);    // Azimuthal angle range 
gener->SetYRange(-4.0,-2.4);
gener->SetMuonPtCut(1.);
gener->SetMuonThetaCut(171.,178.);
gener->SetMuonMultiplicity(2);
gener->SetImpactParameterRange(0.,5.); // 10% most centra PbPb collisions
gener->SetVertexSmear(kPerTrack);  
gener->SetOrigin(0,0,0);        // Vertex position
gener->SetSigma(0,0,0.0);       // Sigma in (X,Y,Z) (cm) on IP position
gener->Init();
 
================================================================
 csh Script for the full reconstruction with raw data generator
================================================================
The rawdata generation and analysis is working with the new segmentation.
So the config file must use the version "AliMUONFactoryV3"

Generation
The method AliSimulation::SetWriteRawData("MUON") enables on 
the muon rawdata generation
aliroot -b << EOF  
AliSimulation MuonSim("$ALICE_ROOT/MUON/Config.C")
MuonSim.SetWriteRawData("MUON")
MuonSim.Run(10)
.q
EOF

Reconstruction
aliroot -b << EOF 
AliReconstruction MuonRec("galice.root");
MuonRec.SetInput("$YOUR_WORKING_DIRECTORY/");  Do not forget the slash at the end!
MuonRec.SetRunVertexFinder(kFALSE);
MuonRec.SetRunLocalReconstruction("MUON");
MuonRec.SetRunTracking("");
MuonRec.SetFillESD("MUON");
MuonRec.SetOption("MUON", "AZ Kalman"); // to use AZ clustering and Kalman filter
MuonRec.Run();
.q
EOF


============================================================
 How to run MUONRecoCheck macro
============================================================
To check the muon reconstruction by comparing the reconstructed tracks
with the reference tracks made of "AliTrackReference" for the hits and
kinematic informations (TParticle) for the vertex.
This macro can be used to check the track reconstruction e.g. efficiency,
momentum resolution ... but also to make physics analysis whenever
track identification is needed.   

To compile MUONRecoCheck.C
.includepath $ALICE_ROOT/STEER
.includepath $ALICE_ROOT/MUON
.L $ALICE_ROOT/MUON/MUONRecoCheck.C+

// To run MUONRecoCheck
MUONRecoCheck(nEvent,"galice.root"); // nEvent = nb of events


============================================================
 How to run MUONTracker macro
============================================================
To make the track reconstruction directly from AliTrackReference hits 
which are recorded in TrackRefs.root during the simulation.
It can be used to check the reconstruction without clusterization.	

To compile MUONTracker.C
.includepath $ALICE_ROOT/STEER
.includepath $ALICE_ROOT/MUON
.L $ALICE_ROOT/MUON/MUONTracker.C+

// To run MUONTracker
MUONTracker(iEventMin,iEventMax,"galice.root"); // iEventMin: first event

===========================================================
 Macro  MUONGenerateGeometryData.C
===========================================================
						
Macro for generating the geometry data files:
(transform_*.dat, svmap_*.dat).
- MUON/data/transform_*dat files contain all the information 
about the transformation (traslation + rotation) needed for 
the positionning of each detection element of the MUON
spectrometer.
- MUON/data/svmap_*.dat files contain all the information to link 
each geant volume (it can be extended to other virtual MC) with
a detection element. The point here is that a given detection
element, i.e. a slat chamber consists of many geant volumes.
the correspondence is then defined in an input file.
Eanch time there is a change in the virtual MC geometry, these
input files must be re-generated via the macro  
MUONGenerateGeometryData.C

To be run from aliroot:
.x MUONGenerateGeometryData.C

The generated files do not replace the existing ones
but have different names (with extension ".out").
To compare/replace the existing files with generated ones
run the scripts in MUON/data:
compare_data.sh [transform] [svmap ]
reset_data.sh [transform] [svmap ]
Author: I. Hrivnacova, IPN Orsay


===========================================================
 Still working ..............
===========================================================
Commit	Line	Data
	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.script 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	There you have to type :
	32
	33	source $ALICE_ROOT/MUON/AlirootRun_MUONtest.script
	34
	35	If you do not recover a few Upsilons in their mass region
	36	in the file MUONmassPlot.root
	37
	38	==========================================================
	39	How to run a MUON generation
	40	==========================================================
	41	aliroot
	42	root [0] gAlice->Run(10,"$ALICE_ROOT/MUON/Config.C");
	43
	44	1 single muon of 7 GeV/c in the MUON spectrometer
	45	acceptance will be simulated using geant3.
	46	Hit information will be store in the root file in the
	47	execution directory.
	48	If you want to change the option or to define a new directory
	49	for hits, you have to do the following before:
	50	root [0] gAlice->SetConfigFunction("Config( \"/home/martinez/aliroot/work_NewIO/test/\" , \"box\" );");
	51
	52	============================================================
	53	How to run MUONCheck macro
	54	============================================================
	55	To check the content of a root data file, the MUONCheck
	56	provides a ascii output on screen.
	57
	58	To compile MUONCheck.C
	59	.includepath $ALICE_ROOT/STEER
	60	.includepath $ALICE_ROOT/MUON
	61	.includepath $ALICE_ROOT/MUON/mapping
	62	.L $ALICE_ROOT/MUON/MUONCheck.C++
	63	To Load
	64	gSystem->Load("$ALICE_ROOT/MUON/MUONCheck_C.so")
	65
	66	To print Kine : (default file is galice.root )
	67	MUONkine() or MUONkine("galice.root",##) for the event number ##
	68
	69	To print hits : (default file is galice.root if not MUONhits("toto.root""); )
	70	MUONhits() or MUONhits("galice.root",##) for the event number ##
	71
	72	To print digits : (default file is galice.root)
	73	MUONdigits() or MUONdigits("galice.root",##) for the event number ##
	74
	75	To print rawcluster : (default file is galice.root)
	76	MUONrecpoints() or MUONrecpoints("galice.root",##) for the event number ##
	77
	78	To print trigger : (default file is galice.root)
	79	MUONrectrigger() or MUONrectrigger("galice.root",##) for the event number ##
	80
	81	....
	82
	83	============================================================
	84	How to check the Geometry
	85	============================================================
	86	gAlice->Init("$ALICE_ROOT/MUON/Config.C");
	87	.L $ALICE/geant3/TGeant3/G3GUI.C
	88	G3GUI()
	89
	90	============================================================
	91	How to check the Geometry 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->GetMasterVolume()->Draw();
	97
	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::k4kG);
	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.SetWriteRawData("MUON")
	188	MuonSim.Run(10)
	189	.q
	190	EOF
	191
	192	Reconstruction
	193	aliroot -b << EOF
	194	AliReconstruction MuonRec("galice.root");
	195	MuonRec.SetInput("$YOUR_WORKING_DIRECTORY/"); Do not forget the slash at the end!
	196	MuonRec.SetRunVertexFinder(kFALSE);
	197	MuonRec.SetRunLocalReconstruction("MUON");
	198	MuonRec.SetRunTracking("");
	199	MuonRec.SetFillESD("MUON");
	200	MuonRec.SetOption("MUON", "AZ Kalman"); // to use AZ clustering and Kalman filter
	201	MuonRec.Run();
	202	.q
	203	EOF
	204
	205
	206
	207	============================================================
	208	How to run MUONRecoCheck macro
	209	============================================================
	210	To check the muon reconstruction by comparing the reconstructed tracks
	211	with the reference tracks made of "AliTrackReference" for the hits and
	212	kinematic informations (TParticle) for the vertex.
	213	This macro can be used to check the track reconstruction e.g. efficiency,
	214	momentum resolution ... but also to make physics analysis whenever
	215	track identification is needed.
	216
	217	To compile MUONRecoCheck.C
	218	.includepath $ALICE_ROOT/STEER
	219	.includepath $ALICE_ROOT/MUON
	220	.L $ALICE_ROOT/MUON/MUONRecoCheck.C+
	221
	222	// To run MUONRecoCheck
	223	MUONRecoCheck(nEvent,"galice.root"); // nEvent = nb of events
	224
	225
	226	============================================================
	227	How to run MUONTracker macro
	228	============================================================
	229	To make the track reconstruction directly from AliTrackReference hits
	230	which are recorded in TrackRefs.root during the simulation.
	231	It can be used to check the reconstruction without clusterization.
	232
	233	To compile MUONTracker.C
	234	.includepath $ALICE_ROOT/STEER
	235	.includepath $ALICE_ROOT/MUON
	236	.L $ALICE_ROOT/MUON/MUONTracker.C+
	237
	238	// To run MUONTracker
	239	MUONTracker(iEventMin,iEventMax,"galice.root"); // iEventMin: first event
	240
	241	===========================================================
	242	Macro MUONGenerateGeometryData.C
	243	===========================================================
	244
	245	Macro for generating the geometry data files:
	246	(transform_.dat, svmap_.dat).
	247	- MUON/data/transform_*dat files contain all the information
	248	about the transformation (traslation + rotation) needed for
	249	the positionning of each detection element of the MUON
	250	spectrometer.
	251	- MUON/data/svmap_*.dat files contain all the information to link
	252	each geant volume (it can be extended to other virtual MC) with
	253	a detection element. The point here is that a given detection
	254	element, i.e. a slat chamber consists of many geant volumes.
	255	the correspondence is then defined in an input file.
	256	Eanch time there is a change in the virtual MC geometry, these
	257	input files must be re-generated via the macro
	258	MUONGenerateGeometryData.C
	259
	260	To be run from aliroot:
	261	.x MUONGenerateGeometryData.C
	262
	263	The generated files do not replace the existing ones
	264	but have different names (with extension ".out").
	265	To compare/replace the existing files with generated ones
	266	run the scripts in MUON/data:
	267	compare_data.sh [transform] [svmap ]
	268	reset_data.sh [transform] [svmap ]
	269	Author: I. Hrivnacova, IPN Orsay
	270
	271
	272	===========================================================
	273	Still working ..............
	274	===========================================================