| Geant4 Cross Reference |
1 1
2 ========================================= 2 =========================================================
3 Geant4 - ICRP145_HumanPhantoms examp 3 Geant4 - ICRP145_HumanPhantoms example
4 ========================================= 4 =========================================================
5 5
6 README 6 README
7 --------------------- 7 ---------------------
8 8
9 9
10 ********************************************** 10 ********************************************************************
11 * The ICRP145 Phantoms are used in Geant4 with 11 * The ICRP145 Phantoms are used in Geant4 with permission from the *
12 * International Commission on Radiological Pr 12 * International Commission on Radiological Protection * *
13 ********************************************** 13 ********************************************************************
14 14
15 Authors' list: 15 Authors' list:
16 • Haeginh Han / Hanyang University, Republic 16 • Haeginh Han / Hanyang University, Republic of Korea
17 • Min Cheol Han / Yonsei University Health 17 • Min Cheol Han / Yonsei University Health System, Republic of Korea
18 • Banho Shin / Hanyang University, Republic 18 • Banho Shin / Hanyang University, Republic of Korea
19 • Chansoo Choi / University of Florida, USA 19 • Chansoo Choi / University of Florida, USA
20 • Yeon Soo Yeom / Yonsei University, Republ 20 • Yeon Soo Yeom / Yonsei University, Republic of Korea
21 • Jonghwi Jeong / National Cancer Center, Re 21 • Jonghwi Jeong / National Cancer Center, Republic of Korea
22 • Chan Hyeong Kim / Hanyang University, Repu 22 • Chan Hyeong Kim / Hanyang University, Republic of Korea
23 23
24 Bibliographic references - please refer to thi 24 Bibliographic references - please refer to this reference when using the Advanced Example
25 • ICRP, 2020. Adult mesh-type reference comp 25 • ICRP, 2020. Adult mesh-type reference computational phantoms. ICRP Publication 145. Ann. ICRP 49(3).
26 26
27 Geant4 Contributors: J. Allison and S. Guatell 27 Geant4 Contributors: J. Allison and S. Guatelli
28 28
29 e-mail inquiries to: haeginh@hanyang.ac.kr, su 29 e-mail inquiries to: haeginh@hanyang.ac.kr, susanna@uow.edu.au, MRCP.ICRP@gmail.com
30 30
31 1- HOW TO BUILD AND RUN THE EXAMPLES 31 1- HOW TO BUILD AND RUN THE EXAMPLES
32 32
33 Please note that the guides below are based 33 Please note that the guides below are based on Linux/MacOSX, which are the
34 recommended platforms for Geant4. 34 recommended platforms for Geant4.
35 35
36 1) Compile and link to generate an executable 36 1) Compile and link to generate an executable (with CMake)
37 37
38 % cd path_to_example 38 % cd path_to_example
39 % mkdir example_build 39 % mkdir example_build
40 % cd example_build 40 % cd example_build
41 % cmake .. 41 % cmake ..
42 % make 42 % make
43 This should make two executables - ICRP145p <<
44 43
45 2) How to run 44 2) How to run
46 45
47 a) For the irradiation with external beams 46 a) For the irradiation with external beams:
48 47
49 % ./ICRP145phantoms [options] 48 % ./ICRP145phantoms [options]
50 49
51 Options: 50 Options:
52 -m [input file name] optional provi 51 -m [input file name] optional provided->batch mode
53 not p 52 not provided->interactive mode
54 -o [output file name] optional (defa 53 -o [output file name] optional (default: [macro file name].out)
55 -f optional swit 54 -f optional switch to change the phantom to MRCP-AF
56 (def 55 (default: MRCP-AM)
57 56
58 ex) MRCP-AM: % ./External -m example 57 ex) MRCP-AM: % ./External -m example.in -o example.out
59 ex) MRCP-AF: % ./External -m example 58 ex) MRCP-AF: % ./External -m example.in -o example.out -f
60 59
61 *** The radiation source can be specifi 60 *** The radiation source can be specified in source.mac file by using
62 macro commands for G4GeneralParticleSou 61 macro commands for G4GeneralParticleSource (/gps/)
63 62
64 b) For the case of internal radiation sour 63 b) For the case of internal radiation sources:
65 64
66 % ./ICRP145phantoms [options] 65 % ./ICRP145phantoms [options]
67 66
68 Options: 67 Options:
69 -i [ID of source organ] mandatory (ID 68 -i [ID of source organ] mandatory (ID of each organ can be found in Appendix A)
70 -m [input file name] optional prov 69 -m [input file name] optional provided->batch mode
71 not 70 not provided->interactive mode
72 -o [output file name] optional (def 71 -o [output file name] optional (default: [macro file name].out)
73 -f optional swit 72 -f optional switch to change the phantom to MRCP-AF
74 (def 73 (default: MRCP-AM)
75 74
76 ex) MRCP-AM: % ./Internal -i 9500 -m 75 ex) MRCP-AM: % ./Internal -i 9500 -m example.in -o example.out
77 ex) MRCP-AF: % ./Internal -i 9500 -m 76 ex) MRCP-AF: % ./Internal -i 9500 -m example.in -o example.out -f
78 77
79 *** source organ can be defined by u 78 *** source organ can be defined by using -i option.
80 *** source particle and the particle 79 *** source particle and the particle energy can be specified
81 in source.mac file by using macr 80 in source.mac file by using macro commands for G4ParticlGun (/gun/)
82 << 81 c) Notes
83 c) To see the phantom alone: <<
84 <<
85 % ./ICRP145standalone <<
86 <<
87 This allows you to visualise the phanto <<
88 the run manager and physics tables and <<
89 Of course, you cannot run or visualise <<
90 <<
91 d) Notes <<
92 82
93 - Regarding the interactive mode with vi 83 - Regarding the interactive mode with visualisation:
94 84
95 * you can run the codes in interactiv 85 * you can run the codes in interactive mode with visualisation by
96 omitting -m option. 86 omitting -m option.
97 * with "special mesh rendering" (see << 87 * the memory required for the visualisation is ~35 GB when the code is
98 for the visualisation about 1.5 GB << 88 run on a single thread. (it is less than 10 GB in batch mode)
99 * original data takes about 3 GB, phy <<
100 voxelisation consume about 5 GB, so <<
101 * in interactive mode, user should st 89 * in interactive mode, user should start a run by using
102 /run/beamOn command. (Idle> /run/be 90 /run/beamOn command. (Idle> /run/beamOn [number of events])
103 91
104 92
105 - Regarding the multi-threaded mode: 93 - Regarding the multi-threaded mode:
106 94
107 * these examples can be run in multi- 95 * these examples can be run in multi-threaded mode when Geant4 was
108 compiled in multi-threaded mode. 96 compiled in multi-threaded mode.
109 * the number of threads can be set in 97 * the number of threads can be set in input file (see example.in)
110 98
111 - Regarding the path to phantom data: 99 - Regarding the path to phantom data:
112 100
113 * the default path to phantom data is 101 * the default path to phantom data is "(build_directory)/../../phantoms".
114 * to specify the path please change a 102 * to specify the path please change a PHANTOM_PATH environment variable.
115 (export PHANTOM_PATH="path_to_phant 103 (export PHANTOM_PATH="path_to_phantom_data")
116 104
117 2- RESULT FILE 105 2- RESULT FILE
118 106
119 example_male.out and example_female.out file 107 example_male.out and example_female.out files in each folder is the result file
120 for example.in. The result file provides abs 108 for example.in. The result file provides absorbed doses for all organ IDs for TM
121 model listed in Appendix A. 109 model listed in Appendix A.
122 110
123 3- LICENSE 111 3- LICENSE
124 112
125 This code is based on Geant4 toolkit, and th 113 This code is based on Geant4 toolkit, and therefore follows the 'The Geant4
126 Software License' (http://geant4.web.cern.ch 114 Software License' (http://geant4.web.cern.ch/license/LICENSE.html).
127 115
128 116