README_SimuPBI_3WiresPhant_func.txt

   1 ## SimuPBI_circle_func: function that launches the phase-contrast simulation of a single wire, of a material defined by the user.
   2 # In this file, I detailed all the input and output arguments, followed by one or several examples (one line beginning with a %)
   3 ## Author: Loriane Weber <loriane.weber@creatis.insa-lyon.fr>
   4 ## Created: 2016-02-11
   5
   6 ## Example of use :
   7 ## SimuPBI_3WirePhant_func('Analytical', 2, 'test', [0 0.1 0.5], 19, 2.7, 300, 180, 1, 0, '', 'gaussian', 35)
   8
   9 ## Please note that dir_out, noise_type, noise_amount are optional arguments.
  10 ## This method requires the files 'attenuation.edf', and 'delta_beta_map_1200.edf' in the "images"
  11
  12 ################################################
  13 ############### INPUT parameters ###############
  14 ################################################
  15
  16 ######### Parameter related to the computation - and names of the result #########
  17
  18 ## vers: is a string that defines the way to compute the projections. (ie: are the projections calculated analytically (vers = 'Analytical') or using the Radon transform (vers = 'Radon') ?)
  19 ## use the strings 'Radon' OR 'Analytical'
  20 ## be careful, octave is case-sensitive.
  21 %vers = 'Analytical'
  22 %vers = 'Radon'
  23
  24 ## oversamp: is a number that defines the oversampling of the projections in the real domain.
  25 ## use the number 2 or 4 only
  26 %oversamp = 2
  27 %oversamp = 4
  28
  29 ## basename_output: is a string that contains the basename of the resulting files.
  30 ## use a string, of your choice.
  31 %basename_output = 'Test'
  32
  33 ######### Parameter related to the physics #########
  34
  35 ## dist is a vector, which contains the propagation distances, expressed in meters.
  36 ## use a vector, beggining and ending with a square bracket; the distances should be separated by a space. Use a point as decimal mark.
  37 % dist = [0 0.01 0.1 0.20 0.50]
  38
  39 ## energy refers to the energy of the incoming X-ray beam, expressed in keV.
  40 ## use a float (if decimal, the decimal mark should be a point).
  41 # in the following example, the energy is set to 19 keV and 17.5 keV.
  42 % energy = 19
  43 % energy = 17.5
  44
  45 ## ps refers to the physical pixel size of the detector, expressed in microns.
  46 ## use a float (if decimal, the decimal mark should be a point).
  47 # in the following example, the pixel size is set to 1 um and 3.5 um.
  48 % ps = 1
  49 % ps= 3.5
  50
  51 ## nbproj refers to the number of (equally-angled) projections simulated.
  52 ## use an integer
  53 %nbProj=360
  54
  55 ## range_angle refers to the angular range of the tomography (either 180 or 360 degrees).
  56 ## use 180 or 360.
  57 % range_angle = 180
  58 % range_angle = 360
  59
  60 ## model_ctf refers to the Contrast Transfer Function propagation model. use 1 if you want to simulate propagation with the CTF model, or 0 otherwise.
  61 ## should be equal to 0 or 1
  62 % model_ctf = 1
  63 % model_ctf = 0
  64
  65 ## model_Fresnel refers to the Fresnel propagation model. Use 1 if you want to simulate propagation with the fresnel model, or 0 otherwise.
  66 ## should be equal to 0 or 1
  67 % model_Fresnel = 1
  68 % model_Fresnel = 0
  69
  70
  71 ############# Parameters related to the object #############
  72 ## in this case, the object is a three wire phantom, described in [Frachon, Weber et al., PMB, 2016].
  73 ## height of the object. If height == 1, the simulation is computed in 1D. If height >=2 , the simulation turns into 2D.
  74 %height=10;
  75
  76 ################################
  77 ############# OPTIONAL Parameters
  78 ################################
  79
  80 ## dir_out is a string referring to the output directory
  81 ## By default, the output directory is the working directory. default value is ''.
  82 % dir_out='/mntdirect/_users/lweber/Matlab/SimulationsPBI/Results_Circle'
  83
  84
  85 ## noise_type is a string, referring to the type of noise you want to add to the simulated projections.
  86 ## Use 'gaussian' for addition of gaussian noise, 'poisson' for generation of Poisson noise, or '' for no noise.
  87 ## the default value is '' (no noise)
  88 % noise_type='gaussian'
  89
  90
  91 ## noise_amount is a number (integer or float) referring to the amount of noise. It is defined depending on the type of noise:
  92 ## For additive Gaussian noise, noise_amount is the Peak-to-Peak Signal-to-Noise Ratio (PPSNR), expressed in dB.
  93 ## The default value for additive gaussian noise is 35 dB (noise_amount = 35).
  94 % noise_amount = 40
  95
  96 ## For Poisson noise, noise_amount refer to the percentage of noise.
  97 ## The default value is 5% (noise_amount=0.05).
  98 % noise_amount = 0.15
  99 ## !! note that poisson noise is here not implemented yet
 100
 101 #######################################################
 102 ############### End of INPUT parameters ###############
 103 #######################################################
 104
 105 #################################################
 106 ############### OUTPUT parameters ###############
 107 #################################################
 108
 109 ## None, files are directly save in the output directory (variable out_dir)
 110
 111 ########################################################
 112 ############### End of OUTPUT parameters ###############
 113 ########################################################
 114