calculate.DVH: Calculate DVH data for one or more structure(s) using a dose...

Description Usage Arguments Value Author(s) References See Also Examples

Description

Function to calculate DVH data for one or more structure(s) using a dose grid.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## S4 method for signature 'RTdata,missing'
calculate.DVH(x, dose, resolution.xyz=c(0.2,0.2,NA), 
	resolution.dose=0.01, method=NULL, dose.units=NULL)

## S4 method for signature 'RTdata,array'
calculate.DVH(x, dose, resolution.xyz=c(0.2,0.2,NA), 
	resolution.dose=0.01, method=NULL, dose.units=NULL)

## S4 method for signature 'structure3D,array'
calculate.DVH(x, dose, resolution.xyz=c(0.2,0.2,NA), 
	resolution.dose=0.01, method=NULL, dose.units=NULL)

## S4 method for signature 'structure.list,array'
calculate.DVH(x, dose, resolution.xyz=c(0.2,0.2,NA), 
	resolution.dose=0.01, method=NULL, dose.units=NULL)

Arguments

x

One of either a "structure3D" object, a "structure.list", or a "RTdata" object containing one or more structure(s).

dose

Object of class "array" containing dose grid data. This parameter is not required if x contains a "RTdata" object including dose grid information.

resolution.xyz

A numeric list containing three positive values representing x, y, and z resolution to be used for DVH calculation (specified in units of mm). The smaller each value, the longer the overall calculation time (default is c(0.2, 0.2, NA)). z resolution defaults to axial slice thickness when method="ATC".

resolution.dose

A positive numeric value specifying the dose calculation interval (bin width) for DVH calculation (values interpreted in Gy).

method

Character value specifying the DVH calculation algorithm to employ. Must be one of "ATC", "surface", or "axial". See below for further details about the dose calculation algorithms.

dose.units

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

Value

Returns a single calculated "DVH" object or a "DVH.list" object consisting of multiple DVHs where relevant, or otherwise a "zDVH" or "DVH.list" containing multiple zDVHs when method="axial".

Author(s)

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

References

Straube, W., Matthews, J., Bosch, W., and Purdy, J.A. (2005) DVH Analysis: Consequences for Quality Assurance of Multi-Institutional Clinical Trials. Med Phys 32(6):2021.

See Also

DVH, DVH.list, new

Examples

1
2
data("RadOnc")
# zDVHs <- calculate.DVH(janedoe.RTdata, method="axial")

Example output

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
Warning messages:
1: In rgl.init(initValue, onlyNULL) : RGL: unable to open X11 display
2: 'rgl_init' failed, running with rgl.useNULL = TRUE 
3: .onUnload failed in unloadNamespace() for 'rgl', details:
  call: fun(...)
  error: object 'rgl_quit' not found 

RadOnc documentation built on May 2, 2019, 2:45 a.m.