GGEMS
1.1
GPU GEant4-based Monte Carlo Simulations
|
Class providing tools storing and computing dose in phantom. More...
#include "GGEMS/global/GGEMSExport.hh"
#include "GGEMS/tools/GGEMSTypes.hh"
#include "GGEMS/navigators/GGEMSDoseRecording.hh"
Go to the source code of this file.
Classes | |
class | GGEMSDosimetryCalculator |
Class providing tools storing and computing dose in phantom. More... | |
Functions | |
GGEMSDosimetryCalculator * | create_ggems_dosimetry_calculator (void) |
Get the GGEMSDosimetryCalculator pointer for python user. More... | |
void | delete_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator) |
Delete instance of GGEMSDosimetryCalculator. More... | |
void | scale_factor_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, GGfloat const scale_factor) |
set the scale factor applied to dose value More... | |
void | water_reference_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, bool const is_activated) |
set water reference mode More... | |
void | minimum_density_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, GGfloat const minimum_density, char const *unit) |
set minimum of density for dose computation More... | |
void | set_dosel_size_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, GGfloat const dose_x, GGfloat const dose_y, GGfloat const dose_z, char const *unit) |
set size of dosels More... | |
void | set_dose_output_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, char const *dose_output_filename) |
set output filename storing dosimetry More... | |
void | dose_photon_tracking_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, bool const is_activated) |
storing results about photon tracking More... | |
void | dose_edep_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, bool const is_activated) |
storing results about energy deposit More... | |
void | dose_hit_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, bool const is_activated) |
storing results about hit tracking More... | |
void | dose_edep_squared_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, bool const is_activated) |
storing results about energy squared deposit More... | |
void | dose_uncertainty_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, bool const is_activated) |
storing results about uncertainty More... | |
void | attach_to_navigator_dosimetry_calculator (GGEMSDosimetryCalculator *dose_calculator, char const *navigator) |
attach dosimetry module to a navigator More... | |
Class providing tools storing and computing dose in phantom.
Definition in file GGEMSDosimetryCalculator.hh.
void attach_to_navigator_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
char const * | navigator | ||
) |
attach dosimetry module to a navigator
dose_calculator | - pointer on dose calculator |
navigator | - name of the navigator to attach |
Definition at line 862 of file GGEMSDosimetryCalculator.cc.
GGEMSDosimetryCalculator * create_ggems_dosimetry_calculator | ( | void | ) |
Get the GGEMSDosimetryCalculator pointer for python user.
Definition at line 751 of file GGEMSDosimetryCalculator.cc.
GGEMSTube * delete_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator | ) |
Delete instance of GGEMSDosimetryCalculator.
dose_calculator | - pointer on dose calculator |
Definition at line 760 of file GGEMSDosimetryCalculator.cc.
void dose_edep_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
bool const | is_activated | ||
) |
storing results about energy deposit
dose_calculator | - pointer on dose calculator |
is_activated | - boolean activating energy deposit output |
Definition at line 808 of file GGEMSDosimetryCalculator.cc.
void dose_edep_squared_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
bool const | is_activated | ||
) |
storing results about energy squared deposit
dose_calculator | - pointer on dose calculator |
is_activated | - boolean activating energy squared deposit output |
Definition at line 826 of file GGEMSDosimetryCalculator.cc.
void dose_hit_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
bool const | is_activated | ||
) |
storing results about hit tracking
dose_calculator | - pointer on dose calculator |
is_activated | - boolean activating the hit tracking output |
Definition at line 817 of file GGEMSDosimetryCalculator.cc.
void dose_photon_tracking_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
bool const | is_activated | ||
) |
storing results about photon tracking
dose_calculator | - pointer on dose calculator |
is_activated | - boolean activating the photon tracking output |
Definition at line 799 of file GGEMSDosimetryCalculator.cc.
void dose_uncertainty_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
bool const | is_activated | ||
) |
storing results about uncertainty
dose_calculator | - pointer on dose calculator |
is_activated | - boolean activating uncertainty output |
Definition at line 835 of file GGEMSDosimetryCalculator.cc.
void minimum_density_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
GGfloat const | minimum_density, | ||
char const * | unit | ||
) |
set minimum of density for dose computation
dose_calculator | - pointer on dose calculator |
minimum_density | - minimum of density |
unit | - unit of the density |
Definition at line 853 of file GGEMSDosimetryCalculator.cc.
void scale_factor_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
GGfloat const | scale_factor | ||
) |
set the scale factor applied to dose value
dose_calculator | - pointer on dose calculator |
scale_factor | - scale factor applied to dose value |
Definition at line 772 of file GGEMSDosimetryCalculator.cc.
void set_dose_output_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
char const * | dose_output_filename | ||
) |
set output filename storing dosimetry
dose_calculator | - pointer on dose calculator |
dose_output_filename | - name of output dosimetry file storing dosimetry |
Definition at line 790 of file GGEMSDosimetryCalculator.cc.
void set_dosel_size_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
GGfloat const | dose_x, | ||
GGfloat const | dose_y, | ||
GGfloat const | dose_z, | ||
char const * | unit | ||
) |
set size of dosels
dose_calculator | - pointer on dose calculator |
dose_x | - size of dosel in X global axis |
dose_y | - size of dosel in Z global axis |
dose_z | - size of dosel in Y global axis |
unit | - unit of the distance |
Definition at line 781 of file GGEMSDosimetryCalculator.cc.
void water_reference_dosimetry_calculator | ( | GGEMSDosimetryCalculator * | dose_calculator, |
bool const | is_activated | ||
) |
set water reference mode
dose_calculator | - pointer on dose calculator |
is_activated | - boolean activating water reference mode for dose computation |
Definition at line 844 of file GGEMSDosimetryCalculator.cc.