EGS Brachy
An egs++ user code for rapid brachytherapy calculations
Loading...
Searching...
No Matches
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ebvolcor::VolumeCorrector Class Reference

An object for controlling the volume correction routine. More...

#include <eb_volcor.h>

Collaboration diagram for ebvolcor::VolumeCorrector:
Collaboration graph
[legend]

Public Member Functions

 VolumeCorrector (EGS_Input *volcor_input, vector< EB_Phantom * > phantoms, EGS_BaseGeometry *base_geom, GeomInfo *geom_info, vector< EGS_AffineTransform * > transforms=vector< EGS_AffineTransform * >())
 
 ~VolumeCorrector ()
 
Results runSourceCorrection (EB_TimingTree &timer)
 
Results runGeneralCorrection (EB_TimingTree &timer)
 
FileResults runFileCorrection (EB_TimingTree &timer)
 

Private Member Functions

void setupOptions ()
 
double correctPhantomVolumesForSources ()
 
double correctGeneralVolumes ()
 
void applyVolumeCorrections (Options *options, HitCounterT hit_counter)
 
map< string, int > loadFileVolumeCorrections ()
 

Private Attributes

EGS_Input * input
 
Optionssource_opts
 
Optionsgen_opts
 
map< string, string > phantom_files
 
vector< EB_Phantom * > phantoms
 
EGS_BaseGeometry * base_geom
 
GeomInfoginfo
 
vector< EGS_AffineTransform * > transforms
 
EGS_AffineTransform * base_transform
 
EGS_AffineTransform * base_transform_inv
 

Detailed Description

An object for controlling the volume correction routine.

See EB_Application::correctVolumes for usage.

Definition at line 311 of file eb_volcor.h.

Constructor & Destructor Documentation

◆ VolumeCorrector()

ebvolcor::VolumeCorrector::VolumeCorrector ( EGS_Input *  volcor_input,
vector< EB_Phantom * >  phantoms,
EGS_BaseGeometry *  base_geom,
GeomInfo geom_info,
vector< EGS_AffineTransform * >  transforms = vector<EGS_AffineTransform *>() 
)
inline

Definition at line 333 of file eb_volcor.h.

◆ ~VolumeCorrector()

ebvolcor::VolumeCorrector::~VolumeCorrector ( )
inline

Definition at line 353 of file eb_volcor.h.

Member Function Documentation

◆ applyVolumeCorrections()

void ebvolcor::VolumeCorrector::applyVolumeCorrections ( Options options,
HitCounterT  hit_counter 
)
private

Definition at line 378 of file eb_volcor.cpp.

◆ correctGeneralVolumes()

double ebvolcor::VolumeCorrector::correctGeneralVolumes ( )
private

Definition at line 295 of file eb_volcor.cpp.

◆ correctPhantomVolumesForSources()

double ebvolcor::VolumeCorrector::correctPhantomVolumesForSources ( )
private

Definition at line 335 of file eb_volcor.cpp.

◆ loadFileVolumeCorrections()

map< string, int > ebvolcor::VolumeCorrector::loadFileVolumeCorrections ( )
private

Definition at line 440 of file eb_volcor.cpp.

◆ runFileCorrection()

FileResults ebvolcor::VolumeCorrector::runFileCorrection ( EB_TimingTree timer)
inline

Definition at line 422 of file eb_volcor.h.

◆ runGeneralCorrection()

Results ebvolcor::VolumeCorrector::runGeneralCorrection ( EB_TimingTree timer)
inline

Definition at line 394 of file eb_volcor.h.

◆ runSourceCorrection()

Results ebvolcor::VolumeCorrector::runSourceCorrection ( EB_TimingTree timer)
inline

Definition at line 366 of file eb_volcor.h.

◆ setupOptions()

void ebvolcor::VolumeCorrector::setupOptions ( )
private

Definition at line 254 of file eb_volcor.cpp.

Member Data Documentation

◆ base_geom

EGS_BaseGeometry* ebvolcor::VolumeCorrector::base_geom
private

Definition at line 318 of file eb_volcor.h.

◆ base_transform

EGS_AffineTransform* ebvolcor::VolumeCorrector::base_transform
private

Definition at line 322 of file eb_volcor.h.

◆ base_transform_inv

EGS_AffineTransform* ebvolcor::VolumeCorrector::base_transform_inv
private

Definition at line 323 of file eb_volcor.h.

◆ gen_opts

Options* ebvolcor::VolumeCorrector::gen_opts
private

Definition at line 315 of file eb_volcor.h.

◆ ginfo

GeomInfo* ebvolcor::VolumeCorrector::ginfo
private

Definition at line 320 of file eb_volcor.h.

◆ input

EGS_Input* ebvolcor::VolumeCorrector::input
private

Definition at line 313 of file eb_volcor.h.

◆ phantom_files

map<string, string> ebvolcor::VolumeCorrector::phantom_files
private

Definition at line 316 of file eb_volcor.h.

◆ phantoms

vector<EB_Phantom *> ebvolcor::VolumeCorrector::phantoms
private

Definition at line 317 of file eb_volcor.h.

◆ source_opts

Options* ebvolcor::VolumeCorrector::source_opts
private

Definition at line 314 of file eb_volcor.h.

◆ transforms

vector<EGS_AffineTransform *> ebvolcor::VolumeCorrector::transforms
private

Definition at line 321 of file eb_volcor.h.


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