source: trunk/documents/UserDoc/DocBookUsersGuides/IntroductionToGeant4/xml/AllResources/.ls/_vis_rayTracer_.html

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

ajout de la doc
File size: 5.1 KB
Line 
1<html><head><title>Commands in /vis/rayTracer/</title></head>
2<body bgcolor="#ffffff"><h2>/vis/rayTracer/</h2><p>
3RayTracer 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>trace [<i>fileName</i>]</b>
9<p><dd>
10Start the ray tracing.<br>
11Define the name of output JPEG file.<br>
12<p><dd>Available Geant4 state(s) : Idle
13<p><dd>Parameters<table border=1>
14<tr><td>fileName
15<td>type s
16<td>Omittable : default value = g4RayTracer.jpeg
17<td></table>
18<p><br><p><dt><b>column [<i>nPixel</i>]</b>
19<p><dd>
20Define the number of horizontal pixels.<br>
21<p><dd>Range : nPixel &gt; 0
22<p><dd>Available at all Geant4 states.
23<p><dd>Parameters<table border=1>
24<tr><td>nPixel
25<td>type i
26<td><td></table>
27<p><br><p><dt><b>row [<i>nPixel</i>]</b>
28<p><dd>
29Define the number of virtical pixels.<br>
30<p><dd>Range : nPixel &gt; 0
31<p><dd>Available at all Geant4 states.
32<p><dd>Parameters<table border=1>
33<tr><td>nPixel
34<td>type i
35<td><td></table>
36<p><br><p><dt><b>target [<i>X</i>] [<i>Y</i>] [<i>Z</i>] [<i>Unit</i>]</b>
37<p><dd>
38Define the center position of the target.<br>
39<p><dd>Available at all Geant4 states.
40<p><dd>Parameters<table border=1>
41<tr><td>X
42<td>type d
43<td>Omittable : default value = 0
44<td><tr><td>Y
45<td>type d
46<td>Omittable : default value = 0
47<td><tr><td>Z
48<td>type d
49<td>Omittable : default value = 0
50<td><tr><td>Unit
51<td>type s
52<td>Omittable : default value = m
53<td>Parameter candidates : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
54</table>
55<p><br><p><dt><b>eyePosition [<i>X</i>] [<i>Y</i>] [<i>Z</i>] [<i>Unit</i>]</b>
56<p><dd>
57Define the eye position.<br>
58Eye direction is calsurated from (target - eyePosition).<br>
59<p><dd>Available at all Geant4 states.
60<p><dd>Parameters<table border=1>
61<tr><td>X
62<td>type d
63<td>Omittable : default value = 0
64<td><tr><td>Y
65<td>type d
66<td>Omittable : default value = 0
67<td><tr><td>Z
68<td>type d
69<td>Omittable : default value = 0
70<td><tr><td>Unit
71<td>type s
72<td>Omittable : default value = m
73<td>Parameter candidates : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
74</table>
75<p><br><p><dt><b>lightDirection [<i>Px</i>] [<i>Py</i>] [<i>Pz</i>]</b>
76<p><dd>
77Define the direction of illumination light.<br>
78The vector needs not to be a unit vector, but it must not be a zero vector.<br>
79<p><dd>Range : Px != 0 || Py != 0 || Pz != 0
80<p><dd>Available at all Geant4 states.
81<p><dd>Parameters<table border=1>
82<tr><td>Px
83<td>type d
84<td>Omittable : default value = 0.1
85<td><tr><td>Py
86<td>type d
87<td>Omittable : default value = 0.2
88<td><tr><td>Pz
89<td>type d
90<td>Omittable : default value = 0.3
91<td></table>
92<p><br><p><dt><b>span [<i>span</i>] [<i>Unit</i>]</b>
93<p><dd>
94Define the angle per 100 pixels.<br>
95<p><dd>Range : span&gt;0.
96<p><dd>Available at all Geant4 states.
97<p><dd>Parameters<table border=1>
98<tr><td>span
99<td>type d
100<td>Omittable : default value = 50
101<td><tr><td>Unit
102<td>type s
103<td>Omittable : default value = deg
104<td>Parameter candidates : rad mrad sr deg radian milliradian steradian degree
105</table>
106<p><br><p><dt><b>headAngle [<i>headAngle</i>] [<i>Unit</i>]</b>
107<p><dd>
108Define the head direction.<br>
109<p><dd>Range : headAngle&gt;=0. &amp;&amp; headAngle&lt;360.
110<p><dd>Available at all Geant4 states.
111<p><dd>Parameters<table border=1>
112<tr><td>headAngle
113<td>type d
114<td>Omittable : default value = 270
115<td><tr><td>Unit
116<td>type s
117<td>Omittable : default value = deg
118<td>Parameter candidates : rad mrad sr deg radian milliradian steradian degree
119</table>
120<p><br><p><dt><b>attenuation [<i>Length</i>] [<i>Unit</i>]</b>
121<p><dd>
122Define the attenuation length for transparent material.<br>
123Note that this value is independent to the attenuation length for the optical photon processes.<br>
124<p><dd>Range : Length &gt; 0.
125<p><dd>Available at all Geant4 states.
126<p><dd>Parameters<table border=1>
127<tr><td>Length
128<td>type d
129<td>Omittable : default value = 1
130<td><tr><td>Unit
131<td>type s
132<td>Omittable : default value = m
133<td>Parameter candidates : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
134</table>
135<p><br><p><dt><b>distortion [<i>flag</i>]</b>
136<p><dd>
137Distortion effect of the fish eye lens.<br>
138<p><dd>Available at all Geant4 states.
139<p><dd>Parameters<table border=1>
140<tr><td>flag
141<td>type b
142<td>Omittable : default value = 0
143<td></table>
144<p><br><p><dt><b>ignoreTransparency [<i>flag</i>]</b>
145<p><dd>
146Ignore transparency even if the alpha of G4Colour &lt; 1.<br>
147<p><dd>Available at all Geant4 states.
148<p><dd>Parameters<table border=1>
149<tr><td>flag
150<td>type b
151<td>Omittable : default value = 0
152<td></table>
153<p><br><p><dt><b>backgroundColour [<i>red</i>] [<i>green</i>] [<i>blue</i>]</b>
154<p><dd>
155Set background colour: red green blue: range 0.-&gt;1.<br>
156E.g: /vis/rayTracer/backgroundColour 0 0 0<br>
157<p><dd>Available at all Geant4 states.
158<p><dd>Parameters<table border=1>
159<tr><td>red
160<td>type d
161<td>Omittable : default value = 1
162<td><tr><td>green
163<td>type d
164<td>Omittable : default value = 1
165<td><tr><td>blue
166<td>type d
167<td>Omittable : default value = 1
168<td></table>
169</dl></body></html>
Note: See TracBrowser for help on using the repository browser.