DVH.list-class {RadOnc}

Class "DVH.list"

Description

A data structure containing one or more Dose-Volume Histogram (DVH) objects

Objects from the Class

Objects can be created by calls of the form new("DVH.list", structures, ...).

Slots

structures:

List of DVH objects

Methods

[

Extract subset of DVH list based on pattern matching with structure names (regular expressions may be specified if desired, see regex for more details). Note that case-insensitive matching is supported using the "(?i)" prefix, such that DVHs["(?i)LIVER"] will match any combination of upper and lowercase letters spelling "liver".

[[

Extract single DVH object from DVH list

[[<-

Replace single DVH object in DVH list

[<-

Replace multiple elements of DVH list

$

Extract dose or volume parameter(s) from DVH objects within DVH list. Note that multiple parameters may be specified by use of the comma (e.g. \$"V20Gy,D5%"). See DVH documentation ([] usage) for additional details. Note that this functionality can also be used to extract patient name(s) and/or identifier(s) (e.g. \$patients or $ID).

as.list

Convert a DVH.list object to a list containing individual DVH objects. Note that the reverse conversion can be performed using the as command and specifying class="DVH.list".

c

Combine two or more DVH lists and/or DVH objects

lapply

Apply function to a list of DVH objects

length

Extract number of DVH objects in DVH list

mad

Compute the median absolute deviation (i.e. the median of the absolute deviations from the median) for all doses extracted from DVH object list

max

Compute the maximum dose contained within the DVH list

mean

Compute the mean DVH from all DVH objects within the list

median

Compute the median DVH from all DVH objects within the list

min

Compute the minimum dose contained within the DVH list

names

Extract structure names for DVH objects in DVH list

names<-

Assign structure name(s) to one or more DVH objects in DVH list

print

Display summary of DVH list

range

Compute the range (minimum and maximum doses) contained within the DVH list

rev

Return a DVH list whose DVH objects are in reverse order

sd

Compute the standard deviation for all doses extracted from DVH object list

show

Display summary of DVH list

sum

Compute the total (summed) DVH from all DVH objects within the list. Note that structures are assumed to be non-overlapping; any overlaps in structure volumes may generate inaccurate dose summation.

t.test

Apply Student's t-Test to compare two DVH lists (see also t.test)

var

Compute the variance for all doses extracted from DVH object list

wilcox.test

Apply Wilcoxon Rank Sum and Signed Rank Tests to compare two DVH lists (see also wilcox.test)

Author(s)

Reid F. Thompson ([e-mail])

See Also

DVH

Examples

# Description of structure/slots in class
showClass("DVH.list")
data(list="RadOnc", package="RadOnc")
print(johndoe)
plot(johndoe[c("LIVER", "PTV")], plot.type="i", col=c("red","blue"), lty=1:2, lwd=1:2)