musrsim/geant4/TaoLEMuSR/doc/commands/_vis_rayTracer_.html
2008-03-20 09:23:20 +00:00

170 lines
5.1 KiB
HTML

<html><head><title>Commands in /vis/rayTracer/</title></head>
<body bgcolor="#ffffff"><h2>/vis/rayTracer/</h2><p>
RayTracer commands.<br>
<p><hr><p>
<h2>Sub-directories : </h2><dl>
</dl><p><hr><p>
<h2>Commands : </h2><dl>
<p><br><p><dt><b>trace [<i>fileName</i>]</b>
<p><dd>
Start the ray tracing.<br>
Define the name of output JPEG file.<br>
<p><dd>Available Geant4 state(s) : Idle
<p><dd>Parameters<table border=1>
<tr><td>fileName
<td>type s
<td>Omittable : default value = g4RayTracer.jpeg
<td></table>
<p><br><p><dt><b>column [<i>nPixel</i>]</b>
<p><dd>
Define the number of horizontal pixels.<br>
<p><dd>Range : nPixel &gt; 0
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>nPixel
<td>type i
<td><td></table>
<p><br><p><dt><b>row [<i>nPixel</i>]</b>
<p><dd>
Define the number of virtical pixels.<br>
<p><dd>Range : nPixel &gt; 0
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>nPixel
<td>type i
<td><td></table>
<p><br><p><dt><b>target [<i>X</i>] [<i>Y</i>] [<i>Z</i>] [<i>Unit</i>]</b>
<p><dd>
Define the center position of the target.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>X
<td>type d
<td>Omittable : default value = 0
<td><tr><td>Y
<td>type d
<td>Omittable : default value = 0
<td><tr><td>Z
<td>type d
<td>Omittable : default value = 0
<td><tr><td>Unit
<td>type s
<td>Omittable : default value = m
<td>Parameter candidates : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
</table>
<p><br><p><dt><b>eyePosition [<i>X</i>] [<i>Y</i>] [<i>Z</i>] [<i>Unit</i>]</b>
<p><dd>
Define the eye position.<br>
Eye direction is calsurated from (target - eyePosition).<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>X
<td>type d
<td>Omittable : default value = 0
<td><tr><td>Y
<td>type d
<td>Omittable : default value = 0
<td><tr><td>Z
<td>type d
<td>Omittable : default value = 0
<td><tr><td>Unit
<td>type s
<td>Omittable : default value = m
<td>Parameter candidates : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
</table>
<p><br><p><dt><b>lightDirection [<i>Px</i>] [<i>Py</i>] [<i>Pz</i>]</b>
<p><dd>
Define the direction of illumination light.<br>
The vector needs not to be a unit vector, but it must not be a zero vector.<br>
<p><dd>Range : Px != 0 || Py != 0 || Pz != 0
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>Px
<td>type d
<td>Omittable : default value = 0.1
<td><tr><td>Py
<td>type d
<td>Omittable : default value = 0.2
<td><tr><td>Pz
<td>type d
<td>Omittable : default value = 0.3
<td></table>
<p><br><p><dt><b>span [<i>span</i>] [<i>Unit</i>]</b>
<p><dd>
Define the angle per 100 pixels.<br>
<p><dd>Range : span&gt;0.
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>span
<td>type d
<td>Omittable : default value = 50
<td><tr><td>Unit
<td>type s
<td>Omittable : default value = deg
<td>Parameter candidates : rad mrad sr deg radian milliradian steradian degree
</table>
<p><br><p><dt><b>headAngle [<i>headAngle</i>] [<i>Unit</i>]</b>
<p><dd>
Define the head direction.<br>
<p><dd>Range : headAngle&gt;=0. &amp;&amp; headAngle&lt;360.
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>headAngle
<td>type d
<td>Omittable : default value = 270
<td><tr><td>Unit
<td>type s
<td>Omittable : default value = deg
<td>Parameter candidates : rad mrad sr deg radian milliradian steradian degree
</table>
<p><br><p><dt><b>attenuation [<i>Length</i>] [<i>Unit</i>]</b>
<p><dd>
Define the attenuation length for transparent material.<br>
Note that this value is independent to the attenuation length for the optical photon processes.<br>
<p><dd>Range : Length &gt; 0.
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>Length
<td>type d
<td>Omittable : default value = 1
<td><tr><td>Unit
<td>type s
<td>Omittable : default value = m
<td>Parameter candidates : pc km m cm mm mum nm Ang fm parsec kilometer meter centimeter millimeter micrometer nanometer angstrom fermi
</table>
<p><br><p><dt><b>distortion [<i>flag</i>]</b>
<p><dd>
Distortion effect of the fish eye lens.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>flag
<td>type b
<td>Omittable : default value = 0
<td></table>
<p><br><p><dt><b>ignoreTransparency [<i>flag</i>]</b>
<p><dd>
Ignore transparency even if the alpha of G4Colour &lt; 1.<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>flag
<td>type b
<td>Omittable : default value = 0
<td></table>
<p><br><p><dt><b>backgroundColour [<i>red</i>] [<i>green</i>] [<i>blue</i>]</b>
<p><dd>
Set background colour: red green blue: range 0.-&gt;1.<br>
E.g: /vis/rayTracer/backgroundColour 0 0 0<br>
<p><dd>Available at all Geant4 states.
<p><dd>Parameters<table border=1>
<tr><td>red
<td>type d
<td>Omittable : default value = 1
<td><tr><td>green
<td>type d
<td>Omittable : default value = 1
<td><tr><td>blue
<td>type d
<td>Omittable : default value = 1
<td></table>
</dl></body></html>