ebvolcor::Results Struct Reference

Struct used to collect and output results about a volume correction run. More...

#include <eb_volcor.h>

Public Member Functions
	Results ()
	Results (Options *opts)
void	outputResults (string extra="")

Public Attributes
int	success
string	status
EGS_Float	time
double	density
double	npoints
EGS_Float	bounds_volume
EGS_Float	other_volume
map< int, vector< int > >	regions_corrected

Detailed Description

Struct used to collect and output results about a volume correction run.

Definition at line 212 of file eb_volcor.h.

Constructor & Destructor Documentation

Results() [1/2]

ebvolcor::Results::Results ( )

inline

Definition at line 224 of file eb_volcor.h.

Results() [2/2]

ebvolcor::Results::Results ( Options * opts )

inline

Definition at line 233 of file eb_volcor.h.

Member Function Documentation

outputResults()

void ebvolcor::Results::outputResults ( string extra = "" )

inline

Definition at line 243 of file eb_volcor.h.

Member Data Documentation

bounds_volume

EGS_Float ebvolcor::Results::bounds_volume

what was the volume of the bounding shape

Definition at line 219 of file eb_volcor.h.

density

double ebvolcor::Results::density

what was the density of points used for the VC

Definition at line 217 of file eb_volcor.h.

npoints

double ebvolcor::Results::npoints

what was the total number of points used for the VC

Definition at line 218 of file eb_volcor.h.

other_volume

EGS_Float ebvolcor::Results::other_volume

what was the estimated volume of the inscribed geometry

Definition at line 220 of file eb_volcor.h.

regions_corrected

map<int, vector<int> > ebvolcor::Results::regions_corrected

Definition at line 222 of file eb_volcor.h.

status

string ebvolcor::Results::status

status of correction

Definition at line 215 of file eb_volcor.h.

success

int ebvolcor::Results::success

did the volume correction succeeed?

Definition at line 214 of file eb_volcor.h.

time

EGS_Float ebvolcor::Results::time

how long (s) did the volume correction take

Definition at line 216 of file eb_volcor.h.

---

The documentation for this struct was generated from the following file:

• /Users/marc/Developer/clrp/EGSnrc-eb/HEN_HOUSE/user_codes/egs_brachy/egs_brachy/eb_volcor.h