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.0.p4)


  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), with the support of
 11 Luciano Pandola (2)                            <<  11 Pablo Cirrone(2), Luciano Pandola (3), Dean Cutajar (1) and Stuart P. George (1)
 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 3. LNGS, INFN, Gran Sasso, Italy
 16 ----------------------------------------------     16 ------------------------------------------------------------------------
 17                                                    17 
 18 Contact: susanna@uow.edu.au                        18 Contact: susanna@uow.edu.au
 19          deanc@uow.edu.au                      << 
 20          geant4-advanced-examples@cern.ch          19          geant4-advanced-examples@cern.ch
 21                                                    20         
 22 ----------------------------------------------     21 ------------------------------------------------------------------------
 23                                                    22 
 24 List of past co-authors:                       <<  23 List of authors: 
 25 S. George, S. Agostinelli, F. Foppiano, S. Gar <<  24 S. Agostinelli, F. Foppiano, S. Garelli, S. Guatelli, M. G. Pia, M. Tropeano
 26                                                    25 
 27 ----------------------------------------------     26 -----------------------------------------------------------------
 28 ----> Introduction.                                27 ----> Introduction.                                                     
 29                                                    28                                                                        
 30 Brachytherapy example simulates  the energy de     29 Brachytherapy example simulates  the energy deposit in a water phantom, produced by: 
 31 1) Iridium sources (Flexisource and TG186).    <<  30 1) Iridium source (endocavitary brachytherapy).                         
 32 2) Iodine sources (Bebig Isoseed and Oncura 67 <<  31 2) Iodium  source (interstitial brachytherapy).                         
 33 3) Leipzig Applicator with an iridium source ( <<  32 3) Leipzig Applicator (superficial brachytherapy).   
 34                                                << 
 35 The Flexisource, an Ir-192 source manufactured << 
 36 The geometry of the Flexisource was adapted fr << 
 37 "A dosimetric study on the Ir-192 high dose ra << 
 38                                                << 
 39 The TG186 source is a generic Ir-192 source cr << 
 40 Details of the TG186 source may be obtained fr << 
 41 "A generic high-dose rate 192Ir brachytherapy  << 
 42                                                    33 
 43 In particular in this example it is shown how      34 In particular in this example it is shown how to:
 44 - model a radioactive source  in terms of radi     35 - model a radioactive source  in terms of radiation field and geometry
 45 - model the radiation field with the General P <<  36 - model the radiation field with the General Particle Source   
 46    1) Define the energy spectrum of photons ex << 
 47    2) Modelling the Radioactive decay          << 
 48 - calculate the energy deposition in a phantom     37 - calculate the energy deposition in a phantom by means of the G4 scoring mesh
 49 - define the physics by means of a Geant4 Modu     38 - define the physics by means of a Geant4 Modular Physics List
 50 - save results in an analysis ROOT file        <<  39 - switch different physics approaches to model electromagnetic physics
 51 - calculate the dose rate distribution along t <<  40 - save results in an analysis ROOT file using the Geant4 analysis component.               
 52 - compare the calculated dose rate distributio << 
 53                                                << 
 54 In the case of the example, the dose rate dist << 
 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                                                    41 
 59 The example can be executed in multithreading  <<  42 The example can be executed in multithreading mode
 60                                                    43 
 61 ----------------------------------------------     44 ------------------------------------------------------------------------
 62 ----> 1.Experimental set-up.                       45 ----> 1.Experimental set-up.                                            
 63                                                    46 
 64 The default source is a Ir-192 Flexisource set <<  47 The default source is an Ir-131 source set in the center of the phantom.
 65 The phantom is set in the World volume filled  <<  48 The phantom is a box with size 30 cm. The phantom is set in the World volume filled 
                                                   >>  49 with air.
                                                   >>  50 
                                                   >>  51 
 66                                                    52 
 67 The primary radiation field is defined by mean     53 The primary radiation field is defined by means of the GeneralParticleSource                           
 68 ----------------------------------------------     54 -------------------------------------------------------------------------
 69 ----> 2.SET-UP                                     55 ----> 2.SET-UP 
 70                                                    56                                           
 71 A standard Geant4 example CMakeLists.txt is pr     57 A standard Geant4 example CMakeLists.txt is provided.                   
 72                                                    58 
                                                   >>  59 Setup for analysis:
                                                   >>  60 By default, the example has no analysis component. 
                                                   >>  61 
                                                   >>  62 To compile and use the application with the analysis on, build the example with the following command:
                                                   >>  63 cmake -DWITH_ANALYSIS_USE=ON -DGeant4_DIR=/path/to/Geant4_installation /path/to/brachytherapy_example                                                     
                                                   >>  64           
                                                   >>  65 macro.C and plot_primary.C are provided to plot the results of the simulation, contained
                                                   >>  66 in the brachytherapy.root file. If the user intends to use this macro, ROOT must be installed 
                                                   >>  67 (http://root.cern.ch/drupal/).
 73 ----------------------------------------------     68 ------------------------------------------------------------------------
 74 ----> 3.How to run the example.                    69 ----> 3.How to run the example.                                         
 75                                                    70 
 76 - Batch mode:                                      71 - Batch mode:
 77   $G4WORKDIR/bin/Linux-g++/Brachy FlexiSourceM << 
 78   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourc << 
 79   $G4WORKDIR/bin/Linux-g++/Brachy IridiumSourc     72   $G4WORKDIR/bin/Linux-g++/Brachy IridiumSourceMacro.mac                
 80   $G4WORKDIR/bin/Linux-g++/Brachy IodiumSource <<  73   $G4WORKDIR/bin/Linux-g++/Brachy IodiumSourceMacro.mac       
 81   $G4WORKDIR/bin/Linux-g++/Brachy OncuraIodine <<  74   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourceMacro.mac  
 82   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourc << 
 83                                                    75                                                                         
 84 - Interative mode:                                 76 - Interative mode:                                                      
 85   3) $G4WORKDIR/bin/Linux-g++/Brachy               77   3) $G4WORKDIR/bin/Linux-g++/Brachy
 86      VisualisationMacro.mac is loaded automati     78      VisualisationMacro.mac is loaded automatically.         
 87                                                    79                                                                          
 88 * How to change the absorber material of the p     80 * How to change the absorber material of the phantom:                                                                 
 89 idle>/phantom/selectMaterial  materialName         81 idle>/phantom/selectMaterial  materialName
 90                                                    82 
 91 ----------------------------------------------     83 ---------------------------------------------------------------------------------
 92 ----> 4. Primary radiation Field                   84 ----> 4. Primary radiation Field
 93                                                    85 
 94 The radiation field is defined with the Genera     86 The radiation field is defined with the General Particle Source.
 95                                                    87 
 96 Two alternative options are offered:               88 Two alternative options are offered:
 97 1) Define gamma as primary radiation field. Th     89 1) Define gamma as primary radiation field. The gamma are originated from the radioactive core.
 98 This radiation field is defined in:                90 This radiation field is defined in:
 99 iodine_source_primary.mac and iridium_source_p     91 iodine_source_primary.mac and iridium_source_primary.mac
100                                                    92 
101 2) Model the radioactive Decay. The primary pa     93 2) Model the radioactive Decay. The primary particle is the radionuclide.
102 This option is modelled in iodine_decay.mac an <<  94 This option is modelled in iodine_decay.mac and iridium_decay.mac
103                                                << 
104 The GPS macros are executed in VisualisationMa << 
105                                                << 
106 - The Flexisource is the default source of the << 
107 - In VisualisationMacro.mac the source is the  << 
108 - In FlexiSourceMacro.mac the Flexi Ir source  << 
109 - In IodineSourceMacro.mac, the Bebig Isoseed  << 
110   Alternatively the radioactive decay of I can << 
111 - In LeipzigSourceMacro.mac, A Leipzig applica << 
112 - The TG186SourceMacro.mac models the referenc << 
113 - OncuraIodineSourceMacro.mac models both the  << 
114 ---------------------------------------------- << 
115 ----> 5. Physics List                          << 
116                                                << 
117 The electromagnetic Livermore Low Energy physi << 
118 The cut is 0.05 mm.                            << 
119 Fluorescence and Auger electron emission are i << 
120                                                << 
121 ---------------------------------------------- << 
122 ----> 6. Scoring mesh                          << 
123                                                << 
124 The scoring mesh is used to calculate the ener << 
125 integrated over the whole run. The scoring mes << 
126 The default output format of the scoring is ch << 
127 The scoring mesh is fixed  with a size of 20.0 << 
128                                                << 
129 When running in interactive mode there is no s << 
130                                                    95 
                                                   >>  96 The GPS macros are executed in IridiumSourceMacro.mac, IodiumSourceMacro.mac, LeipzigSourceMacro.mac
131 ----------------------------------------------     97 ------------------------------------------------------------------------
132 ----> 6. Analysis                              <<  98 ----> 5. Scoring mesh
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                                                    99 
                                                   >> 100 The scoring mesh is used to calculate the energy deposition in the voxels of the phantom,
                                                   >> 101 integrated over the whole run. The scoring mesh is defined in the input macro file (see IridiumSourceMacro.mac for example).
                                                   >> 102 The user can change the default output format of the scoring in the class BrachyUserScoreWriter.
                                                   >> 103                                                                          
139 ----------------------------------------------    104 ------------------------------------------------------------------------
140 ----> 7. Simulation output                     << 105 ----> 6. Simulation output                                               
141                                                   106 
142 The output is:                                    107 The output is:
143                                                   108 
144 - ASCII file EnergyDeposition.out, with xx (mm    109 - 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 << 
146                                                << 
147   By default:                                     110   By default:
148   EnergyDeposition_Flexi.out contains the Edep << 111   EnergyDeposition_iodine.out contains the Edep when Iodine source is selected
149   EnergyDeposition_iodine.out contains the Ede << 112   EnergyDeposition_iridium.out contains the Edep when Iridium source is selected
150   EnergyDeposition_TG186.out contains the Edep << 113   EnergyDeposition_Leipzig.out contains the Edep when the Iridium source with Leipzig applicator is selected
151   EnergyDeposition_Leipzig.out contains the Ed << 114 
152   EnergyDeposition_Oncura.out contains the Ede << 115 - brachytherapy.root, containing 
153                                                << 116   - an ntuple with the 3D energy deposition in the phantom. The macro macro.C is provided as example 
154 - brachytherapy.root, containing a 2D histogra << 117     to open brachytherapy.root in ROOT interactive session and to plot the results of the simulation. 
155   to open brachytherapy.root in ROOT interacti << 118     The ROOT file will be created if the example is built with the WITH_ANALYSIS_USE=ON option (see section 2).                   
156                                                << 119   - 1D histogram withe the plot of energy spectrum of gamma emitted by the radioactive decay when the Ir or I decay is modelled
157 - primary.root, with 1D histogram of the  ener << 120    (see section 4). plot_primary.C is provided as example to open brachytherapy.root and to plot the energy    spectra                                                                
158   plot_primary.C is provided as example to ope << 
159                                                << 
160 ---------------------------------------------- << 
161 ----> 8.Visualisation                          << 
162                                                << 
163 A macro is provided ad example of visualisatio << 
164                                                   121 
165 ----------------------------------------------    122 -------------------------------------------------------------------------------
166 -----> 9. Comparison to reference data         << 123 ----> 7.Visualisation                                                     
167                                                << 
168 The ROOT macros macro.C and plot_primary.C are << 
169 in the brachytherapy.root file.                << 
170                                                << 
171 The ROOT macro TG43_relative_dose.C has brachy << 
172 the brachytherapy source. The dose rate is nor << 
173 The output file is geant4_dose.txt with two co << 
174 distance from the centre (cm) dose rate distri << 
175                                                << 
176 The user can then compare the dose rate distri << 
177                                                << 
178 Directory "comparison":                        << 
179 As an example, the dose rate distribution calc << 
180                                                << 
181 The compare.C is a ROOT macro which reads the  << 
182                                                << 
183 The directory "comparison" contains:           << 
184 - the reference data, granero.txt              << 
185 - the data obtained in Geant4.10.3: geant4.txt << 
186 - comparison.C - macro to read geant4.txt and  << 
187                                                   124 
188 -----> 10. Regression testing of Geant4        << 125 a macro is provided ad example of visualisation:  VisualisationMacro.mac 
189 - the macros to run are in test_macro          << 
190 - the results should be processed with analysi << 
191                                                   126 
192                                                   127