dvh.evaluate: Evaluate DVH

View source: R/dvh-functions.R

dvh.evaluateR Documentation

Evaluate DVH

Description

Evaluate the DVH for a single VOI and a specified variable.

Usage

dvh.evaluate(values = NULL, vois = NULL, voi = NULL,
  variable = NULL, with.na = FALSE, with.0 = FALSE, name = NULL)

Arguments

values

the values object

vois

the vois object

voi

the VOI name

variable

the name of the variable (optional if values contains only one variable)

with.na

leave explicitly NA values in DVH representing voxels were the specified variable is not defined (optional, boolean)

name

Overwrite the default name derived from the voi name.

with0

put explicitly in the DVH a point at (0, max(volume)). It is possible to specify directly the min value to use for this DVH point, in this case if with.0 is a number !=0, the point will be at (with.0, max(volume)) (optional)

Value

The dvh object; a list consisting of:

value

vector containing the value data

valume

vector containing the volume fractions

volume.tot

total volume of the VOI in mm^3

voi

the name of the VOI

Nvoxel

the number of voxels of the VOI

See Also

Other DVH: dvh.evaluate.all, dvh.evaluate.bands


planit-group/Rplanit documentation built on Dec. 5, 2022, 11:10 p.m.