Classes
struct	FileResults
class	Options
	Volume correction initialization helper class. More...
struct	RegVolume
	RegVolumeT sruct with members (ir=RegionNumber, vol=Volume, unc=Unc) More...
struct	Results
	Struct used to collect and output results about a volume correction run. More...
class	VolumeCorrector
	An object for controlling the volume correction routine. More...

Typedefs
typedef pair< int, int >	PhantRegT
	PhantRegT is a pair of the form (PhantomNumber, PhantomRegion) e.g. a pair of (2, 12) would represent region 12 (i.e. the 13th region) of phantom 2 (i.e. the 3rd phantom)
typedef std::map< PhantRegT, EGS_I64 >	HitCounterT
	HitCounterT is used for counting how many random points land in a given phantoms region.

Enumerations
enum	VolCorMode { NO_CORRECTION , ZERO_DOSE , CORRECT_VOLUME }

Functions
bool	isGZip (istream &vfile)
EGS_Float	getShapeVolume (EGS_Input *shape_inp)
	get shape volume from a shape input item
void	readVolumes (istream &vfile, vector< RegVolume > &reg_volumes)
int	loadVolumes (string fname, vector< RegVolume > &reg_volumes)

Typedef Documentation

◆ HitCounterT

typedef std::map<PhantRegT, EGS_I64> ebvolcor::HitCounterT

HitCounterT is used for counting how many random points land in a given phantoms region.

Definition at line 97 of file eb_volcor.h.

◆ PhantRegT

typedef pair<int, int> ebvolcor::PhantRegT

PhantRegT is a pair of the form (PhantomNumber, PhantomRegion) e.g. a pair of (2, 12) would represent region 12 (i.e. the 13th region) of phantom 2 (i.e. the 3rd phantom)

Definition at line 86 of file eb_volcor.h.

Enumeration Type Documentation

◆ VolCorMode

enum ebvolcor::VolCorMode

Enumerator
NO_CORRECTION
ZERO_DOSE
CORRECT_VOLUME

Definition at line 78 of file eb_volcor.h.

Function Documentation

◆ getShapeVolume()

EGS_Float ebvolcor::getShapeVolume ( EGS_Input * shape_inp )

get shape volume from a shape input item

getShapeVolume takes an EGS_Input for a shape and returns the volume of the shape. Currently the volume will be calculated automatically for cylinders, spheres and box shapes. Other shapes must specify a volume using the shape volume input key. For example:

:start shape:
    type = my_new_shape
    input key 1 = 1234
    input key 2= 5678
    shape volume = 123456
:stop shape:

If shape volume is present for a cylinder, sphere or box shape that value will be used and the automatic calculation will be ignored

Definition at line 77 of file eb_volcor.cpp.

◆ isGZip()

bool ebvolcor::isGZip ( istream & vfile )

looks at first two bytes of a stream and checks if they match the file type specifiers for gzip files

Definition at line 54 of file eb_volcor.cpp.

◆ loadVolumes()

int ebvolcor::loadVolumes	(	string	fname,
		vector< RegVolume > &	reg_volumes )

Definition at line 420 of file eb_volcor.cpp.

◆ readVolumes()

void ebvolcor::readVolumes	(	istream &	vfile,
		vector< RegVolume > &	reg_volumes )

Definition at line 408 of file eb_volcor.cpp.

Classes

Typedefs

Enumerations

Functions