ebvolcor::Options Class Reference

Volume correction initialization helper class. More...

#include <eb_volcor.h>

Public Member Functions
	Options (EGS_Input *inp)
	~Options ()
EGS_Vector	getRandomPoint ()

Public Attributes
bool	valid
EGS_Float	bounds_volume
EGS_Float	density
EGS_Float	npoints
VolCorMode	mode
EGS_Float	covered_threshold

Private Member Functions
void	setMode ()
	read mode from input
int	setBoundsShape ()
	create bounding shape from the shape input and calculate its volume
void	setDensity ()
void	setRNG ()
void	setCoveredThreshold ()

Private Attributes
EGS_Input *	input
EGS_BaseShape *	bounds
bool	sobolAllowed
EGS_RandomGenerator *	rng

Static Private Attributes
static const unsigned long	DEFAULT_RAND_POINT_DENSITY = 100000000

Detailed Description

Volume correction initialization helper class.

Options is a small helper class for parsing a volume correction input item A sample input including both a source sspecific correction and a general purpose correction would look like this:

 :start volume correction:


     :start source volume correction:
         correction type = correct # correct, none, zero dose
         density of random points (cm^-3) = 1E8

         :start shape:

             type = sphere
             radius = 0.11
             midpoint = 0 0 0

         :stop shape:

     :stop source volume correction:

     :start extra volume correction:

         correction type = correct # correct, none, zero dose
         density of random points (cm^-3) = 1E5

         :start shape:

             type = box
             box size = 8
             midpoint = 0 0 0

         :stop shape:

     :stop extra volume correction:

 :stop volume correction:

An EGS_RNG input can also optionally be included in either of the volume correction inputs to use something other than the EGSnrc default RNG.

Definition at line 145 of file eb_volcor.h.

Constructor & Destructor Documentation

Options()

ebvolcor::Options::Options ( EGS_Input *  inp )

inline

Definition at line 165 of file eb_volcor.h.

~Options()

ebvolcor::Options::~Options ( )

inline

Definition at line 190 of file eb_volcor.h.

Member Function Documentation

getRandomPoint()

EGS_Vector ebvolcor::Options::getRandomPoint

(

)

Definition at line 250 of file eb_volcor.cpp.

setBoundsShape()

int ebvolcor::Options::setBoundsShape ( )

private

create bounding shape from the shape input and calculate its volume

Definition at line 162 of file eb_volcor.cpp.

setCoveredThreshold()

void ebvolcor::Options::setCoveredThreshold ( )

private

set user requested percent threshold at which point voxel is considered totally covered (default 99.99)

Definition at line 236 of file eb_volcor.cpp.

setDensity()

void ebvolcor::Options::setDensity ( )

private

set user requested density or default to DEFAULT_RAND_POINT_DENSITY

Definition at line 192 of file eb_volcor.cpp.

setMode()

void ebvolcor::Options::setMode ( )

private

read mode from input

Definition at line 149 of file eb_volcor.cpp.

setRNG()

void ebvolcor::Options::setRNG ( )

private

set user requested RNG or default to EGS_RandomGenerator::defaultRNG

Definition at line 204 of file eb_volcor.cpp.

Member Data Documentation

bounds

EGS_BaseShape* ebvolcor::Options::bounds

private

Definition at line 152 of file eb_volcor.h.

bounds_volume

EGS_Float ebvolcor::Options::bounds_volume

Definition at line 201 of file eb_volcor.h.

covered_threshold

EGS_Float ebvolcor::Options::covered_threshold

Definition at line 205 of file eb_volcor.h.

DEFAULT_RAND_POINT_DENSITY

const unsigned long ebvolcor::Options::DEFAULT_RAND_POINT_DENSITY = 100000000

staticprivate

Definition at line 147 of file eb_volcor.h.

density

EGS_Float ebvolcor::Options::density

Definition at line 202 of file eb_volcor.h.

input

EGS_Input* ebvolcor::Options::input

private

Definition at line 149 of file eb_volcor.h.

mode

VolCorMode ebvolcor::Options::mode

Definition at line 204 of file eb_volcor.h.

npoints

EGS_Float ebvolcor::Options::npoints

Definition at line 203 of file eb_volcor.h.

rng

EGS_RandomGenerator* ebvolcor::Options::rng

private

Definition at line 156 of file eb_volcor.h.

sobolAllowed

bool ebvolcor::Options::sobolAllowed

private

Definition at line 153 of file eb_volcor.h.

valid

bool ebvolcor::Options::valid

Definition at line 199 of file eb_volcor.h.

---

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

• /Users/marc/Developer/EGSnrc/HEN_HOUSE/user_codes/egs_brachy/egs_brachy/eb_volcor.h
• /Users/marc/Developer/EGSnrc/HEN_HOUSE/user_codes/egs_brachy/egs_brachy/eb_volcor.cpp