GGEMS  1.1
GPU GEant4-based Monte Carlo Simulations
Functions
GGEMSCTSystem.cc File Reference

GGEMS class managing CT/CBCT detector ct_system_name in GGEMS. More...

#include "GGEMS/navigators/GGEMSCTSystem.hh"
#include "GGEMS/geometries/GGEMSSolidBox.hh"
#include "GGEMS/geometries/GGEMSSolidBoxData.hh"
Include dependency graph for GGEMSCTSystem.cc:

Go to the source code of this file.

Functions

GGEMSCTSystem * create_ggems_ct_system (char const *ct_system_name)
 Get the GGEMSCTSystem pointer for python user. More...
 
void set_number_of_modules_ggems_ct_system (GGEMSCTSystem *ct_system, GGsize const module_x, GGsize const module_y)
 set the number of module in X, Y of local axis of detector More...
 
void set_ct_system_type_ggems_ct_system (GGEMSCTSystem *ct_system, char const *ct_system_type)
 set the type of CT system More...
 
void set_number_of_detection_elements_ggems_ct_system (GGEMSCTSystem *ct_system, GGsize const n_detection_element_x, GGsize const n_detection_element_y, GGsize const n_detection_element_z)
 set the number of detection element inside a module More...
 
void set_size_of_detection_elements_ggems_ct_system (GGEMSCTSystem *ct_system, GGfloat const size_of_detection_element_x, GGfloat const size_of_detection_element_y, GGfloat const size_of_detection_element_z, char const *unit)
 set the size of detection element in X, Y, Z More...
 
void set_material_name_ggems_ct_system (GGEMSCTSystem *ct_system, char const *material_name)
 set the material name for detection element More...
 
void set_source_isocenter_distance_ggems_ct_system (GGEMSCTSystem *ct_system, GGfloat const source_isocenter_distance, char const *unit)
 set source isocenter distance (SID) More...
 
void set_source_detector_distance_ggems_ct_system (GGEMSCTSystem *ct_system, GGfloat const source_detector_distance, char const *unit)
 set source detector distance (SDD) More...
 
void set_rotation_ggems_ct_system (GGEMSCTSystem *ct_system, GGfloat const rx, GGfloat const ry, GGfloat const rz, char const *unit)
 Set the rotation of the voxelized phantom around local axis. More...
 
void set_save_ggems_ct_system (GGEMSCTSystem *ct_system, char const *basename)
 Set the output file and format. More...
 
void set_threshold_ggems_ct_system (GGEMSCTSystem *ct_system, GGfloat const threshold, char const *unit)
 Set the threshold applyied to navigator. More...
 
void store_scatter_ggems_ct_system (GGEMSCTSystem *ct_system, bool const is_scatter)
 Set scatter registration flag. More...
 

Detailed Description

GGEMS class managing CT/CBCT detector ct_system_name in GGEMS.

Author
Julien BERT julie.nosp@m.n.be.nosp@m.rt@un.nosp@m.iv-b.nosp@m.rest..nosp@m.fr
Didier BENOIT didie.nosp@m.r.be.nosp@m.noit@.nosp@m.inse.nosp@m.rm.fr
LaTIM, INSERM - U1101, Brest, FRANCE
Date
Monday October 19, 2020

Definition in file GGEMSCTSystem.cc.

Function Documentation

◆ create_ggems_ct_system()

GGEMSCTSystem* create_ggems_ct_system ( char const *  ct_system_name)

Get the GGEMSCTSystem pointer for python user.

Parameters
ct_system_name- name of ct system
Returns
the pointer on the ct system

Definition at line 281 of file GGEMSCTSystem.cc.

◆ set_ct_system_type_ggems_ct_system()

void set_ct_system_type_ggems_ct_system ( GGEMSCTSystem *  ct_system,
char const *  ct_system_type 
)

set the type of CT system

Parameters
ct_system- pointer on ct system
ct_system_type- type of CT system

Definition at line 299 of file GGEMSCTSystem.cc.

◆ set_material_name_ggems_ct_system()

void set_material_name_ggems_ct_system ( GGEMSCTSystem *  ct_system,
char const *  material_name 
)

set the material name for detection element

Parameters
ct_system- pointer on ct system
material_name- name of the material

Definition at line 326 of file GGEMSCTSystem.cc.

◆ set_number_of_detection_elements_ggems_ct_system()

void set_number_of_detection_elements_ggems_ct_system ( GGEMSCTSystem *  ct_system,
GGsize const  n_detection_element_x,
GGsize const  n_detection_element_y,
GGsize const  n_detection_element_z 
)

set the number of detection element inside a module

Parameters
ct_system- pointer on ct system
n_detection_element_x- Number of detection element inside a module in X (local axis of detector)
n_detection_element_y- Number of detection element inside a module in Y (local axis of detector)
n_detection_element_z- Number of detection element inside a module in Z (local axis of detector)

Definition at line 308 of file GGEMSCTSystem.cc.

◆ set_number_of_modules_ggems_ct_system()

void set_number_of_modules_ggems_ct_system ( GGEMSCTSystem *  ct_system,
GGsize const  module_x,
GGsize const  module_y 
)

set the number of module in X, Y of local axis of detector

Parameters
ct_system- pointer on ct system
module_x- Number of module in X (local axis of detector)
module_y- Number of module in Y (local axis of detector)

Definition at line 290 of file GGEMSCTSystem.cc.

◆ set_rotation_ggems_ct_system()

void set_rotation_ggems_ct_system ( GGEMSCTSystem *  ct_system,
GGfloat const  rx,
GGfloat const  ry,
GGfloat const  rz,
char const *  unit 
)

Set the rotation of the voxelized phantom around local axis.

Parameters
ct_system- pointer on ct system
rx- Rotation around X along local axis
ry- Rotation around Y along local axis
rz- Rotation around Z along local axis
unit- unit of the angle

Definition at line 353 of file GGEMSCTSystem.cc.

◆ set_save_ggems_ct_system()

void set_save_ggems_ct_system ( GGEMSCTSystem *  ct_system,
char const *  basename 
)

Set the output file and format.

Parameters
ct_system- pointer on ct system
basename- basename (without suffix) or output file

Definition at line 362 of file GGEMSCTSystem.cc.

◆ set_size_of_detection_elements_ggems_ct_system()

void set_size_of_detection_elements_ggems_ct_system ( GGEMSCTSystem *  ct_system,
GGfloat const  size_of_detection_element_x,
GGfloat const  size_of_detection_element_y,
GGfloat const  size_of_detection_element_z,
char const *  unit 
)

set the size of detection element in X, Y, Z

Parameters
ct_system- pointer on ct system
size_of_detection_element_x- Size of detection element in X
size_of_detection_element_y- Size of detection element in Y
size_of_detection_element_z- Size of detection element in Z
unit- unit of the distance

Definition at line 317 of file GGEMSCTSystem.cc.

◆ set_source_detector_distance_ggems_ct_system()

void set_source_detector_distance_ggems_ct_system ( GGEMSCTSystem *  ct_system,
GGfloat const  source_detector_distance,
char const *  unit 
)

set source detector distance (SDD)

Parameters
ct_system- pointer on ct system
source_detector_distance- Source detector distance
unit- unit of the distance

Definition at line 344 of file GGEMSCTSystem.cc.

◆ set_source_isocenter_distance_ggems_ct_system()

void set_source_isocenter_distance_ggems_ct_system ( GGEMSCTSystem *  ct_system,
GGfloat const  source_isocenter_distance,
char const *  unit 
)

set source isocenter distance (SID)

Parameters
ct_system- pointer on ct system
source_isocenter_distance- Source isocenter distance
unit- unit of the distance

Definition at line 335 of file GGEMSCTSystem.cc.

◆ set_threshold_ggems_ct_system()

void set_threshold_ggems_ct_system ( GGEMSCTSystem *  ct_system,
GGfloat const  threshold,
char const *  unit 
)

Set the threshold applyied to navigator.

Parameters
ct_system- pointer on ct system
threshold- threshold applyied to navigator
unit- unit of the energy

Definition at line 371 of file GGEMSCTSystem.cc.

◆ store_scatter_ggems_ct_system()

void store_scatter_ggems_ct_system ( GGEMSCTSystem *  ct_system,
bool const  is_scatter 
)

Set scatter registration flag.

Parameters
ct_system- pointer on ct system
is_scatter- flag to activate scatter registration

Definition at line 380 of file GGEMSCTSystem.cc.