README_unknown_1D_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_unknown_1D('star', 2, [0 0.1 0.5], 26, 2.7, 300, 180, 1, 1, '/users/lweber/Matlab/SimulationsPBI/mu_star.edf', '/users/lweber/Matlab/SimulationsPBI/delta_star.edf', '', 'gaussian', 35)
   8
   9 ## Please note that dir_out, noise_type, noise_amount are optional arguments.
  10
  11 ################################################
  12 ############### INPUT parameters ###############
  13 ################################################
  14
  15 ######### Parameter related to the computation - and names of the result #########
  16
  17 ## vers does not exist anymore; the projections are calculated using the Radon transform
  18
  19 ## oversamp: is a number that defines the oversampling of the projections in the real domain.
  20 ## use the number 2 or 4 only
  21 %oversamp = 2
  22 %oversamp = 4
  23
  24 ## basename_output: is a string that contains the basename of the resulting files.
  25 ## use a string, of your choice.
  26 %basename_output = 'Test'
  27
  28 ######### Parameter related to the physics #########
  29
  30 ## dist is a vector, which contains the propagation distances, expressed in meters.
  31 ## use a vector, beggining and ending with a square bracket; the distances should be separated by a space. Use a point as decimal mark.
  32 % dist = [0 0.01 0.1 0.20 0.50]
  33
  34 ## energy refers to the energy of the incoming X-ray beam, expressed in keV.
  35 ## use a float (if decimal, the decimal mark should be a point).
  36 # in the following example, the energy is set to 19 keV and 17.5 keV.
  37 % energy = 19
  38 % energy = 17.5
  39
  40 ## ps refers to the physical pixel size of the detector, expressed in microns.
  41 ## use a float (if decimal, the decimal mark should be a point).
  42 # in the following example, the pixel size is set to 1 um and 3.5 um.
  43 % ps = 1
  44 % ps= 3.5
  45
  46 ## nbproj refers to the number of (equally-angled) projections simulated.
  47 ## use an integer
  48 %nbProj=360
  49
  50 ## range_angle refers to the angular range of the tomography (either 180 or 360 degrees).
  51 ## use 180 or 360.
  52 % range_angle = 180
  53 % range_angle = 360
  54
  55 ## 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.
  56 ## should be equal to 0 or 1
  57 % model_ctf = 1
  58 % model_ctf = 0
  59
  60 ## model_Fresnel refers to the Fresnel propagation model. Use 1 if you want to simulate propagation with the fresnel model, or 0 otherwise.
  61 ## should be equal to 0 or 1
  62 % model_Fresnel = 1
  63 % model_Fresnel = 0
  64
  65
  66 ############# Parameters related to the circle #############
  67
  68 ## attenuation map (in cm^-1)
  69 %attenuation_file='mu_star.edf'
  70
  71 ## Refractive index decrement map (delta)
  72 %phase_file='delta_star.edf'
  73
  74 ################################
  75 ############# OPTIONAL Parameters
  76 ################################
  77
  78 ## dir_out is a string referring to the output directory
  79 ## By default, the output directory is the working directory. default value is ''.
  80 % dir_out='/mntdirect/_users/lweber/Matlab/SimulationsPBI/Results_Circle'
  81
  82
  83 ## Noise-related part
  84 ## Noise addition to the simulated data?
  85 ## Use noise='gaussian' (addition of gaussian noise) or noise='poisson' ( generation of Poisson noise) or '' (no noise is added).
  86
  87 %noise_type='gaussian'
  88 % default value is '' (no noise)
  89
  90 ## Amount of noise
  91 ## If 'gaussian' (additive noise), please specify the Peak-to-peak Signe-to-noise ratio (PPSNR, in dB)
  92 % noise_amount=40;
  93 %default value is 35 dB
  94 ## if 'poisson', please specify the amount of noise
  95 %noise_amount=0.05;
  96 % default value is 5%.
  97
  98 %noise=0; % O (no noise) or 1 (noise)
  99 %PPSNR=24; % noise, in dB
 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