Back to home page

EIC code displayed by LXR

 
 

    


Warning, /geant4/examples/advanced/ICRP145_HumanPhantoms/README is written in an unsupported language. File is not indexed.

0001 
0002      =========================================================
0003                       Geant4 - ICRP145_HumanPhantoms example
0004      =========================================================
0005 
0006                              README
0007                       ---------------------
0008 
0009 
0010 ********************************************************************
0011 * The ICRP145 Phantoms are used in Geant4 with permission from the *
0012 * International Commission on  Radiological Protection             *                                               *
0013 ********************************************************************
0014 
0015 Authors' list:
0016 •     Haeginh Han / Hanyang University, Republic of Korea
0017 •     Min Cheol Han /  Yonsei University Health System, Republic of Korea
0018 •     Banho Shin / Hanyang University, Republic of Korea
0019 •     Chansoo Choi /  University of Florida, USA
0020 •     Yeon Soo Yeom /  Yonsei University, Republic of Korea
0021 •     Jonghwi Jeong / National Cancer Center, Republic of Korea
0022 •     Chan Hyeong Kim / Hanyang University, Republic of Korea
0023 
0024 Bibliographic references - please refer to this reference when using the Advanced Example
0025 •     ICRP, 2020. Adult mesh-type reference computational phantoms. ICRP Publication 145. Ann. ICRP 49(3).
0026 
0027 Geant4 Contributors: J. Allison and S. Guatelli
0028 
0029 e-mail inquiries to: haeginh@hanyang.ac.kr, susanna@uow.edu.au, MRCP.ICRP@gmail.com               
0030 
0031 1- HOW TO BUILD AND RUN THE EXAMPLES
0032   
0033   Please note that the guides below are based on Linux/MacOSX, which are the
0034   recommended platforms for Geant4.
0035   
0036 1) Compile and link to generate an executable (with CMake)
0037   
0038         % cd path_to_example    
0039         % mkdir example_build 
0040         % cd example_build
0041         % cmake ..
0042         % make
0043    This should make two executables - ICRP145phantoms and ICRP145standalone.
0044   
0045 2) How to run
0046   
0047     a) For the irradiation with external beams:
0048 
0049         % ./ICRP145phantoms [options]
0050         
0051         Options:
0052         -m [input file name]    optional provided->batch mode
0053                                          not provided->interactive mode
0054         -o [output file name]   optional (default: [macro file name].out)
0055         -f                      optional  switch to change the phantom to MRCP-AF
0056                                           (default: MRCP-AM)
0057           
0058           ex) MRCP-AM: % ./External -m example.in -o example.out
0059           ex) MRCP-AF: % ./External -m example.in -o example.out -f 
0060         
0061        *** The radiation source can be specified in source.mac file by using
0062        macro commands for G4GeneralParticleSource (/gps/)
0063           
0064     b) For the case of internal radiation sources: 
0065     
0066         % ./ICRP145phantoms [options]
0067 
0068         Options:
0069         -i [ID of source organ] mandatory (ID of each organ can be found in Appendix A)
0070         -m [input file name]    optional  provided->batch mode
0071                                           not provided->interactive mode
0072         -o [output file name]   optional  (default: [macro file name].out)
0073         -f                      optional  switch to change the phantom to MRCP-AF
0074                                           (default: MRCP-AM)
0075 
0076           ex) MRCP-AM: % ./Internal -i 9500 -m example.in -o example.out
0077           ex) MRCP-AF: % ./Internal -i 9500 -m example.in -o example.out -f 
0078           
0079           *** source organ can be defined by using -i option.
0080           *** source particle and the particle energy can be specified
0081               in source.mac file by using macro commands for G4ParticlGun (/gun/)
0082 
0083     c) To see the phantom alone:
0084 
0085               % ./ICRP145standalone
0086 
0087        This allows you to visualise the phantom without the overhead of
0088        the run manager and physics tables and geometry initialisation.
0089        Of course, you cannot run or visualise trajectories.
0090 
0091     d) Notes
0092     
0093       - Regarding the interactive mode with visualisation:
0094          
0095          * you can run the codes in interactive mode with visualisation by 
0096            omitting -m option.
0097          * with "special mesh rendering" (see vis.mac) the memory required
0098            for the visualisation about 1.5 GB (without, it's ~35 GB!).
0099          * original data takes about 3 GB, physics tables and geometry
0100            voxelisation consume about 5 GB, so a typical app is about 10 GB.
0101          * in interactive mode, user should start a run by using 
0102            /run/beamOn command. (Idle> /run/beamOn [number of events])
0103           
0104           
0105       - Regarding the multi-threaded mode:
0106          
0107          * these examples can be run in multi-threaded mode when Geant4 was 
0108            compiled in multi-threaded mode.
0109          * the number of threads can be set in input file (see example.in)
0110          
0111       - Regarding the path to phantom data:
0112        
0113          * the default path to phantom data is "(build_directory)/../../phantoms".
0114          * to specify the path please change a PHANTOM_PATH environment variable.
0115            (export PHANTOM_PATH="path_to_phantom_data")
0116           
0117 2- RESULT FILE
0118 
0119   example_male.out and example_female.out files in each folder is the result file
0120   for example.in. The result file provides absorbed doses for all organ IDs for TM 
0121   model listed in Appendix A.
0122        
0123 3- LICENSE
0124 
0125   This code is based on Geant4 toolkit, and therefore follows the 'The Geant4
0126   Software License' (http://geant4.web.cern.ch/license/LICENSE.html).
0127   
0128