GGEMSBox.hh File Reference

Class GGEMSBox inheriting from GGEMSVolume handling Box solid. More...

#include "GGEMS/geometries/GGEMSVolume.hh"

Include dependency graph for GGEMSBox.hh:

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

Go to the source code of this file.

Classes
class	GGEMSBox
	Class GGEMSBox inheriting from GGEMSVolume handling Box solid. More...

Functions
GGEMSBox *	create_box (GGfloat const width, GGfloat const height, GGfloat const depth, char const *unit="mm")
	Create instance of GGEMSBox. More...
void	delete_box (GGEMSBox *box)
	Delete instance of GGEMSBox. More...
void	set_position_box (GGEMSBox *box, GGfloat const pos_x, GGfloat const pos_y, GGfloat const pos_z, char const *unit="mm")
	Set the position of the box. More...
void	set_material_box (GGEMSBox *box, char const *material)
	Set the material of the box. More...
void	set_label_value_box (GGEMSBox *box, GGfloat const label_value)
	Set the label value in box. More...
void	initialize_box (GGEMSBox *box)
	Initialize the solid and store it in Phantom creator manager. More...
void	draw_box (GGEMSBox *box)
	Draw analytical volume in voxelized phantom. More...

Detailed Description

Class GGEMSBox inheriting from GGEMSVolume handling Box 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

Monday August 31, 2020

Definition in file GGEMSBox.hh.

Function Documentation

create_box()

GGEMSBox * create_box	(	GGfloat const	width,
		GGfloat const	height,
		GGfloat const	depth,
		char const *	unit = "mm"
	)

Create instance of GGEMSBox.

Parameters

width	- Width of the box
height	- Height of the box
depth	- Depth of the box
unit	- unit of the distance

Returns

the pointer on the singleton

Definition at line 155 of file GGEMSBox.cc.

delete_box()

GGEMSBox * delete_box

(

GGEMSBox *

box

)

Delete instance of GGEMSBox.

Parameters

box	- pointer on the solid box

Definition at line 164 of file GGEMSBox.cc.

draw_box()

void draw_box

(

GGEMSBox *

box

)

Draw analytical volume in voxelized phantom.

Parameters

box	- pointer on the solid box

Definition at line 212 of file GGEMSBox.cc.

initialize_box()

void initialize_box

(

GGEMSBox *

box

)

Initialize the solid and store it in Phantom creator manager.

Parameters

box	- pointer on the solid box

Definition at line 203 of file GGEMSBox.cc.

set_label_value_box()

void set_label_value_box	(	GGEMSBox *	box,
		GGfloat const	label_value
	)

Set the label value in box.

Parameters

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

Definition at line 194 of file GGEMSBox.cc.

set_material_box()

void set_material_box	(	GGEMSBox *	box,
		char const *	material
	)

Set the material of the box.

Parameters

box	- pointer on the solid box
material	- material of the box

Definition at line 185 of file GGEMSBox.cc.

set_position_box()

void set_position_box	(	GGEMSBox *	box,
		GGfloat const	pos_x,
		GGfloat const	pos_y,
		GGfloat const	pos_z,
		char const *	unit = "mm"
	)

Set the position of the box.

Parameters

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

Definition at line 176 of file GGEMSBox.cc.