Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/extended/medical/fanoCavity/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/extended/medical/fanoCavity/README (Version 11.3.0) and /examples/extended/medical/fanoCavity/README (Version 11.2.2)


  1 ----------------------------------------------      1 -------------------------------------------------------------------
  2                                                     2 
  3      =========================================      3      =========================================================
  4      Geant4 - an Object-Oriented Toolkit for S      4      Geant4 - an Object-Oriented Toolkit for Simulation in HEP
  5      =========================================      5      =========================================================
  6                                                     6 
  7                             fanoCavity              7                             fanoCavity
  8                             ----------              8                             ----------
  9                                                     9 
 10     This program computes the dose deposited i     10     This program computes the dose deposited in an ionization chamber by a
 11     monoenergetic photon beam.                     11     monoenergetic photon beam.
 12     The geometry of the chamber satisfies the      12     The geometry of the chamber satisfies the conditions of charged particle
 13     equilibrium. Hence, under idealized condit     13     equilibrium. Hence, under idealized conditions, the ratio of the dose 
 14     deposited over the beam energy fluence mus     14     deposited over the beam energy fluence must be equal to the 
 15     mass_energy_transfer coefficient of the wa     15     mass_energy_transfer coefficient of the wall material.
 16                                                    16     
 17     E.Poon and al, Phys. Med. Biol. 50 (2005)      17     E.Poon and al, Phys. Med. Biol. 50 (2005) 681
 18     I.Kawrakow, Med. Phys. 27-3 (2000) 499         18     I.Kawrakow, Med. Phys. 27-3 (2000) 499
 19                                                    19 
 20  1- GEOMETRY                                       20  1- GEOMETRY
 21                                                    21  
 22     The chamber is modelized as a cylinder wit     22     The chamber is modelized as a cylinder with a cavity in it.
 23                                                    23      
 24     6 parameters define the geometry :             24     6 parameters define the geometry :
 25       - the material of the wall of the chambe     25       - the material of the wall of the chamber
 26       - the radius of the chamber and the thic     26       - the radius of the chamber and the thickness of the wall
 27       - the material of the cavity                 27       - the material of the cavity
 28       - the radius and the thickness of the ca     28       - the radius and the thickness of the cavity
 29                                                    29 
 30     Wall and cavity must be made of the same m     30     Wall and cavity must be made of the same material, but with different
 31     density                                        31     density
 32                                                    32  
 33     All above parameters can be redifined via      33     All above parameters can be redifined via the UI commands built in 
 34     DetectorMessenger class                        34     DetectorMessenger class
 35                                                    35     
 36                     -----------------              36                     -----------------
 37                     |               |              37                     |               |
 38                     | wall          |              38                     | wall          |
 39                     |     -----     |              39                     |     -----     |
 40                     |     |   |     |              40                     |     |   |     |
 41                     |     | <-+-----+--- cavit     41                     |     | <-+-----+--- cavity
 42          ------>    |     |   |     |              42          ------>    |     |   |     |
 43          ------>    |     |   |     |              43          ------>    |     |   |     |
 44    beam     -------------------------------- c     44    beam     -------------------------------- cylinder axis
 45          ------>    |     |   |     |              45          ------>    |     |   |     |
 46          ------>    |     |   |     |              46          ------>    |     |   |     |
 47                     |     |   |     |              47                     |     |   |     |
 48                     |     |   |     |              48                     |     |   |     |
 49                     |     -----     |              49                     |     -----     |
 50                     |               |              50                     |               |
 51                     |               |              51                     |               |
 52                     -----------------              52                     -----------------
 53                                                    53 
 54  2- BEAM                                           54  2- BEAM
 55                                                    55   
 56     Monoenergetic incident photon beam is unif     56     Monoenergetic incident photon beam is uniformly distribued, perpendicular 
 57     to the flat end of the chamber. The beam r     57     to the flat end of the chamber. The beam radius can be controled with an
 58     UI command built in PrimaryGeneratorMessen     58     UI command built in PrimaryGeneratorMessenger; the default is full wall 
 59     chamber radius.                                59     chamber radius.
 60                                                    60     
 61     Beam regeneration : after each Compton int     61     Beam regeneration : after each Compton interaction, the scattered photon is
 62     reset to its initial state, energy and dir     62     reset to its initial state, energy and direction. Consequently, interaction
 63     sites are uniformly distribued within the      63     sites are uniformly distribued within the wall material.
 64                                                    64     
 65     This modification must be done in the Part     65     This modification must be done in the ParticleChange of the final state 
 66     of the Compton scattering interaction. The     66     of the Compton scattering interaction. Therefore, a specific model
 67     (MyKleinNishinaCompton) is assigned to the     67     (MyKleinNishinaCompton) is assigned to the ComptonScattering process in
 68     PhysicsList. MyKleinNishinaCompton inherit     68     PhysicsList. MyKleinNishinaCompton inherites from G4KleinNishinaCompton;
 69     only the function SampleSecondaries() is o     69     only the function SampleSecondaries() is overwritten.
 70                                                    70     
 71  3- PURPOSE OF THE PROGRAM                         71  3- PURPOSE OF THE PROGRAM
 72                                                    72     
 73     The program computes the dose deposited in     73     The program computes the dose deposited in the cavity and the ratio
 74     Dose/Beam_energy_fluence. This ratio is co     74     Dose/Beam_energy_fluence. This ratio is compared to the mass_energy_transfer
 75     coefficient of the wall material.              75     coefficient of the wall material.
 76                                                    76     
 77     The mass_energy_transfer coefficient needs     77     The mass_energy_transfer coefficient needs :
 78         - the photon total cross section, whic     78         - the photon total cross section, which is read from the PhysicsTables
 79           by G4EmCalculator (see EndOfRunActio     79           by G4EmCalculator (see EndOfRunAction).
 80         - the average kinetic energy of charge     80         - the average kinetic energy of charged secondaries generated in the
 81           wall during the run.                     81           wall during the run. 
 82                                                    82  
 83     The program needs high statistic to reach      83     The program needs high statistic to reach precision on the computed dose.
 84     The UI command /run/printProgress allows t     84     The UI command /run/printProgress allows to survey the convergence of
 85     the kineticEnergy and dose calculations.       85     the kineticEnergy and dose calculations.
 86                                                    86     
 87     In addition, to increase the program effic     87     In addition, to increase the program efficiency, the secondary particles
 88     which have no chance to reach the cavity a     88     which have no chance to reach the cavity are immediately killed (see
 89     StackinAction). This feature can be switch     89     StackinAction). This feature can be switched off by an UI command (see
 90     StackingMessenger).                            90     StackingMessenger).
 91                                                    91     
 92     The simplest way to study the effect of e-     92     The simplest way to study the effect of e- tracking parameters on dose 
 93     deposition is to use the command /testem/s     93     deposition is to use the command /testem/stepMax.
 94                                                    94     
 95  4- PHYSICS                                        95  4- PHYSICS
 96                                                    96  
 97     The physics lists contains the standard el     97     The physics lists contains the standard electromagnetic processes, with few 
 98     modifications listed here.                     98     modifications listed here.
 99                                                    99     
100     - Compton scattering : as explained above,    100     - Compton scattering : as explained above, the final state is modified in
101     MyKleinNishinaCompton class.                  101     MyKleinNishinaCompton class.
102                                                   102     
103     In order to make the program more efficien    103     In order to make the program more efficient, one can increase the Compton
104     cross section via the function SetCSFactor    104     cross section via the function SetCSFactor(factor) and its 
105     associated UI command. Default is factor=1    105     associated UI command. Default is factor=1000.
106                                                   106     
107     - Bremsstrahlung : Fano conditions imply n    107     - Bremsstrahlung : Fano conditions imply no energy transfer via
108     bremsstrahlung radiation. Therefore this p    108     bremsstrahlung radiation. Therefore this process is not registered in the
109     physics list. However, it is always possib    109     physics list. However, it is always possible to include it.
110     See PhysListEmStandard class.                 110     See PhysListEmStandard class.
111                                                   111     
112     - Ionisation : In order to have same stopp    112     - Ionisation : In order to have same stopping power in wall and cavity, one
113     must cancel the density correction term in    113     must cancel the density correction term in the dedx formula. This is done in
114     a specific MollerBhabha model (MyMollerBha    114     a specific MollerBhabha model (MyMollerBhabhaModel) which inherites from 
115     G4MollerBhabhaModel.                          115     G4MollerBhabhaModel.
116                                                   116     
117     To prevent explicit generation of delta-ra    117     To prevent explicit generation of delta-rays, the default production
118     threshold (i.e. cut) is set to 10 km (CSDA    118     threshold (i.e. cut) is set to 10 km (CSDA condition).
119                                                   119     
120     The finalRange of the step function is set    120     The finalRange of the step function is set to 10 um, which more on less
121     correspond to a tracking cut in water of a    121     correspond to a tracking cut in water of about 20 keV. See emOptions.
122     Once again, the above parameters can be co    122     Once again, the above parameters can be controled via UI commands.
123                                                   123     
124     - Multiple scattering : is switched in sin    124     - Multiple scattering : is switched in single Coulomb scattering mode near
125     boundaries. This is selected via EM option    125     boundaries. This is selected via EM options in PhysicsList, and can be
126     controled with UI commands.                   126     controled with UI commands.
127                                                   127     
128     - All PhysicsTables are built with 100 bin    128     - All PhysicsTables are built with 100 bins per decade.  
129                                                   129     
130  5- HISTOGRAMS                                    130  5- HISTOGRAMS
131                                                   131  
132    fanoCavity has several predefined 1D histog    132    fanoCavity has several predefined 1D histograms : 
133                                                   133   
134       1 : emission point of e+-                   134       1 : emission point of e+-
135       2 : energy spectrum of e+-                  135       2 : energy spectrum of e+-
136       3 : theta distribution of e+-               136       3 : theta distribution of e+-
137       4 : emission point of e+- hitting cavity    137       4 : emission point of e+- hitting cavity
138       5 : energy spectrum of e+- when entering    138       5 : energy spectrum of e+- when entering in cavity
139       6 : theta distribution of e+- before ent    139       6 : theta distribution of e+- before enter in cavity
140       7 : theta distribution of e+- at first s    140       7 : theta distribution of e+- at first step in cavity      
141       8 : track segment of e+- in cavity          141       8 : track segment of e+- in cavity
142       9 : step size of e+- in wall                142       9 : step size of e+- in wall
143      10 : step size of e+- in cavity              143      10 : step size of e+- in cavity
144      11 : energy deposit in cavity per track      144      11 : energy deposit in cavity per track     
145                                                   145       
146    The histograms are managed by G4AnalysisMan    146    The histograms are managed by G4AnalysisManager class and its messenger. 
147    The histos can be individually activated wi    147    The histos can be individually activated with the command :
148    /analysis/h1/set id nbBins  valMin valMax u    148    /analysis/h1/set id nbBins  valMin valMax unit 
149    where unit is the desired unit for the hist    149    where unit is the desired unit for the histo (MeV or keV, deg or mrad, etc..)
150                                                   150    
151    One can control the name of the histograms     151    One can control the name of the histograms file with the command:
152    /analysis/setFileName  name  (default fanoC    152    /analysis/setFileName  name  (default fanoCavity)
153                                                   153    
154    It is possible to choose the format of the     154    It is possible to choose the format of the histogram file : root (default),
155    hdf5, xml, csv, by changing the default fil    155    hdf5, xml, csv, by changing the default file type in HistoManager.cc
156                                                   156    
157    It is also possible to print selected histo    157    It is also possible to print selected histograms on an ascii file:
158    /analysis/h1/setAscii id                       158    /analysis/h1/setAscii id
159    All selected histos will be written on a fi    159    All selected histos will be written on a file name.ascii (default fanocavity)
160                                                   160  
161  6- HOW TO START ?                                161  6- HOW TO START ?
162                                                   162  
163     - execute fanoCavity in 'batch' mode from     163     - execute fanoCavity in 'batch' mode from macro files
164         % fanoCavity   run01.mac                  164         % fanoCavity   run01.mac
165                                                   165  
166     - execute fanoCavity in 'interactive mode'    166     - execute fanoCavity in 'interactive mode' with visualization
167         % fanoCavity                              167         % fanoCavity
168         ....                                      168         ....
169         Idle> type your commands                  169         Idle> type your commands
170         ....                                      170         ....
171         Idle> exit                                171         Idle> exit
172                                                << 
173    Alternative macro file:                     << 
174    basic.mac - disabled  multiple scattering a <<