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 9.2.p3)


  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                                                << 
 10 The brachytherapy example is currently maintai << 
 11 Luciano Pandola (2)                            << 
 12                                                << 
 13 1. Centre For Medical Radiation Physics (CMRP) << 
 14 2. LNS, INFN, Catania, Italy.                  << 
 15                                                << 
 16 ----------------------------------------------      9 ------------------------------------------------------------------------
 17                                                << 
 18 Contact: susanna@uow.edu.au                    << 
 19          deanc@uow.edu.au                      << 
 20          geant4-advanced-examples@cern.ch      << 
 21                                                << 
 22 ---------------------------------------------- << 
 23                                                << 
 24 List of past co-authors:                       << 
 25 S. George, S. Agostinelli, F. Foppiano, S. Gar << 
 26                                                << 
 27 ---------------------------------------------- << 
 28 ----> Introduction.                                10 ----> Introduction.                                                     
 29                                                    11                                                                        
 30 Brachytherapy example simulates  the energy de <<  12 Brachytherapy example simulates energy deposit in a Phantom filled with 
 31 1) Iridium sources (Flexisource and TG186).    <<  13 soft tissue for: 
 32 2) Iodine sources (Bebig Isoseed and Oncura 67 <<  14 1) Iridium source (endocavitary brachytherapy).                         
 33 3) Leipzig Applicator with an iridium source ( <<  15 2) Iodium  source (interstitial brachytherapy).                         
 34                                                <<  16 3) Leipzig Applicator (superficial brachytherapy).                      
 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                                                << 
 43 In particular in this example it is shown how  << 
 44 - model a radioactive source  in terms of radi << 
 45 - model the radiation field with the General P << 
 46    1) Define the energy spectrum of photons ex << 
 47    2) Modelling the Radioactive decay          << 
 48 - calculate the energy deposition in a phantom << 
 49 - define the physics by means of a Geant4 Modu << 
 50 - save results in an analysis ROOT file        << 
 51 - calculate the dose rate distribution along t << 
 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                                                << 
 59 The example can be executed in multithreading  << 
 60                                                << 
 61 ----------------------------------------------     17 ------------------------------------------------------------------------
 62 ----> 1.Experimental set-up.                       18 ----> 1.Experimental set-up.                                            
 63                                                    19 
 64 The default source is a Ir-192 Flexisource set <<  20 The default source is an Ir-131 source put in the center of the Phantom.
 65 The phantom is set in the World volume filled  <<  21 The Phantom is a box (dimension:30cm), it is gridded in 
 66                                                <<  22 voxels (1.mm dimension)                                                 
 67 The primary radiation field is defined by mean << 
 68 ----------------------------------------------     23 -------------------------------------------------------------------------
 69 ----> 2.SET-UP                                     24 ----> 2.SET-UP 
 70                                                    25                                           
 71 A standard Geant4 example CMakeLists.txt is pr <<  26  -a standard Geant4 example GNUmakefile is provided                      
                                                   >>  27 
                                                   >>  28 setup with:                                                              
                                                   >>  29 G4SYSTEM = linux-g++                                                     
 72                                                    30 
                                                   >>  31 The following environment variables need to be set:                      
                                                   >>  32 
                                                   >>  33 G4LEDATA: points to low energy database             
                                                   >>  34 
                                                   >>  35 setup for analysis: AIDA 3.2.1, PI 1.3.3 (PI is Obsolete)
                                                   >>  36 
                                                   >>  37 Users can download the analysis tools from:  
                                                   >>  38                                                                         
                                                   >>  39 http://aida.freehep.org/
                                                   >>  40 http://cern.ch/pfeiffer
                                                   >>  41 http://www.cern.ch/PI  (OBSOLETE)
 73 ----------------------------------------------     42 ------------------------------------------------------------------------
 74 ----> 3.How to run the example.                    43 ----> 3.How to run the example.                                         
 75                                                    44 
 76 - Batch mode:                                  <<  45 - batch mode:
 77   $G4WORKDIR/bin/Linux-g++/Brachy FlexiSourceM << 
 78   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourc << 
 79   $G4WORKDIR/bin/Linux-g++/Brachy IridiumSourc     46   $G4WORKDIR/bin/Linux-g++/Brachy IridiumSourceMacro.mac                
 80   $G4WORKDIR/bin/Linux-g++/Brachy IodiumSource <<  47   $G4WORKDIR/bin/Linux-g++/Brachy IodiumSourceMacro.mac       
 81   $G4WORKDIR/bin/Linux-g++/Brachy OncuraIodine <<  48   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourceMacro.mac  
 82   $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourc << 
 83                                                    49                                                                         
 84 - Interative mode:                                 50 - Interative mode:                                                      
 85   3) $G4WORKDIR/bin/Linux-g++/Brachy               51   3) $G4WORKDIR/bin/Linux-g++/Brachy
 86      VisualisationMacro.mac is loaded automati <<  52      The VisualisationMacro.mac is loaded automatically                 
 87                                                << 
 88 * How to change the absorber material of the p << 
 89 idle>/phantom/selectMaterial  materialName     << 
 90                                                << 
 91 ---------------------------------------------- << 
 92 ----> 4. Primary radiation Field               << 
 93                                                << 
 94 The radiation field is defined with the Genera << 
 95                                                << 
 96 Two alternative options are offered:           << 
 97 1) Define gamma as primary radiation field. Th << 
 98 This radiation field is defined in:            << 
 99 iodine_source_primary.mac and iridium_source_p << 
100                                                << 
101 2) Model the radioactive Decay. The primary pa << 
102 This option is modelled in iodine_decay.mac an << 
103                                                << 
104 The GPS macros are executed in VisualisationMa << 
105                                                    53 
106 - The Flexisource is the default source of the <<  54 -->possible different configurations for interactive mode:              
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                                                    55 
                                                   >>  56 1)Ir source:                                                            
                                                   >>  57 idle>/run/beamOn NumberOfEvents      ...and then
                                                   >>  58 idle>exit                                                               
                                                   >>  59 
                                                   >>  60 2)Leipzig Applicator:                                                   
                                                   >>  61 idle>/source/switch Leipzig                                           
                                                   >>  62 idle>/run/beamOn NumberOfEvents     ...and then                         
                                                   >>  63 idle> exit
                                                   >>  64                                                                         
                                                   >>  65 3) Iodium  source:
                                                   >>  66 idle>/source/switch Iodium                                               
                                                   >>  67 idle>/primary/energy Iodium
                                                   >>  68 idle>/run/beamOn NumberOfEvents     ...and then                          
                                                   >>  69 idle>exit
                                                   >>  70                                                                          
                                                   >>  71 *Before the run you can also change the absorber material of the 
                                                   >>  72 Phantom:                                                                 
                                                   >>  73 idle>/phantom/selectMaterial  materialName
                                                   >>  74                                                                          
                                                   >>  75 - batch mode: executable Brachy macroFile.mac 
                                                   >>  76   macros are provided as example: IodiumSourceMacro.mac,
                                                   >>  77   IridiumSourceMacro.mac, LeipzigSourceMacro.mac                         
                                                   >>  78   (ex. $G4WORKDIR/bin/Linux-g++/Brachy IodiumSourceMacro.mac)   
                                                   >>  79 ------------------------------------------------------------------------
                                                   >>  80 ----> 4. Simulation output                                               
                                                   >>  81 
                                                   >>  82 if G4ANALYSIS_USE = 1 in the set-up, the output is brachytherapy.hbk      
                                                   >>  83 
                                                   >>  84  It contains:
                                                   >>  85  1)1Dhistogram with the primary particle energy                          
                                                   >>  86  2)2Dhistogram with the distribution of energy in the plane 
                                                   >>  87    (x,z,energy) containing the source (YThickness = 1. mm)   
                                                   >>  88  3)1Dhistogram with the energy deposit along the X axis in the plane     
                                                   >>  89    containing the source.
                                                   >>  90  4)Ntuple with the 3D energy deposit in the Phantom                    
                                                   >>  91                                                                          
                                                   >>  92 Units:   the energy deposit is in MeV;
                                                   >>  93          x, y, z in mm for histograms and ntuple                         
131 ----------------------------------------------     94 ------------------------------------------------------------------------
132 ----> 6. Analysis                              <<  95 ----> 5.Visualisation                                                     
133                                                    96 
134 G4Analysis is used to create and fill histogra <<  97 a macro is provided ad example of visualisation:  VisualisationMacro.mac 
135                                                << 
136 The installation of ROOT is required to plot t << 
137 in primary.root and brachytherapy.root(http:// << 
138                                                    98 
139 ----------------------------------------------     99 ------------------------------------------------------------------------
140 ----> 7. Simulation output                     << 
141                                                << 
142 The output is:                                 << 
143                                                << 
144 - ASCII file EnergyDeposition.out, with xx (mm << 
145   To limit the use of memory, the energy depos << 
146                                                << 
147   By default:                                  << 
148   EnergyDeposition_Flexi.out contains the Edep << 
149   EnergyDeposition_iodine.out contains the Ede << 
150   EnergyDeposition_TG186.out contains the Edep << 
151   EnergyDeposition_Leipzig.out contains the Ed << 
152   EnergyDeposition_Oncura.out contains the Ede << 
153                                                << 
154 - brachytherapy.root, containing a 2D histogra << 
155   to open brachytherapy.root in ROOT interacti << 
156                                                << 
157 - primary.root, with 1D histogram of the  ener << 
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                                                << 
165 ---------------------------------------------- << 
166 -----> 9. Comparison to reference data         << 
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                                                   100 
188 -----> 10. Regression testing of Geant4        << 101 Further information at http://www.ge.infn.it/geant4/examples/index.html
189 - the macros to run are in test_macro          << 102 Contact: geant4-advanced-examples@cern.ch
190 - the results should be processed with analysi << 
191                                                   103 
192                                                   104