Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/advanced/brachytherapy/README

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 ]

Diff markup

Differences between /examples/advanced/brachytherapy/README (Version 11.3.0) and /examples/advanced/brachytherapy/README (Version 10.3.p2)


  1                                                     1 
  2      =========================================      2      =========================================================
  3           Geant4 - Brachytherapy example            3           Geant4 - Brachytherapy example
  4      =========================================      4      =========================================================
  5                                                     5 
  6                              README                 6                              README
  7                       ---------------------         7                       ---------------------
  8                                                     8 
  9                                                     9 
 10 The brachytherapy example is currently maintai <<  10 The brachytherapy example is currently maintained and upgraded by Susanna Guatelli (1) and Dean Cutajar (1), with the support of
 11 Luciano Pandola (2)                                11 Luciano Pandola (2)  
 12                                                    12 
 13 1. Centre For Medical Radiation Physics (CMRP)     13 1. Centre For Medical Radiation Physics (CMRP), University of Wollongong, NSW, Australia.
 14 2. LNS, INFN, Catania, Italy.                      14 2. LNS, INFN, Catania, Italy.
 15                                                    15 
 16 ----------------------------------------------     16 ------------------------------------------------------------------------
 17                                                    17 
 18 Contact: susanna@uow.edu.au                        18 Contact: susanna@uow.edu.au
 19          deanc@uow.edu.au                          19          deanc@uow.edu.au
 20          geant4-advanced-examples@cern.ch          20          geant4-advanced-examples@cern.ch
 21                                                    21         
 22 ----------------------------------------------     22 ------------------------------------------------------------------------
 23                                                    23 
 24 List of past co-authors:                           24 List of past co-authors: 
 25 S. George, S. Agostinelli, F. Foppiano, S. Gar     25 S. George, S. Agostinelli, F. Foppiano, S. Garelli, M. G. Pia, M. Tropeano
 26                                                    26 
 27 ----------------------------------------------     27 -----------------------------------------------------------------
 28 ----> Introduction.                                28 ----> Introduction.                                                     
 29                                                    29                                                                        
 30 Brachytherapy example simulates  the energy de     30 Brachytherapy example simulates  the energy deposit in a water phantom, produced by: 
 31 1) Iridium sources (Flexisource and TG186).        31 1) Iridium sources (Flexisource and TG186).                     
 32 2) Iodine sources (Bebig Isoseed and Oncura 67 <<  32 2) Iodine  source (Bebig Isoseed I-125).                        
 33 3) Leipzig Applicator with an iridium source (     33 3) Leipzig Applicator with an iridium source (model from the Istituto Tumori, Genova, Italy).   
 34                                                    34 
 35 The Flexisource, an Ir-192 source manufactured     35 The Flexisource, an Ir-192 source manufactured by Nucletron, an Elekta company, is a source commonly used for high dose rate brachytherapy treatments. 
 36 The geometry of the Flexisource was adapted fr     36 The geometry of the Flexisource was adapted from D. Granero, J. Pérez-Calatayud, E. Casal, et al, 
 37 "A dosimetric study on the Ir-192 high dose ra     37 "A dosimetric study on the Ir-192 high dose rate Flexisource", Med. Phys. 33 (12), 2006, 4578-82.
 38                                                    38 
 39 The TG186 source is a generic Ir-192 source cr     39 The TG186 source is a generic Ir-192 source created to provide developers of model based dose engines with a method of validating new dose calculation techniques.
 40 Details of the TG186 source may be obtained fr     40 Details of the TG186 source may be obtained from Facundo Ballester, Åsa Carlsson Tedgren, Domingo Granero, et al,
 41 "A generic high-dose rate 192Ir brachytherapy      41 "A generic high-dose rate 192Ir brachytherapy source for evaluation of model-based dose calculations beyond the TG-43 formalism", Med. Phys. 42, 2015, 3048-62
 42                                                    42 
 43 In particular in this example it is shown how      43 In particular in this example it is shown how to:
 44 - model a radioactive source  in terms of radi     44 - model a radioactive source  in terms of radiation field and geometry
 45 - model the radiation field with the General P     45 - model the radiation field with the General Particle Source  with two alternative methods:
 46    1) Define the energy spectrum of photons ex     46    1) Define the energy spectrum of photons exiting the radioactive core
 47    2) Modelling the Radioactive decay              47    2) Modelling the Radioactive decay
 48 - calculate the energy deposition in a phantom     48 - calculate the energy deposition in a phantom by means of the G4 scoring mesh
 49 - define the physics by means of a Geant4 Modu     49 - define the physics by means of a Geant4 Modular Physics List
 50 - save results in an analysis ROOT file            50 - save results in an analysis ROOT file              
 51 - calculate the dose rate distribution along t     51 - calculate the dose rate distribution along the main axis of the source
 52 - compare the calculated dose rate distributio <<  52 - compare the calculated dose rate distribution to reference data. In the case of the example, the dose rate
 53                                                <<  53 distribution of a Flexisource is compared to D. Granero, J. Pérez-Calatayud, E. Casal, et al, 
 54 In the case of the example, the dose rate dist <<  54 "A dosimetric study on the Ir-192 high dose rate Flexisource", Med. Phys. 33 (12), 2006, 4578-82.
 55 J. Pérez-Calatayud, E. Casal, et al,"A dosime << 
 56 The dose rate distribution of the Oncura 6711  << 
 57 dosimetry of an I-125 brachytherapy seed", Med << 
 58                                                    55 
 59 The example can be executed in multithreading      56 The example can be executed in multithreading mode.
 60                                                    57 
 61 ----------------------------------------------     58 ------------------------------------------------------------------------
 62 ----> 1.Experimental set-up.                       59 ----> 1.Experimental set-up.                                            
 63                                                    60 
 64 The default source is a Ir-192 Flexisource set <<  61 The default source is a  Ir-192 Flexisource set in the center of a water phantom with size 30 cm. 
 65 The phantom is set in the World volume filled      62 The phantom is set in the World volume filled with air.
 66                                                    63 
 67 The primary radiation field is defined by mean     64 The primary radiation field is defined by means of the GeneralParticleSource                           
 68 ----------------------------------------------     65 -------------------------------------------------------------------------
 69 ----> 2.SET-UP                                     66 ----> 2.SET-UP 
 70                                                    67                                           
 71 A standard Geant4 example CMakeLists.txt is pr     68 A standard Geant4 example CMakeLists.txt is provided.                   
 72                                                    69 
                                                   >>  70 Setup for analysis:
                                                   >>  71 By default, the example has no analysis component. 
                                                   >>  72 
                                                   >>  73 To compile and use the application with the analysis on, build the example with the following command:
                                                   >>  74 cmake -DWITH_ANALYSIS_USE=ON -DGeant4_DIR=/path/to/Geant4_installation /path/to/brachytherapy_example                                                     
                                                   >>  75           
                                                   >>  76 The installation of ROOT is required (http://root.cern.ch/drupal/).
                                                   >>  77 
 73 ----------------------------------------------     78 ------------------------------------------------------------------------
 74 ----> 3.How to run the example.                    79 ----> 3.How to run the example.                                         
 75                                                    80 
 76 - Batch mode:                                      81 - Batch mode:
 77   $G4WORKDIR/bin/Linux-g++/Brachy FlexiSourceM <<  82   $G4WORKDIR/bin/Linux-g++/Brachy FlexiSourceMacro.mac      
 78   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourc << 
 79   $G4WORKDIR/bin/Linux-g++/Brachy IridiumSourc     83   $G4WORKDIR/bin/Linux-g++/Brachy IridiumSourceMacro.mac                
 80   $G4WORKDIR/bin/Linux-g++/Brachy IodiumSource <<  84   $G4WORKDIR/bin/Linux-g++/Brachy IodiumSourceMacro.mac       
 81   $G4WORKDIR/bin/Linux-g++/Brachy OncuraIodine <<  85   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourceMacro.mac  
 82   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourc << 
 83                                                    86                                                                         
 84 - Interative mode:                                 87 - Interative mode:                                                      
 85   3) $G4WORKDIR/bin/Linux-g++/Brachy               88   3) $G4WORKDIR/bin/Linux-g++/Brachy
 86      VisualisationMacro.mac is loaded automati     89      VisualisationMacro.mac is loaded automatically.         
 87                                                    90                                                                          
 88 * How to change the absorber material of the p     91 * How to change the absorber material of the phantom:                                                                 
 89 idle>/phantom/selectMaterial  materialName         92 idle>/phantom/selectMaterial  materialName
 90                                                    93 
 91 ----------------------------------------------     94 ---------------------------------------------------------------------------------
 92 ----> 4. Primary radiation Field                   95 ----> 4. Primary radiation Field
 93                                                    96 
 94 The radiation field is defined with the Genera     97 The radiation field is defined with the General Particle Source.
 95                                                    98 
 96 Two alternative options are offered:               99 Two alternative options are offered:
 97 1) Define gamma as primary radiation field. Th    100 1) Define gamma as primary radiation field. The gamma are originated from the radioactive core.
 98 This radiation field is defined in:               101 This radiation field is defined in:
 99 iodine_source_primary.mac and iridium_source_p    102 iodine_source_primary.mac and iridium_source_primary.mac
100                                                   103 
101 2) Model the radioactive Decay. The primary pa    104 2) Model the radioactive Decay. The primary particle is the radionuclide.
102 This option is modelled in iodine_decay.mac an    105 This option is modelled in iodine_decay.mac and TG186_iridium_decay.mac
103                                                   106 
104 The GPS macros are executed in VisualisationMa << 107 The GPS macros are executed in VisualisationMacro.mac 9default, FlexiSourceMacro.mac, IodineSourceMacro.mac, LeipzigSourceMacro.mac
105                                                   108 
106 - The Flexisource is the default source of the    109 - The Flexisource is the default source of the example.
107 - In VisualisationMacro.mac the source is the     110 - In VisualisationMacro.mac the source is the default one. iridium_source_primary.mac is executed to define the radiation field emerging from the iridium core.
108 - In FlexiSourceMacro.mac the Flexi Ir source  << 111 - In FlexiSourceMacro.mac the Flexi ir source geometry is selected via interactive command. The radiation field is defined in the iridium_source_primary.mac.
109 - In IodineSourceMacro.mac, the Bebig Isoseed     112 - In IodineSourceMacro.mac, the Bebig Isoseed I-125  brachytherapy source  is modelled. The radiation field is modelled in terms of emitted photons in iodine_source_primary.mac. 
110   Alternatively the radioactive decay of I can    113   Alternatively the radioactive decay of I can be modelled using teh macro iodine_decay.mac.
111 - In LeipzigSourceMacro.mac, A Leipzig applica    114 - In LeipzigSourceMacro.mac, A Leipzig applicator (design provided by Istituto Tumori, Genova) is modelled. The iridium_source_leipzig_primary.mac defines the radiation field of the Ir core.
112 - The TG186SourceMacro.mac models the referenc    115 - The TG186SourceMacro.mac models the reference bIr brachytherapy source. The radiation field can be either defined with the iridium_source_primary.mac (spectrum of the emitted photons) or with TG186_iridium_decay.mac (model of the Ir decay).
113 - OncuraIodineSourceMacro.mac models both the  << 116 
114 ----------------------------------------------    117 --------------------------------------------------------------------------------
115 ----> 5. Physics List                             118 ----> 5. Physics List
116                                                   119 
117 The electromagnetic Livermore Low Energy physi    120 The electromagnetic Livermore Low Energy physics is active as well as the radioactive decay.
118 The cut is 0.05 mm.                               121 The cut is 0.05 mm.
119 Fluorescence and Auger electron emission are i << 
120                                                   122 
121 ----------------------------------------------    123 ------------------------------------------------------------------------
122 ----> 6. Scoring mesh                             124 ----> 6. Scoring mesh
123                                                   125 
124 The scoring mesh is used to calculate the ener    126 The scoring mesh is used to calculate the energy deposition in the plane containing the source (z=0 plane)
125 integrated over the whole run. The scoring mes    127 integrated over the whole run. The scoring mesh is defined in the input macro files.
126 The default output format of the scoring is ch << 128 T
                                                   >> 129 he default output format of the scoring is changed in the class BrachyUserScoreWriter.
127 The scoring mesh is fixed  with a size of 20.0    130 The scoring mesh is fixed  with a size of 20.025 cm along x and y. The bin size is 0.25 mm along x, y and z. 
128                                                   131 
129 When running in interactive mode there is no s    132 When running in interactive mode there is no scoring mesh.The user has to add it with appropriate UI                                                            
130                                                   133 
131 ----------------------------------------------    134 ------------------------------------------------------------------------
132 ----> 6. Analysis                              << 
133                                                << 
134 G4Analysis is used to create and fill histogra << 
135                                                << 
136 The installation of ROOT is required to plot t << 
137 in primary.root and brachytherapy.root(http:// << 
138                                                << 
139 ---------------------------------------------- << 
140 ----> 7. Simulation output                        135 ----> 7. Simulation output                                               
141                                                   136 
142 The output is:                                    137 The output is:
143                                                   138 
144 - ASCII file EnergyDeposition.out, with xx (mm    139 - ASCII file EnergyDeposition.out, with xx (mm), yy(mm), zz(mm), and energy deposition (keV), in the phantom.
145   To limit the use of memory, the energy depos    140   To limit the use of memory, the energy deposition is scored only in the plane containing the source, however this can be changed by the user.
146                                                   141  
147   By default:                                     142   By default:
148   EnergyDeposition_Flexi.out contains the Edep    143   EnergyDeposition_Flexi.out contains the Edep when the Flexi source is selected.
149   EnergyDeposition_iodine.out contains the Ede << 144   EnergyDeposition_iodine.out contains the Edep when Iodine source is selected.
150   EnergyDeposition_TG186.out contains the Edep    145   EnergyDeposition_TG186.out contains the Edep when the TG186 source is selected.
151   EnergyDeposition_Leipzig.out contains the Ed    146   EnergyDeposition_Leipzig.out contains the Edep when the Iridium source with Leipzig applicator is selected.
152   EnergyDeposition_Oncura.out contains the Ede << 
153                                                   147 
154 - brachytherapy.root, containing a 2D histogra << 148 - brachytherapy.root, containing 
155   to open brachytherapy.root in ROOT interacti << 149   - a 2D histogram with the energy deposition in the phantom. The macro macro.C is provided as example 
156                                                << 150     to open brachytherapy.root in ROOT interactive session and to plot the results of the simulation. 
157 - primary.root, with 1D histogram of the  ener << 151     The ROOT file will be created if the example is built with the WITH_ANALYSIS_USE=ON option (see section 2).                   
158   plot_primary.C is provided as example to ope << 152   - 1D histogram withe the plot of energy spectrum of gamma emitted by the radioactive decay when gamma are generated directly as 
                                                   >> 153     primary particles or whenthey derive from Radioactive Decay(see section 4). 
                                                   >> 154     plot_primary.C is provided as example to open brachytherapy.root and to plot the energy  spectra                                                                
159                                                   155 
160 ----------------------------------------------    156 -------------------------------------------------------------------------------
161 ----> 8.Visualisation                             157 ----> 8.Visualisation                                                     
162                                                   158 
163 A macro is provided ad example of visualisatio    159 A macro is provided ad example of visualisation:  VisualisationMacro.mac. 
164                                                   160 
165 ----------------------------------------------    161 -------------------------------------------------------------------------------
166 -----> 9. Comparison to reference data            162 -----> 9. Comparison to reference data
167                                                   163 
168 The ROOT macros macro.C and plot_primary.C are    164 The ROOT macros macro.C and plot_primary.C are provided to plot the results of the simulation, contained
169 in the brachytherapy.root file.                   165 in the brachytherapy.root file. 
170                                                   166 
171 The ROOT macro TG43_relative_dose.C has brachy    167 The ROOT macro TG43_relative_dose.C has brachytherapy.root as input file. It calculates the dose rate distribution along the main axis of 
172 the brachytherapy source. The dose rate is nor    168 the brachytherapy source. The dose rate is normalised to 1 at 1 cm distance from the centre. 
173 The output file is geant4_dose.txt with two co    169 The output file is geant4_dose.txt with two columns: 
174 distance from the centre (cm) dose rate distri << 170 distance from the centre (cm)    dose rate distribution
175                                                   171 
176 The user can then compare the dose rate distri    172 The user can then compare the dose rate distribution calculated with the example to reference data.
177                                                   173 
178 Directory "comparison":                           174 Directory "comparison":
179 As an example, the dose rate distribution calc << 175 As an example, the dose rate distribution calculated with the Flexisource is compared to reference data from D. Granero, J. Pérez-Calatayud, E. Casal, et al, 
                                                   >> 176 "A dosimetric study on the Ir-192 high dose rate Flexisource", Med. Phys. 33 (12), 2006, 4578-82.
180                                                   177 
181 The compare.C is a ROOT macro which reads the     178 The compare.C is a ROOT macro which reads the dose rate distribution calculated with the Flexisource (geant4.txt generated with the advanced example and 280 M histories ) against the reference. 
182                                                   179 
183 The directory "comparison" contains:              180 The directory "comparison" contains:
184 - the reference data, granero.txt                 181 - the reference data, granero.txt
185 - the data obtained in Geant4.10.3: geant4.txt    182 - the data obtained in Geant4.10.3: geant4.txt, 280 M events. geant4.txt is obtained when executing the macro TG43_relative_dose.C
186 - comparison.C - macro to read geant4.txt and     183 - comparison.C - macro to read geant4.txt and granero.txt and compare them in the same plot
187                                                << 
188 -----> 10. Regression testing of Geant4        << 
189 - the macros to run are in test_macro          << 
190 - the results should be processed with analysi << 
191                                                << 
192                                                   184