histo.DVH {espadon}

Cumulative Dose Volume Histogram

Description

The histo.DVH function calculates, for each dose, the volume receiving at least this dose.

Usage

histo.DVH(histo, alias = "", description = histo$description)

Arguments

histo

"histo" class object.

alias

Character string, $alias of the created object.

description

Character string, describing the the created object. If the description = NULL (default value), it will be set to histo$description.

Value

Returns a "dvh" class object. This is a list including:

• $patient: set to histo$patient.

• $patient.name: set to histo$patient.name.

• $patient.bd: set to histo$patient.bd.

• $patient.sex: set to histo$patient.sex.

• $file.basename: set to "".

• $file.dirname: set to "".

• $object.name: set to "".

• $object.alias: alias of the dvh object..

• $frame.of.reference: set to histo$frame.of.reference.

• $ref.pseudo : set to histo$ref.pseudo.

• $modality : set to "dvh".

• $description: description of the dvh object. By default, set to histo$description.

• $creation.date: set to Sys.Date.

• $nb.MC: set to histo$nb.MC.

• $breaks: vector breakpoints.

• $mids: vector of cell centers.

• $mids.unit: Character string, representing the unit of the abcissa of the DVH. For instance, "Gy", when vol is a rtdose.

• $vol: cumulative volume receiving at least the doses defined by $mids.

• $pcv: percentage of the total volume receiving at least the doses defined by $mids.

• $MC.vol: cumulative volume associated with histo$MC.dV_dx, if it exists.

• $MC.pcv: percentage of the total volume associated with histo$MC.dV_dx, if it exists.

• $MC.dxyz: set to histo$MC.dxyz, if it exists.

See Also

histo.from.roi, histo.from.bin, histo.vol, display.DVH, display.DVH.pc

Examples

# loading of toy-patient objects (decrease dxyz and increase beam.nb for 
# better result)
step <- 5
patient <- toy.load.patient (modality = c("rtdose", "rtstruct"), 
                             roi.name = "gizzard", dxyz = rep (step, 3), 
                             beam.nb = 3)

# Calculation of the histogram
H <- histo.from.roi (patient$rtdose[[1]], patient$rtstruct[[1]], 
                     roi.name = "gizzard", 
                     breaks = seq (0, 60, by = 1))

# DVH
DVH <- histo.DVH (H)
str (DVH)