source: trunk/documents/UserDoc/UsersGuides/ForApplicationDeveloper/html/Control/UIcommands/_gun_.html

Last change on this file was 1208, checked in by garnier, 16 years ago

CVS update
File size: 4.7 KB
Line 
1<html><head><title>Commands in /gun/</title></head>
2<body bgcolor="#ffffff"><h2>/gun/</h2><p>
3Particle Gun control commands.<br>
4<p><hr><p>
5<h2>Sub-directories : </h2><dl>
6</dl><p><hr><p>
7<h2>Commands : </h2><dl>
8<p><br><p><dt><b>List</b>
9<p><dd>
10List available particles.<br>
11 Invoke G4ParticleTable.<br>
12<p><dd>Available at all Geant4 states.
13<p><br><p><dt><b>particle [<i>particleName</i>]</b>
14<p><dd>
15Set particle to be generated.<br>
16 (geantino is default)<br>
17 (ion can be specified for shooting ions)<br>
18<p><dd>Available at all Geant4 states.
19<p><dd>Parameters<table border=1>
20<tr><td>particleName
21<td>type s
22<td>Omittable : default value = geantino
23<td>Parameter candidates : B+ B- B0 Bs0 D+ D- D0 Ds+ Ds- J/psi anti_B0 anti_Bs0 anti_D0 anti_kaon0 anti_lambda anti_lambda_c+ anti_neutron anti_nu_e anti_nu_mu anti_nu_tau anti_omega- anti_omega_c0 anti_proton anti_sigma+ anti_sigma- anti_sigma0 anti_sigma_c+ anti_sigma_c++ anti_sigma_c0 anti_xi- anti_xi0 anti_xi_c+ anti_xi_c0 chargedgeantino e+ e- eta gamma geantino kaon+ kaon- kaon0 kaon0L kaon0S lambda lambda_c+ mu+ mu- neutron nu_e nu_mu nu_tau omega- omega_c0 opticalphoton pi+ pi- pi0 proton sigma+ sigma- sigma0 sigma_c+ sigma_c++ sigma_c0 tau+ tau- xi- xi0 xi_c+ xi_c0 ion
24</table>
25<p><br><p><dt><b>direction [<i>Px</i>] [<i>Py</i>] [<i>Pz</i>]</b>
26<p><dd>
27Set momentum direction.<br>
28Direction needs not to be a unit vector.<br>
29<p><dd>Range : Px != 0 || Py != 0 || Pz != 0
30<p><dd>Available at all Geant4 states.
31<p><dd>Parameters<table border=1>
32<tr><td>Px
33<td>type d
34<td>Omittable : current value is used as the default value.
35<td><tr><td>Py
36<td>type d
37<td>Omittable : current value is used as the default value.
38<td><tr><td>Pz
39<td>type d
40<td>Omittable : current value is used as the default value.
41<td></table>
42<p><br><p><dt><b>energy [<i>Energy</i>] [<i>Unit</i>]</b>
43<p><dd>
44Set kinetic energy.<br>
45<p><dd>Available at all Geant4 states.
46<p><dd>Parameters<table border=1>
47<tr><td>Energy
48<td>type d
49<td>Omittable : current value is used as the default value.
50<td><tr><td>Unit
51<td>type s
52<td>Omittable : default value = GeV
53<td>Parameter candidates : eV keV MeV GeV TeV PeV J electronvolt kiloelectronvolt megaelectronvolt gigaelectronvolt teraelectronvolt petaelectronvolt joule
54</table>
55<p><br><p><dt><b>position [<i>X</i>] [<i>Y</i>] [<i>Z</i>] [<i>Unit</i>]</b>
56<p><dd>
57Set starting position of the particle.<br>
58<p><dd>Available at all Geant4 states.
59<p><dd>Parameters<table border=1>
60<tr><td>X
61<td>type d
62<td>Omittable : current value is used as the default value.
63<td><tr><td>Y
64<td>type d
65<td>Omittable : current value is used as the default value.
66<td><tr><td>Z
67<td>type d
68<td>Omittable : current value is used as the default value.
69<td><tr><td>Unit
70<td>type s
71<td>Omittable : default value = cm
72<td>Parameter candidates : pc km m cm mm um nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
73</table>
74<p><br><p><dt><b>time [<i>t0</i>] [<i>Unit</i>]</b>
75<p><dd>
76Set initial time of the particle.<br>
77<p><dd>Available at all Geant4 states.
78<p><dd>Parameters<table border=1>
79<tr><td>t0
80<td>type d
81<td>Omittable : current value is used as the default value.
82<td><tr><td>Unit
83<td>type s
84<td>Omittable : default value = ns
85<td>Parameter candidates : s ms mus ns ps second millisecond microsecond nanosecond picosecond
86</table>
87<p><br><p><dt><b>polarization [<i>Px</i>] [<i>Py</i>] [<i>Pz</i>]</b>
88<p><dd>
89Set polarization.<br>
90<p><dd>Range : Px&gt;=-1.&amp;&amp;Px&lt;=1.&amp;&amp;Py&gt;=-1.&amp;&amp;Py&lt;=1.&amp;&amp;Pz&gt;=-1.&amp;&amp;Pz&lt;=1.
91<p><dd>Available at all Geant4 states.
92<p><dd>Parameters<table border=1>
93<tr><td>Px
94<td>type d
95<td>Omittable : current value is used as the default value.
96<td><tr><td>Py
97<td>type d
98<td>Omittable : current value is used as the default value.
99<td><tr><td>Pz
100<td>type d
101<td>Omittable : current value is used as the default value.
102<td></table>
103<p><br><p><dt><b>number [<i>N</i>]</b>
104<p><dd>
105Set number of particles to be generated.<br>
106<p><dd>Range : N&gt;0
107<p><dd>Available at all Geant4 states.
108<p><dd>Parameters<table border=1>
109<tr><td>N
110<td>type i
111<td>Omittable : current value is used as the default value.
112<td></table>
113<p><br><p><dt><b>ion [<i>Z</i>] [<i>A</i>] [<i>Q</i>] [<i>E</i>]</b>
114<p><dd>
115Set properties of ion to be generated.<br>
116[usage] /gun/ion Z A Q<br>
117 Z:(int) AtomicNumber<br>
118 A:(int) AtomicMass<br>
119 Q:(int) Charge of Ion (in unit of e)<br>
120 E:(double) Excitation energy (in keV)<br>
121<p><dd>Available at all Geant4 states.
122<p><dd>Parameters<table border=1>
123<tr><td>Z
124<td>type i
125<td><td><tr><td>A
126<td>type i
127<td><td><tr><td>Q
128<td>type i
129<td>Omittable : default value = 0
130<td><tr><td>E
131<td>type d
132<td>Omittable : default value = 0.0
133<td></table>
134</dl></body></html>
Note: See TracBrowser for help on using the repository browser.