GGEMSVoxelizedPhantom Class Reference

Child GGEMS class handling voxelized phantom. More...

#include "GGEMSVoxelizedPhantom.hh"

Inheritance diagram for GGEMSVoxelizedPhantom:

Collaboration diagram for GGEMSVoxelizedPhantom:

Public Member Functions
	GGEMSVoxelizedPhantom (std::string const &voxelized_phantom_name)
	GGEMSVoxelizedPhantom constructor. More...
	~GGEMSVoxelizedPhantom (void)
	GGEMSVoxelizedPhantom destructor. More...
	GGEMSVoxelizedPhantom (GGEMSVoxelizedPhantom const &voxelized_phantom)=delete
	Avoid copy by reference. More...
GGEMSVoxelizedPhantom &	operator= (GGEMSVoxelizedPhantom const &voxelized_phantom)=delete
	Avoid assignement by reference. More...
	GGEMSVoxelizedPhantom (GGEMSVoxelizedPhantom const &&voxelized_phantom)=delete
	Avoid copy by rvalue reference. More...
GGEMSVoxelizedPhantom &	operator= (GGEMSVoxelizedPhantom const &&voxelized_phantom)=delete
	Avoid copy by rvalue reference. More...
void	SetPhantomFile (std::string const &voxelized_phantom_filename, std::string const &range_data_filename)
	set the mhd filename for voxelized phantom and the range data file More...
void	Initialize (void) override
	Initialize the voxelized phantom. More...
void	SaveResults (void) override
	save all results from solid More...
Public Member Functions inherited from GGEMSNavigator
	GGEMSNavigator (std::string const &navigator_name)
	GGEMSNavigator constructor. More...
virtual	~GGEMSNavigator (void)
	GGEMSNavigator destructor. More...
	GGEMSNavigator (GGEMSNavigator const &navigator)=delete
	Avoid copy by reference. More...
GGEMSNavigator &	operator= (GGEMSNavigator const &navigator)=delete
	Avoid assignement by reference. More...
	GGEMSNavigator (GGEMSNavigator const &&navigator)=delete
	Avoid copy by rvalue reference. More...
GGEMSNavigator &	operator= (GGEMSNavigator const &&navigator)=delete
	Avoid copy by rvalue reference. More...
void	SetPosition (GGfloat const &position_x, GGfloat const &position_y, GGfloat const &position_z, std::string const &unit="mm")
	set the position of the global navigator in X, Y and Z More...
void	SetRotation (GGfloat const &rx, GGfloat const &ry, GGfloat const &rz, std::string const &unit="deg")
	Set the rotation of the global navigator around global axis. More...
void	SetThreshold (GGfloat const &threshold, std::string const &unit="keV")
	Set the energy threshold to navigator. More...
void	SetNavigatorID (GGsize const &navigator_id)
	set the navigator index More...
std::string	GetNavigatorName (void) const
	Get the name of the navigator. More...
GGsize	GetNumberOfSolids (void) const
	get the number of solids inside the navigator More...
GGEMSSolid *	GetSolids (GGsize const &solid_index) const
	get the list of solids More...
GGEMSMaterials *	GetMaterials (void) const
	get the pointer on materials More...
GGEMSCrossSections *	GetCrossSections (void) const
	get the pointer on cross sections More...
void	ParticleSolidDistance (GGsize const &thread_index)
	Compute distance between particle and solid. More...
void	ProjectToSolid (GGsize const &thread_index)
	Project particle to entry of closest solid. More...
void	TrackThroughSolid (GGsize const &thread_index)
	Move particle through solid. More...
void	PrintInfos (void) const
	Print infos about navigator. More...
void	ComputeDose (GGsize const &thread_index)
	Compute dose in volume. More...
void	StoreOutput (std::string basename)
	Storing the basename and format of the output file. More...
void	SetDosimetryCalculator (GGEMSDosimetryCalculator *dosimetry_calculator)
	give adress of dosimetry calculator to navigator More...
void	EnableTracking (void)
	Enable tracking during simulation. More...

Private Member Functions
void	CheckParameters (void) const override

Private Attributes
std::string	voxelized_phantom_filename_
std::string	range_data_filename_

Additional Inherited Members
Protected Attributes inherited from GGEMSNavigator
std::string	navigator_name_
GGfloat3	position_xyz_
GGfloat3	rotation_xyz_
GGsize	navigator_id_
bool	is_update_pos_
bool	is_update_rot_
GGfloat	threshold_
bool	is_tracking_
std::string	output_basename_
GGEMSSolid **	solids_
GGsize	number_of_solids_
GGEMSMaterials *	materials_
GGEMSCrossSections *	cross_sections_
GGEMSDosimetryCalculator *	dose_calculator_
bool	is_dosimetry_mode_
GGsize	number_activated_devices_

Detailed Description

Child GGEMS class handling voxelized phantom.

Definition at line 39 of file GGEMSVoxelizedPhantom.hh.

Constructor & Destructor Documentation

GGEMSVoxelizedPhantom() [1/3]

GGEMSVoxelizedPhantom::GGEMSVoxelizedPhantom ( std::string const &  voxelized_phantom_name )

explicit

GGEMSVoxelizedPhantom constructor.

Parameters

voxelized_phantom_name

- name of the voxelized phantom

Definition at line 40 of file GGEMSVoxelizedPhantom.cc.

~GGEMSVoxelizedPhantom()

GGEMSVoxelizedPhantom::~GGEMSVoxelizedPhantom

(

void

)

GGEMSVoxelizedPhantom destructor.

Definition at line 54 of file GGEMSVoxelizedPhantom.cc.

GGEMSVoxelizedPhantom() [2/3]

GGEMSVoxelizedPhantom::GGEMSVoxelizedPhantom ( GGEMSVoxelizedPhantom const &  voxelized_phantom )

delete

Avoid copy by reference.

Parameters

voxelized_phantom

- reference on the GGEMS voxelized phantom

GGEMSVoxelizedPhantom() [3/3]

GGEMSVoxelizedPhantom::GGEMSVoxelizedPhantom ( GGEMSVoxelizedPhantom const &&  voxelized_phantom )

delete

Avoid copy by rvalue reference.

Parameters

voxelized_phantom

- rvalue reference on the GGEMS voxelized phantom

Member Function Documentation

CheckParameters()

void GGEMSVoxelizedPhantom::CheckParameters ( void  ) const

overrideprivatevirtual

Returns

no returned value

Reimplemented from GGEMSNavigator.

Definition at line 65 of file GGEMSVoxelizedPhantom.cc.

Initialize()

void GGEMSVoxelizedPhantom::Initialize ( void  )

overridevirtual

Initialize the voxelized phantom.

Reimplemented from GGEMSNavigator.

Definition at line 88 of file GGEMSVoxelizedPhantom.cc.

operator=() [1/2]

GGEMSVoxelizedPhantom & GGEMSVoxelizedPhantom::operator= ( GGEMSVoxelizedPhantom const &&  voxelized_phantom )

delete

Avoid copy by rvalue reference.

Parameters

voxelized_phantom

- rvalue reference on the GGEMS voxelized phantom

operator=() [2/2]

GGEMSVoxelizedPhantom & GGEMSVoxelizedPhantom::operator= ( GGEMSVoxelizedPhantom const &  voxelized_phantom )

delete

Avoid assignement by reference.

Parameters

voxelized_phantom

- reference on the GGEMS voxelized phantom

SaveResults()

void GGEMSVoxelizedPhantom::SaveResults ( void  )

overridevirtual

save all results from solid

Implements GGEMSNavigator.

Definition at line 139 of file GGEMSVoxelizedPhantom.cc.

SetPhantomFile()

void GGEMSVoxelizedPhantom::SetPhantomFile	(	std::string const &	voxelized_phantom_filename,
		std::string const &	range_data_filename
	)

set the mhd filename for voxelized phantom and the range data file

Parameters

voxelized_phantom_filename	- MHD filename for voxelized phantom
range_data_filename	- text file with range to material data

Definition at line 153 of file GGEMSVoxelizedPhantom.cc.

Member Data Documentation

range_data_filename_

std::string GGEMSVoxelizedPhantom::range_data_filename_

private

File for label to material matching

Definition at line 110 of file GGEMSVoxelizedPhantom.hh.

voxelized_phantom_filename_

std::string GGEMSVoxelizedPhantom::voxelized_phantom_filename_

private

MHD file storing the voxelized phantom

Definition at line 109 of file GGEMSVoxelizedPhantom.hh.

---

The documentation for this class was generated from the following files:

• GGEMSVoxelizedPhantom.hh
• GGEMSVoxelizedPhantom.cc