Back to home page

EIC code displayed by LXR

 
 

    


Warning, /geant4/examples/advanced/human_phantom/README is written in an unsupported language. File is not indexed.

0001 -------------------------------------------------------------------
0002 
0003      =========================================================
0004                         Geant4 - human_phantom example 
0005      =========================================================
0006 
0007                                  README
0008                           -----------------------
0009 
0010 Past Authors:  G. Guerrieri, S. Guatelli, M. G. Pia (pia@ge.infn.it),INFN Genova, Italy.
0011 Current authors (since 2007): S. Guatelli (susanna@uow.edu.au), University of Wollongong, Australia.
0012 Contributions by F. Ambroglini (filippo.ambroglini@pg.infn.it), INFN Perugia, Italy.
0013 
0014 The example is based on code developed by G. Guerrieri, University of Genova, Italy.
0015 
0016 ------> Introduction
0017 
0018 The human_phantom example models anthropomorphic phantoms for
0019 Geant4 simulations.
0020 Two models are available: MIRD [1] and ORNL [2] (Male and Female for each approach).
0021 
0022 [1] W.S. Snyder, et al, "MIRD Pamphlet No. 5 Revised, Estimates of 
0023 absorbed fractions for monoenergetic photon sources uniformly distributed 
0024 in various organs of a heterogeneous phantom",
0025 J. Nucl. Med. Suppl., no. 3, pp. 5-52, 1969.
0026 
0027 [2] M. Cristy and K. F. Eckerman, "Specific absorbed fractions of energy 
0028 at various ages from internal photon sources", ORNL/TM-8381/VI, Apr. 1987.
0029 
0030 Note: Currently the ORNL phantom is under review.
0031 
0032 -----> Geometry 
0033 
0034 The process of building a phantom is handled through the Builder 
0035 design pattern.
0036 The creation of coherent models of the human phantom is handled through 
0037 an Abstract Factory design pattern.
0038 
0039 The organs of the MIRD phantom are implemented in hard-code; the organs of 
0040 the ORNL phantom are handled through GDML (Geometry Description Markup Language,
0041 www.cern.ch/gdml). The materials of the MIRD model are defined in the
0042 class G4HumanPhantomMaterial. The materials of the ORNL model are defined in 
0043 the GDML files.
0044 If using ORNL phantom model with no GDML set-up a segmentation
0045 fault will be otained when running the simulation.
0046 The gdml files describing the MIRD phantoms are not used in the example
0047 but are there as reference for users.
0048 
0049 -----> Physics
0050 
0051 Particles: charged particles, gamma, geantino
0052 Physics list: electromagnetic processes are modelled.
0053 The threshold of production of secondary particles is set to 1 * mm.
0054 
0055 -----> Primary particles
0056 
0057 The G4 General Particle Source is used to generate primary radiation field.
0058 Macro primary.mac contains the definition of the primary radiation field.   
0059 
0060 -----> Energy deposit
0061 
0062 The energy deposit is calculated in the organs of the phantom.
0063 At the end of the execution of the simulation  the summary of the total energy deposit in 
0064 each organ is print out.
0065 
0066 Currently for ORNL model the energy deposition is calculated in the head only.
0067 
0068 If the sensitivity is not set ( /bodypart/addBodyPart organName no ), 
0069 the energy deposit is not calculated in the specific organ.
0070 
0071 The energy deposit is calculated in each voxel of the parameterised breast.
0072 
0073 -----> Analysis
0074 The analysis is activated by default.
0075 
0076 **** SEQUENTIAL MODE *************
0077 output file: g4humanphantom.root containing
0078 an ntuple with the Energy Deposit in each Body Part.
0079 macro.C is provided to print the content of the ntuple in a ROOT
0080 interactive analysis session.
0081 
0082 **** MULTITHREAD MODE
0083 output files:
0084 human_phantom.root_t0
0085 ..
0086 ..
0087 human_phantom.root_t#
0088 
0089 where # is the number of threads
0090 
0091 type: source MergeFiles to merge the output of each thread in a single one
0092 called human_phantom.root
0093 macro.C is provided to print the content of the ntuple in a ROOT
0094 interactive analysis session.
0095 
0096 ----> Macro files: example of different human phantoms
0097 
0098 default.mac is executed by default in the simulation, with visualisation
0099 batch.mac: macro to run in batch mode ( with no visualisation)
0100 adultMIRDFemale.mac: example to define a MIRD female human phantom
0101 adultMIRDMale.mac: example to define a MIRD male human phantom
0102 adultHead.mac: example how to define one piece of the anatomy
0103 adultORNLFemale.mac: example to define a ORNL female human phantom - THIS NEEDS GDML INSTALLED
0104 adultORNLMale.mac: example to define a ORNL male human phantom - THIS NEEDS GDML INSTALLED
0105 
0106 -----> How to build the example 
0107 
0108 If the user wants to run the example importing geometries via GDML, 
0109 he/she needs to have built the persistency/gdml module by having
0110 set the -DWITH_GDML_USE=ON flag during the CMAKE configuration step, 
0111 as well as the -DXERCESC_ROOT_DIR=<path_to_xercesc> flag pointing to 
0112 the path where the XercesC XML parser package is installed in your system.
0113 
0114 - By default GDML is not configured to be used in the example. If the user wishes
0115 to use GDML, he/she has to build the example with the following command:
0116 cmake -DCMAKE_INSTALL_PREFIX=/path/to/geant4-installation -DWITH_GDML_USE=ON /path/to/human_phantom/
0117 
0118 - if using GDML, the directory gdmlData must be copied in the directory where 
0119 the simulation will be launched.
0120 
0121 - Compile and link to generate the executable (in your CMAKE build directory):
0122               % make
0123 
0124 - Execute the application:
0125               % ./phantom
0126          
0127 - Default macro: default.mac (MIRD, Female model) 
0128 
0129 - Visualization macros: vrmlVis.mac, dawnVis.mac, openGLVis.mac
0130 
0131 - Run simulation in batch mode: batch.mac
0132 
0133 ---------------------------------------------------------------------------