source: trunk/examples/advanced/brachytherapy/README @ 1303

Last change on this file since 1303 was 807, checked in by garnier, 16 years ago

update

File size: 4.9 KB
Line 
1
2     =========================================================
3                      Geant4 - Brachytherapy example
4     =========================================================
5
6                             README
7                      ---------------------
8
9------------------------------------------------------------------------
10----> Introduction.                                                     
11                                                                       
12Brachytherapy example simulates energy deposit in a Phantom filled with
13soft tissue for:
141) Iridium source (endocavitary brachytherapy).                         
152) Iodium  source (interstitial brachytherapy).                         
163) Leipzig Applicator (superficial brachytherapy).                     
17------------------------------------------------------------------------
18----> 1.Experimental set-up.                                           
19
20The default source is an Ir-131 source put in the center of the Phantom.
21The Phantom is a box (dimension:30cm), it is gridded in
22voxels (1.mm dimension)                                                 
23-------------------------------------------------------------------------
24----> 2.SET-UP
25                                         
26 -a standard Geant4 example GNUmakefile is provided                     
27
28setup with:                                                             
29G4SYSTEM = linux-g++                                                     
30
31The following environment variables need to be set:                     
32
33G4LEDATA: points to low energy database             
34
35setup for analysis: AIDA 3.2.1, PI 1.3.3 (PI is Obsolete)
36
37Users can download the analysis tools from: 
38                                                                       
39http://aida.freehep.org/
40http://cern.ch/pfeiffer
41http://www.cern.ch/PI  (OBSOLETE)
42------------------------------------------------------------------------
43----> 3.How to run the example.                                         
44
45- batch mode:
46  $G4WORKDIR/bin/Linux-g++/Brachy IridiumSourceMacro.mac               
47  $G4WORKDIR/bin/Linux-g++/Brachy IodiumSourceMacro.mac       
48  $G4WORKDIR/bin/Linux-g++/Brachy LeipzigSourceMacro.mac 
49                                                                       
50- Interative mode:                                                     
51  3) $G4WORKDIR/bin/Linux-g++/Brachy
52     The VisualisationMacro.mac is loaded automatically                 
53
54-->possible different configurations for interactive mode:             
55
561)Ir source:                                                           
57idle>/run/beamOn NumberOfEvents      ...and then
58idle>exit                                                               
59
602)Leipzig Applicator:                                                   
61idle>/source/switch Leipzig                                           
62idle>/run/beamOn NumberOfEvents     ...and then                         
63idle> exit
64                                                                       
653) Iodium  source:
66idle>/source/switch Iodium                                               
67idle>/primary/energy Iodium
68idle>/run/beamOn NumberOfEvents     ...and then                         
69idle>exit
70                                                                         
71*Before the run you can also change the absorber material of the
72Phantom:                                                                 
73idle>/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
82if 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                                                                         
92Units:   the energy deposit is in MeV;
93         x, y, z in mm for histograms and ntuple                         
94------------------------------------------------------------------------
95----> 5.Visualisation                                                     
96
97a macro is provided ad example of visualisation:  VisualisationMacro.mac
98
99------------------------------------------------------------------------
100
101Further information at http://www.ge.infn.it/geant4/examples/index.html
102Contact: geant4-advanced-examples@cern.ch
103
104
Note: See TracBrowser for help on using the repository browser.