Last data update: 2014.03.03

R: Generalized Equivalent Uniform Dose (gEUD) Calculation
gEUDR Documentation

Generalized Equivalent Uniform Dose (gEUD) Calculation

Description

This function and its associated methods calculate gEUD value(s) for a given DVH or DVH.list object.

Usage

## S4 method for signature 'DVH,numeric'
gEUD(x, a, dose.units = c("cGy", "Gy"))

## S4 method for signature 'DVH.list,numeric'
gEUD(x, a, dose.units = c("cGy", "Gy"))	

Arguments

x

Can represent either an object of class DVH or DVH.list for which to calculate gEUD value(s).

a

Numeric value specifying tissue-specific parameter, should be negative for target structures (e.g. tumor) and positive for organs at risk. For a=1, the EUD is equivalent to mean dose, while for a=Inf and a=-Inf, the EUD is equivalent to maximum and minimum doses, respectively.

dose.units

Value specifying dose units (must be one of "cGy" or "Gy").

Value

Returns a numeric vector containing the gEUD values (in units of dose.units) for all input objects.

Author(s)

Reid F. Thompson (reid.thompson@gmail.com)

References

Thieke, C., Bortfeld, T., Niemierko, A., and Nill, S. (2003) From physical dose constraints to equivalent uniform dose constraints in inverse radiotherapy planning. Med Phys 30(9), 2332-2339.

See Also

DVH, DVH.list

Examples

data("RadOnc")
gEUD(janedoe, 1) == unlist(janedoe$"Dmean")
gEUD(janedoe, Inf) == unlist(janedoe$"Dmax")
gEUD(janedoe, -Inf) == unlist(janedoe$"Dmin")

Results


R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)

R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.

R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.

Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.

> library(RadOnc)
Loading required package: rgl
Loading required package: geometry
Loading required package: magic
Loading required package: abind
Loading required package: oro.dicom

oro.dicom: Rigorous - DICOM Input / Output (version = 0.5.0)

Loading required package: ptinpoly
Loading required package: misc3d
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/RadOnc/gEUD.Rd_%03d_medium.png", width=480, height=480)
> ### Name: gEUD
> ### Title: Generalized Equivalent Uniform Dose (gEUD) Calculation
> ### Aliases: gEUD gEUD-methods gEUD,ANY,missing-method
> ###   gEUD,DVH.list,numeric-method gEUD,DVH,numeric-method
> ### Keywords: methods manip
> 
> ### ** Examples
> 
> data("RadOnc")
> gEUD(janedoe, 1) == unlist(janedoe$"Dmean")
       LIVER  LEFT_KIDNEY      STOMACH     DUODENUM RIGHT_KIDNEY          CTV 
        TRUE         TRUE         TRUE         TRUE         TRUE         TRUE 
         PTV  SMALL_BOWEL         CORD         BODY 
        TRUE         TRUE         TRUE         TRUE 
> gEUD(janedoe, Inf) == unlist(janedoe$"Dmax")
       LIVER  LEFT_KIDNEY      STOMACH     DUODENUM RIGHT_KIDNEY          CTV 
        TRUE         TRUE         TRUE         TRUE         TRUE         TRUE 
         PTV  SMALL_BOWEL         CORD         BODY 
        TRUE         TRUE         TRUE         TRUE 
> gEUD(janedoe, -Inf) == unlist(janedoe$"Dmin")
       LIVER  LEFT_KIDNEY      STOMACH     DUODENUM RIGHT_KIDNEY          CTV 
        TRUE         TRUE         TRUE         TRUE         TRUE         TRUE 
         PTV  SMALL_BOWEL         CORD         BODY 
        TRUE         TRUE         TRUE         TRUE 
> 
> 
> 
> 
> 
> dev.off()
null device 
          1 
>