Version:
[ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]
1 -------------------------------------------------------------------
2
3 =========================================================
4 Geant4 - human_phantom example
5 =========================================================
6
7 README
8 -----------------------
9
10 Past Authors: G. Guerrieri, S. Guatelli, M. G. Pia (pia@ge.infn.it),INFN Genova, Italy.
11 Current authors (since 2007): S. Guatelli (susanna@uow.edu.au), University of Wollongong, Australia.
12 Contributions by F. Ambroglini (filippo.ambroglini@pg.infn.it), INFN Perugia, Italy.
13
14 The example is based on code developed by G. Guerrieri, University of Genova, Italy.
15
16 ------> Introduction
17
18 The human_phantom example models anthropomorphic phantoms for
19 Geant4 simulations.
20 Two models are available: MIRD [1] and ORNL [2] (Male and Female for each approach).
21
22 [1] W.S. Snyder, et al, "MIRD Pamphlet No. 5 Revised, Estimates of
23 absorbed fractions for monoenergetic photon sources uniformly distributed
24 in various organs of a heterogeneous phantom",
25 J. Nucl. Med. Suppl., no. 3, pp. 5-52, 1969.
26
27 [2] M. Cristy and K. F. Eckerman, "Specific absorbed fractions of energy
28 at various ages from internal photon sources", ORNL/TM-8381/VI, Apr. 1987.
29
30 Note: Currently the ORNL phantom is under review.
31
32 -----> Geometry
33
34 The process of building a phantom is handled through the Builder
35 design pattern.
36 The creation of coherent models of the human phantom is handled through
37 an Abstract Factory design pattern.
38
39 The organs of the MIRD phantom are implemented in hard-code; the organs of
40 the ORNL phantom are handled through GDML (Geometry Description Markup Language,
41 www.cern.ch/gdml). The materials of the MIRD model are defined in the
42 class G4HumanPhantomMaterial. The materials of the ORNL model are defined in
43 the GDML files.
44 If using ORNL phantom model with no GDML set-up a segmentation
45 fault will be otained when running the simulation.
46 The gdml files describing the MIRD phantoms are not used in the example
47 but are there as reference for users.
48
49 -----> Physics
50
51 Particles: charged particles, gamma, geantino
52 Physics list: electromagnetic processes are modelled.
53 The threshold of production of secondary particles is set to 1 * mm.
54
55 -----> Primary particles
56
57 The G4 General Particle Source is used to generate primary radiation field.
58 Macro primary.mac contains the definition of the primary radiation field.
59
60 -----> Energy deposit
61
62 The energy deposit is calculated in the organs of the phantom.
63 At the end of the execution of the simulation the summary of the total energy deposit in
64 each organ is print out.
65
66 Currently for ORNL model the energy deposition is calculated in the head only.
67
68 If the sensitivity is not set ( /bodypart/addBodyPart organName no ),
69 the energy deposit is not calculated in the specific organ.
70
71 The energy deposit is calculated in each voxel of the parameterised breast.
72
73 -----> Analysis
74 The analysis is activated by default.
75
76 **** SEQUENTIAL MODE *************
77 output file: g4humanphantom.root containing
78 an ntuple with the Energy Deposit in each Body Part.
79 macro.C is provided to print the content of the ntuple in a ROOT
80 interactive analysis session.
81
82 **** MULTITHREAD MODE
83 output files:
84 human_phantom.root_t0
85 ..
86 ..
87 human_phantom.root_t#
88
89 where # is the number of threads
90
91 type: source MergeFiles to merge the output of each thread in a single one
92 called human_phantom.root
93 macro.C is provided to print the content of the ntuple in a ROOT
94 interactive analysis session.
95
96 ----> Macro files: example of different human phantoms
97
98 default.mac is executed by default in the simulation, with visualisation
99 batch.mac: macro to run in batch mode ( with no visualisation)
100 adultMIRDFemale.mac: example to define a MIRD female human phantom
101 adultMIRDMale.mac: example to define a MIRD male human phantom
102 adultHead.mac: example how to define one piece of the anatomy
103 adultORNLFemale.mac: example to define a ORNL female human phantom - THIS NEEDS GDML INSTALLED
104 adultORNLMale.mac: example to define a ORNL male human phantom - THIS NEEDS GDML INSTALLED
105
106 -----> How to build the example
107
108 If the user wants to run the example importing geometries via GDML,
109 he/she needs to have built the persistency/gdml module by having
110 set the -DWITH_GDML_USE=ON flag during the CMAKE configuration step,
111 as well as the -DXERCESC_ROOT_DIR=<path_to_xercesc> flag pointing to
112 the path where the XercesC XML parser package is installed in your system.
113
114 - By default GDML is not configured to be used in the example. If the user wishes
115 to use GDML, he/she has to build the example with the following command:
116 cmake -DCMAKE_INSTALL_PREFIX=/path/to/geant4-installation -DWITH_GDML_USE=ON /path/to/human_phantom/
117
118 - if using GDML, the directory gdmlData must be copied in the directory where
119 the simulation will be launched.
120
121 - Compile and link to generate the executable (in your CMAKE build directory):
122 % make
123
124 - Execute the application:
125 % ./phantom
126
127 - Default macro: default.mac (MIRD, Female model)
128
129 - Visualization macros: vrmlVis.mac, dawnVis.mac, openGLVis.mac
130
131 - Run simulation in batch mode: batch.mac
132
133 ---------------------------------------------------------------------------
