Changeset 1222 for trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/Visualization/visdrivers.xml

Timestamp:

Dec 16, 2009, 12:14:47 PM (15 years ago)

Author:

garnier

Message:

CVS update

File:

• trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/Visualization/visdrivers.xml (modified) (10 diffs)

trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/Visualization/visdrivers.xml

@@ -6 +6 @@
 <!--    Updates for Qt and HepRApp: Joseph Perl, Dec-2008     -->
 <!--    Added a reference: Laurent Garnier, Dec-2009          -->
+<!--    Updates for gMocren and HepRepFile:                   -->
+<!--                            Joseph Perl, Dec-2009         -->
 <!--                                                          -->
 <!-- ******************************************************** -->
@@ -64 +66 @@
   </para></listitem>
   <listitem><para>
+    <xref linkend="sect.VisDrv.Mocren" />
+    gMocren
+  </para></listitem>
+  <listitem><para>
     <xref linkend="sect.VisDrv.DetTree" />
     ASCIITree
@@ -310 +316 @@
 </para>
 <para>
-More informations can be found here :  <xref linkend="sect.VisCntCmmd.SvVwPs" />
+More information can be found here :  <xref linkend="sect.VisCntCmmd.SvVwPs" />
 </para>
 
@@ -364 +370 @@
   <listitem><para>
     <ulink url="http://geant4.slac.stanford.edu/Presentations/vis/G4OpenGLTutorial/G4OpenGLTutorial.html">
-    Geant4 Visualization Tutorial
+    http://geant4.slac.stanford.edu/Presentations/vis/G4OpenGLTutorial/G4OpenGLTutorial.html
     </ulink>
     using the OpenGL Graphics System
@@ -608 +614 @@
 
 <para>
-Several environment variables are available to override some of
+Several commands are available to override some of
 HepRepFile's defaults
 
@@ -614 +620 @@
   <listitem><para>
     You can specify a different directory for the heprep output
-    files by setting the environment variable G4HEPREPFILE_DIR, as in:
+    files by using the setFileDir command, as in:
 
     <informalexample>
     <programlisting>
-     export G4HEPREPFILE_DIR=someOtherDir/someOtherSubDir
+    /vis/heprep/setFileDir &lt;someOtherDir/someOtherSubDir&gt;
     </programlisting>
     </informalexample>
@@ -624 +630 @@
   <listitem><para>
     You can specify a different file name (the part before the
-    number) by setting the environment variable G4HEPREPFILE_NAME, as in:
+    number) by using the setFileName command, as in:
 
     <informalexample>
     <programlisting>
-     export G4HEPREPFILE_NAME=myFileName
+    /vis/heprep/setFileName &lt;my_file_name&gt;
     </programlisting>
     </informalexample>
 
-    which will produce files named myFileName0.heprep,
-    myFileName1.heprep, etc.
+    which will produce files named &lt;my_file_name&gt;0.heprep,
+    &lt;my_file_name&gt;1.heprep, etc.
   </para></listitem>
   <listitem><para>
     You can specify that each file should overwrite the previous
-    file (always rewriting to the same file name) by setting the
-    environment variable G4HEPREPFILE_OVERWRITE, as in:
+    file (always rewriting to the same file name) by using the setOverwrite command, as in:
 
     <informalexample>
     <programlisting>
-     export G4HEPREPFILE_OVERWRITE=1
+    /vis/heprep/setOverwrite true
     </programlisting>
     </informalexample>
@@ -661 +666 @@
     from the HepRep file. But for very large files, if you know that
     you will never want to make these parts visible, you can choose to
-    have them left entirely out of the file. Set the environment
-    variable G4HEPREPFILE_CULL, as in:
+    have them left entirely out of the file. Use the /vis/heprep/setCullInvisibles command, as in:
 
     <informalexample>
     <programlisting>
-     export G4HEPREPFILE_CULL=1
+    /vis/heprep/setCullInvisibles true
     </programlisting>
     </informalexample>
@@ -1473 +1477 @@
 </programlisting>
 </informalexample>
+</para>
+
+</sect2>
+
+
+<!-- ******************* Section (Level#2) ****************** -->
+<sect2 id="sect.VisDrv.Mocren">
+<title>
+gMocren
+</title>
+
+<para>
+The gMocrenFile driver creates a gdd file
+suitable for viewing with the gMocren volume visualizer.
+gMocren, a sophisticated tool for rendering volume data,
+can show volume data such as Geant4 dose distrubutions
+overlaid with scoring grids, trajectories and detector geometry.
+gMocren provides additional advanced functionality such as transfer functions, colormap editing,
+image rotation, image scaling, and image clipping.
+</para>
+
+<para>
+gMocren is further described at
+<ulink url="http://geant4.kek.jp/gMocren/">
+http://geant4.kek.jp/gMocren/
+</ulink>.
+At this link you will find the gMocren download, the user manual, a tutorial and some example gdd data files.
+</para>
+
+<para>
+Please note that the gMocren file driver is currently considered a Beta release.
+Users are encouraged to try this driver, and feedback is welcome, but users should be aware that features of
+this driver may change in upcoming releases.
+</para>
+
+<para>
+To send volume data from Geant4 scoring to a gMocren file, the user needs to tell the gMocren driver the
+name of the specific scoring volume that is to be displayed.
+For scoring done in C++, this is the name of the sensitive volume.
+For command-based scoring, this is the name of the scoring mesh.
+
+<informalexample>
+<programlisting>
+     /vis/gMocren/setVolumeName &lt;volume_name&gt;
+</programlisting>
+</informalexample>
+</para>
+
+<para>
+The following is an example of the minimum command sequence to send command-based scoring data to the a gMocren file:
+
+<informalexample>
+<programlisting>
+    # an example of a command-based scoring definition
+    /score/create/boxMesh scoringMesh       # name of the scoring mesh
+    /score/mesh/boxSize 10. 10. 10. cm      # dimension of the scoring mesh
+    /score/mesh/nBin 10 10 10               # number of divisions of the scoring mesh
+    /score/quantity/energyDeposit eDep      # quantity to be scored
+    /score/close
+    # configuration of the gMocren-file driver
+    /vis/scene/create
+    /vis/open gMocrenFile
+    /vis/gMocren/setVolumeName scoringMesh
+</programlisting>
+</informalexample>
+</para>
+
+<para>
+To add detector geometry to this file:
+
+<informalexample>
+<programlisting>
+    /vis/viewer/flush
+</programlisting>
+</informalexample>
+</para>
+
+<para>
+To add trajectories and primitive scorer hits to this file:
+
+<informalexample>
+<programlisting>
+    /vis/scene/add/trajectories
+    /vis/scene/add/pshits
+    /run/beamOn 1
+</programlisting>
+</informalexample>
+</para>
+
+<para>
+gMocrenFile will write a file named G4_00.gd to the current directory.
+Subsequent draws will create files named g4_01.gdd, g4_02.gdd, etc.
+An alternate output directory can be specified with an environment variable:
+
+<informalexample>
+<programlisting>
+    export G4GMocrenFile_DEST_DIR=&lt;someOtherDir/someOtherSubDir/&gt;
+</programlisting>
+</informalexample>
+</para>
+
+<para>
+View the resuling gMocren files with the gMocren viewer, available from:
+<ulink url="http://geant4.kek.jp/gMocren/">
+http://geant4.kek.jp/gMocren/
+</ulink>.
 </para>
 
@@ -1597 +1707 @@
 <para>
 The GAGTree driver provides a listing of the detector geometry tree
-within GAG, the Geant Adaptive GUI, (
-<ulink url="http://erpc1.naruto-u.ac.jp/~geant4">
-http://erpc1.naruto-u.ac.jp/~geant4
-</ulink>
-). GAG allows "folding/un-folding" a part of the geometry tree, using
+within GAG, the Geant Adaptive GUI, from $G4INSTALL/environments/MOMO/MOMO.jar.
+GAG allows "folding/un-folding" a part of the geometry tree, using
 the <emphasis>Tree Widget</emphasis> in Java: