Warning, /geant4/examples/extended/medical/dna/splitting/README.md is written in an unsupported language. File is not indexed.
0001 \page ExampleSplitting Example splitting
0002
0003 ## Authorship
0004
0005 Authors: J. A. Ramos-Mendez and B. A. Faddegon
0006
0007 Department of Radiation Oncology, University of California San Francisco
0008
0009 This example is provided by the Geant4-DNA collaboration.
0010
0011 These processes and models are further described at:
0012 http://geant4-dna.org
0013
0014 Any report or published results obtained using the Geant4-DNA software shall
0015 cite the following Geant4-DNA collaboration publications:
0016 - Phys. Med. 31 (2015) 861-874
0017 - Med. Phys. 37 (2010) 4692-4708
0018
0019 If use this example, please cite
0020 - J Ramos-Mendez, et. Al. Phys. Med. Biol. 62(15), 5908-5925, (2017) DOI: 10.1088/1361-6560/aa7831
0021
0022 ## A brief description
0023
0024 The Splitting example uses variance reduction to improve the computational
0025 efficiency of calculations of ionization cluster size distributions. Ionization
0026 events are scored in a nanoscaled cylinder. Ionized electrons generated by
0027 the first generation of secondary electrons are split, i.e. new clone electrons
0028 are generated, labeled and propagated. The label is used to classify those
0029 new particles as if they were produced by independent histories to avoid
0030 overlapping of tracks at final analysis. The Splitting is performed only
0031 if the ionization event occurred in the cylinder.
0032
0033 Geant4-DNA processes are used.
0034
0035 The example package contains:
0036 - source files (src, include)
0037 - README
0038 - .in, plot.C and visualization macro files
0039
0040 ## Set-up
0041
0042 The geometry is a nanoscaled cylinder centered in the world. The medium is
0043 water everywhere. The dimensions can be defined with
0044 ```
0045 /detector/diameter 6 nm
0046 /detector/length 10 nm
0047 ```
0048
0049 User can define the split number (default is 1, i.e. no split)
0050 with:
0051 ```
0052 /vrt/numberOfSplit 10
0053 ```
0054
0055 ## How to run the example.
0056
0057 In interactive mode, run:
0058 ```
0059 ./splitting
0060 Idle> /control/execute vis.mac
0061 ```
0062
0063 In batch mode , run:
0064 ```
0065 ./splitting run.mac
0066 ```
0067
0068 To get visualization, make sure to uncomment the #/control/execute vis.mac line in the macro.
0069
0070 ## Physics
0071
0072 This example shows:
0073 - how to use the Geant4-DNA processes,
0074 - how to implement the Splitting via G4WrappedProcess
0075 - how to set the Splitting in specific region
0076 - how to propagate new track information to secondary particles
0077
0078 A simple electron capture process is also provided in order to kill electrons
0079 below a chosen energy threshold, set in the Physics list.
0080
0081 Look at the PhysicsList class.
0082
0083 ## Simulation output
0084
0085 The output results consists in two histograms in root format
0086
0087 - the energy deposit in the cylindrical target
0088 - the frequency distribution of ionization cluster size
0089
0090 ### Important
0091 Every time a value is added to a ROOT histogram, it contributes to the statistics.
0092 For this example, to correct estimate the uncertainties is recommended to split the simulation into
0093 several jobs and to calculate the statistics from them: batch mode. Otherwise, the statistical
0094 uncertainty may be underestimated.
0095
0096 ## Contact
0097
0098 If you have any questions or wish to notify of updates and/or modification please contact:
0099
0100 J. Ramos-Mendez at joserm84@gmail.com
0101
0102 ## Acknowledgments
0103
0104 Sebastien Incerti (CNRS) for its guidance
