GGEMS
1.1
GPU GEant4-based Monte Carlo Simulations
|
This class define a XRay source in GGEMS useful for CT/CBCT simulation. More...
#include "GGEMS/sources/GGEMSSource.hh"
Go to the source code of this file.
Classes | |
class | GGEMSXRaySource |
This class define a XRay source in GGEMS useful for CT/CBCT simulation. More... | |
Functions | |
GGEMSXRaySource * | create_ggems_xray_source (char const *source_name) |
Get the GGEMSXRaySource pointer for python user. More... | |
void | set_position_ggems_xray_source (GGEMSXRaySource *xray_source, GGfloat const pos_x, GGfloat const pos_y, GGfloat const pos_z, char const *unit) |
Set the position of the source in the global coordinates. More... | |
void | set_number_of_particles_xray_source (GGEMSXRaySource *xray_source, GGsize const number_of_particles) |
Set the number of particles to simulate during the simulation. More... | |
void | set_source_particle_type_ggems_xray_source (GGEMSXRaySource *xray_source, char const *particle_name) |
Set the type of the source particle. More... | |
void | set_beam_aperture_ggems_xray_source (GGEMSXRaySource *xray_source, GGfloat const beam_aperture, char const *unit) |
set the beam aperture of the x-ray source More... | |
void | set_focal_spot_size_ggems_xray_source (GGEMSXRaySource *xray_source, GGfloat const width, GGfloat const height, GGfloat const depth, char const *unit) |
Set the focal spot size of the x-ray source. More... | |
void | set_rotation_ggems_xray_source (GGEMSXRaySource *xray_source, GGfloat const rx, GGfloat const ry, GGfloat const rz, char const *unit) |
Set the rotation of the source around global axis. More... | |
void | set_monoenergy_ggems_xray_source (GGEMSXRaySource *xray_source, GGfloat const monoenergy, char const *unit) |
Set the monoenergy value for the GGEMSXRaySource. More... | |
void | set_polyenergy_ggems_xray_source (GGEMSXRaySource *xray_source, char const *energy_spectrum) |
Set the polyenergetic spectrum value for the GGEMSXRaySource. More... | |
This class define a XRay source in GGEMS useful for CT/CBCT simulation.
Definition in file GGEMSXRaySource.hh.
GGEMSXRaySource * create_ggems_xray_source | ( | char const * | source_name | ) |
Get the GGEMSXRaySource pointer for python user.
source_name | - name of the source |
Definition at line 466 of file GGEMSXRaySource.cc.
void set_beam_aperture_ggems_xray_source | ( | GGEMSXRaySource * | xray_source, |
GGfloat const | beam_aperture, | ||
char const * | unit | ||
) |
set the beam aperture of the x-ray source
xray_source | - pointer on the source |
beam_aperture | - beam aperture of the x-ray source |
unit | - unit of the angle |
Definition at line 502 of file GGEMSXRaySource.cc.
void set_focal_spot_size_ggems_xray_source | ( | GGEMSXRaySource * | xray_source, |
GGfloat const | width, | ||
GGfloat const | height, | ||
GGfloat const | depth, | ||
char const * | unit | ||
) |
Set the focal spot size of the x-ray source.
xray_source | - pointer on the source |
width | - width of the focal spot size |
height | - height of the focal spot size |
depth | - depth of the focal spot size |
unit | - unit of the distance |
Definition at line 511 of file GGEMSXRaySource.cc.
void set_monoenergy_ggems_xray_source | ( | GGEMSXRaySource * | xray_source, |
GGfloat const | monoenergy, | ||
char const * | unit | ||
) |
Set the monoenergy value for the GGEMSXRaySource.
xray_source | - pointer on the source |
monoenergy | - monoenergetic value |
unit | - unit of the energy |
Definition at line 529 of file GGEMSXRaySource.cc.
void set_number_of_particles_xray_source | ( | GGEMSXRaySource * | xray_source, |
GGsize const | number_of_particles | ||
) |
Set the number of particles to simulate during the simulation.
xray_source | - pointer on the source |
number_of_particles | - number of particles to simulate |
Definition at line 484 of file GGEMSXRaySource.cc.
void set_polyenergy_ggems_xray_source | ( | GGEMSXRaySource * | xray_source, |
char const * | energy_spectrum | ||
) |
Set the polyenergetic spectrum value for the GGEMSXRaySource.
xray_source | - pointer on the source |
energy_spectrum | - polyenergetic spectrum |
Definition at line 538 of file GGEMSXRaySource.cc.
void set_position_ggems_xray_source | ( | GGEMSXRaySource * | xray_source, |
GGfloat const | pos_x, | ||
GGfloat const | pos_y, | ||
GGfloat const | pos_z, | ||
char const * | unit | ||
) |
Set the position of the source in the global coordinates.
xray_source | - pointer on the source |
pos_x | - Position of the source in X |
pos_y | - Position of the source in Y |
pos_z | - Position of the source in Z |
unit | - unit of the distance |
Definition at line 475 of file GGEMSXRaySource.cc.
void set_rotation_ggems_xray_source | ( | GGEMSXRaySource * | xray_source, |
GGfloat const | rx, | ||
GGfloat const | ry, | ||
GGfloat const | rz, | ||
char const * | unit | ||
) |
Set the rotation of the source around global axis.
xray_source | - pointer on the source |
rx | - Rotation around X along global axis |
ry | - Rotation around Y along global axis |
rz | - Rotation around Z along global axis |
unit | - unit of the degree |
Definition at line 520 of file GGEMSXRaySource.cc.
void set_source_particle_type_ggems_xray_source | ( | GGEMSXRaySource * | xray_source, |
char const * | particle_name | ||
) |
Set the type of the source particle.
xray_source | - pointer on the source |
particle_name | - name/type of the particle: photon or electron |
Definition at line 493 of file GGEMSXRaySource.cc.