Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/examples/extended/medical/dna/wholeNuclearDNA/

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 ]

Name Size       Last modified (GMT) Description
Back Parent directory       2024-12-05 15:16:16
Folder include/       2024-12-05 15:16:16
Folder src/       2024-12-05 15:16:16
File CMakeLists.txt 2727 bytes       2024-12-05 15:16:16
File GNUmakefile 373 bytes       2024-12-05 15:16:16
File History 2765 bytes       2024-12-05 15:16:16
File README 5842 bytes       2024-12-05 15:16:16
File chromo1.dat 12854 bytes       2024-12-05 15:16:16
File chromo10.dat 6470 bytes       2024-12-05 15:16:16
File chromo11.dat 6461 bytes       2024-12-05 15:16:16
File chromo12.dat 6402 bytes       2024-12-05 15:16:16
File chromo13.dat 5518 bytes       2024-12-05 15:16:16
File chromo14.dat 4716 bytes       2024-12-05 15:16:16
File chromo15.dat 4447 bytes       2024-12-05 15:16:16
File chromo16.dat 4153 bytes       2024-12-05 15:16:16
File chromo17.dat 3775 bytes       2024-12-05 15:16:16
File chromo18.dat 4193 bytes       2024-12-05 15:16:16
File chromo19.dat 2833 bytes       2024-12-05 15:16:16
File chromo2.dat 12712 bytes       2024-12-05 15:16:16
File chromo20.dat 2820 bytes       2024-12-05 15:16:16
File chromo21.dat 2183 bytes       2024-12-05 15:16:16
File chromo22.dat 2408 bytes       2024-12-05 15:16:16
File chromo3.dat 10526 bytes       2024-12-05 15:16:16
File chromo4.dat 9800 bytes       2024-12-05 15:16:16
File chromo5.dat 8768 bytes       2024-12-05 15:16:16
File chromo6.dat 8568 bytes       2024-12-05 15:16:16
File chromo7.dat 7910 bytes       2024-12-05 15:16:16
File chromo8.dat 7183 bytes       2024-12-05 15:16:16
File chromo9.dat 6290 bytes       2024-12-05 15:16:16
File chromoX.dat 7581 bytes       2024-12-05 15:16:16
File chromoY.dat 2514 bytes       2024-12-05 15:16:16
File plot.C 1022 bytes       2024-12-05 15:16:16
File vis.mac 2609 bytes       2024-12-05 15:16:16
C++ file wholeNuclearDNA.cc 8277 bytes       2024-12-05 15:16:16
File wholeNuclearDNA.in 137 bytes       2024-12-05 15:16:16
File wholeNuclearDNA.out 29127 bytes       2024-12-05 15:16:16

  1      =========================================================
  2       Geant4 - wholenucleardna example
  3      =========================================================
  4 
  5                                 README file
  6                           ----------------------
  7 
  8                            CORRESPONDING AUTHOR 
  9 
 10 For any question, please contact:
 11 C. Villagrasa
 12 email: carmen.villagrasa@irsn.fr
 13 
 14 This example is provided by the Geant4-DNA collaboration
 15 Any report or published results obtained using the Geant4-DNA software 
 16 and the DNA geometry given in the Geom_DNA example 
 17 shall cite the following Geant4-DNA collaboration publications:
 18 [1] NIM B 298 (2013) 47-54
 19 [2] Med. Phys. 37 (2010) 4692-4708
 20 [3] Phys. Med. 31 (2015) 861-874
 21 
 22 ---->0. INTRODUCTION.                                                    
 23                                                                        
 24 The wholenucleardna example offers the basic tools to simulate the track structure of different charge particles within a
 25 simplified geometrical model of the DNA molecule contained in a cell nucleus. 
 26 In this example, the DetectorConstruction file contains the placement of the 6 Gbp (base-pairs) of a human cell respecting five compaction levels in the structure of the DNA molecule: double helix, nucleosome, chromatin fiber, simple chromatin fiber loop and complex chromatin fiber loops.
 27 These complex chromatin fiber loops are then used to fill the chromosome territories using a constant density (~30-31 kbp/µm3.
 28 Even though this geometry defines different volumes for the DNA base, the back-bone region or the histone proteins, the material filling all these volumes in the simulation is liquid water ("G4_WATER")
 29 
 30 In order to simulate all the energy transfer points of the track at nanometric level, the Geant4-DNA physics processes and models are used. 
 31 These processes and models are further described at:
 32 http://geant4-dna.org
 33 
 34 ---->1. GEOMETRY SET-UP.
 35  
 36 As indicated in the introduction, the whole DNA molecule contained in a human cell with 5 different compaction levels is described in this geometry. In order to place the complex chromatin loops in each of the 43 chromosome territories, the files called "chromo-number.dat" are needed. 
 37 These 43 chromosome territories are then placed in an ellipsoid that has the typical dimensions of a human fibroblast cell nucleus.
 38 All the volumes in the geometry are made of liquid water (G4_WATER material) despite of what they geometrically represent.
 39 Particles are shot from a random (x,y)position covering the main central part of the cell nucleus and at z=2.99 µm from the center of the nucleus. This value allows the primary particle to be either inside the cell nucleus, either not far from the entrance surface so its energy loss before the cell nucleus entrance is negligible. 
 40 
 41 WARNING: By default, the bases are not built. To build the whole geometry, set the flag fBuildBases in DetectorConstruction to true.
 42 
 43 ---->2. SET-UP 
 44                                                                         
 45 Make sure G4LEDATA points to the low energy electromagnetic data files.
 46 
 47 The variable G4ANALYSIS_USE must be set to 1.
 48 
 49 The code can be compiled with gmake.
 50 
 51 ---->3. HOW TO RUN THE EXAMPLE                                         
 52 
 53 In normal mode, without interactivity:
 54 
 55 > wholeNuclearDNA
 56 
 57 In interactive mode, run:
 58 
 59 > wholeNuclearDNA -gui -out
 60 
 61 The -gui option launches a user interface for interactivity
 62 The -out option create a root file (can be changed for other format). This option may also take argument to set the name of the file (name of the application by default):
 63 
 64 > wholeNuclearDNA -gui -out MyFile
 65 
 66 The macro wholenucleardna.in is executed by default. A proton of 0.1 MeV is shot. This energy has been chosen because only a few minutes are needed for the proton to lose all its energy and thus the event to finish. Nevertheless, one should keep in mind that for this energy, protons do not traverse the whole cell nucleus width. 
 67 
 68 Visualization (DAWN) is not activated by default in wholenucleardna.mac. To get visualization, make sure to uncomment the #/control/execute vis.mac.
 69 We would like to warn the users that the time to visualize the whole DNA structure is extremely long.
 70 
 71 To build the whole geometry, set the flag fBuildBases in DetectorConstruction to true.
 72 
 73 ---->4. PHYSICS
 74 
 75 This example uses the Geant4-DNA processes, using the G4EmDNAPhysics constructor as in the dnaphysics example.
 76 
 77 ---->5. SIMULATION OUTPUT AND RESULT ANALYSIS                                    
 78 
 79 The output results consist in a wholenucleardna.root file, containing only the information about the energy transfers located in the backbone region of the DNA double helix. Both strands are distinguished with different flags (1 or 2):
 80 - the type of particle for the current step
 81 - the type of process for the current step
 82 - the flag of the strand (1 or 2)
 83 - the track position of the current energy transfer (in nanometers) 
 84 - the energy deposit corresponding to the energy transfer (in eV)
 85 - the total energy loss along the current step (in eV)
 86 - the step length (in nm)
 87 
 88 
 89 This file can be easily analyzed using for example the provided ROOT macro 
 90 file plot.C; to do so :
 91 * be sure to have ROOT installed on your machine
 92 * be sure to be in the directory containing the ROOT files created by wholenucleardna
 93 * copy plot.C into this directory
 94 * from there, launch ROOT by typing root
 95 * under your ROOT session, type in : .X plot.C to execute the macro file
 96 * alternatively you can type directly under your session : root plot.C
 97 
 98 The naming scheme on the displayed ROOT plots can be seen in the SteppingAction.cc file.
 99 
100 -------------------------------------------------------------------------
101 
102 
103