GGEMSSphere.hh File Reference

Class GGEMSSphere inheriting from GGEMSVolume handling Sphere solid. More...

#include "GGEMS/geometries/GGEMSVolume.hh"

Include dependency graph for GGEMSSphere.hh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	GGEMSSphere
	Class GGEMSSphere inheriting from GGEMSVolume handling Sphere solid. More...

Functions
GGEMSSphere *	create_sphere (GGfloat const radius, char const *unit="mm")
	Create instance of GGEMSSphere. More...
void	delete_sphere (GGEMSSphere *sphere)
	Delete instance of GGEMSSphere. More...
void	set_position_sphere (GGEMSSphere *sphere, GGfloat const pos_x, GGfloat const pos_y, GGfloat const pos_z, char const *unit="mm")
	Set the position of the sphere. More...
void	set_material_sphere (GGEMSSphere *sphere, char const *material)
	Set the material of the sphere. More...
void	set_label_value_sphere (GGEMSSphere *sphere, GGfloat const label_value)
	Set the label value in sphere. More...
void	initialize_sphere (GGEMSSphere *sphere)
	Initialize the solid and store it in Phantom creator manager. More...
void	draw_sphere (GGEMSSphere *sphere)
	Draw analytical volume in voxelized phantom. More...

Detailed Description

Class GGEMSSphere inheriting from GGEMSVolume handling Sphere solid.

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

Version

1.0

Date

Wednesday November 4, 2020

Definition in file GGEMSSphere.hh.

Function Documentation

create_sphere()

GGEMSSphere * create_sphere	(	GGfloat const	radius,
		char const *	unit = "mm"
	)

Create instance of GGEMSSphere.

Parameters

radius	- Radius of the sphere
unit	- unit of the distance

Returns

the pointer on the singleton

Definition at line 150 of file GGEMSSphere.cc.

delete_sphere()

GGEMSSphere * delete_sphere

(

GGEMSSphere *

sphere

)

Delete instance of GGEMSSphere.

Parameters

sphere

- pointer on the solid sphere

Definition at line 159 of file GGEMSSphere.cc.

draw_sphere()

void draw_sphere

(

GGEMSSphere *

sphere

)

Draw analytical volume in voxelized phantom.

Parameters

sphere

- pointer on the solid sphere

Definition at line 207 of file GGEMSSphere.cc.

initialize_sphere()

void initialize_sphere

(

GGEMSSphere *

sphere

)

Initialize the solid and store it in Phantom creator manager.

Parameters

sphere

- pointer on the solid sphere

Definition at line 198 of file GGEMSSphere.cc.

set_label_value_sphere()

void set_label_value_sphere	(	GGEMSSphere *	sphere,
		GGfloat const	label_value
	)

Set the label value in sphere.

Parameters

sphere	- pointer on the solid sphere
label_value	- label value in sphere

Definition at line 189 of file GGEMSSphere.cc.

set_material_sphere()

void set_material_sphere	(	GGEMSSphere *	sphere,
		char const *	material
	)

Set the material of the sphere.

Parameters

sphere	- pointer on the solid sphere
material	- material of the sphere

Definition at line 180 of file GGEMSSphere.cc.

set_position_sphere()

void set_position_sphere	(	GGEMSSphere *	sphere,
		GGfloat const	pos_x,
		GGfloat const	pos_y,
		GGfloat const	pos_z,
		char const *	unit = "mm"
	)

Set the position of the sphere.

Parameters

sphere	- pointer on the solid sphere
pos_x	- radius of the sphere
pos_y	- radius of the sphere
pos_z	- radius of the sphere
unit	- unit of the distance

Definition at line 171 of file GGEMSSphere.cc.