espadon (version 1.11.3)

histo.vol: Histogram of a volume

Description

The histo.vol function calculates the voxel values histogram of "volume" class object.

Usage

histo.vol(vol, breaks = NULL, alias = "", description = NULL, weight = NULL)

Value

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

• $patient: set to vol$patient.

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

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

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

• $file.basename: set to "".

• $file.dirname: set to "".

• $object.name: set to "".

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

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

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

• $modality : set to "histo".

• $description: description of the histo object.

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

• $nb.MC: set to 0.

• $breaks: vector breakpoints

• $mids: vector of cell centers.

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

• counts: count of voxels whose value is included in the limits defined by $breaks.

• dV_dx: differential histogram, expressed in cm^3ascii by voxel units, at each $mids.

Arguments

vol

"volume" class object.

breaks

Vector giving the breakpoints between histogram cells. If breaks = NULL, the chosen breakpoints are those used by the hist function by default. If breaks are specified, outside values of vol$vol3D.data are not taken into account.

alias

Character string, $alias of the created object.

description

Character string, describing the the created object. If the

weight

espadon object of the volume class, where weight$vol3D.data represents the weight of vol$vol3D.data. description = NULL (default value), it will be set to vol$description.

See Also

histo.from.roi, histo.from.bin, display.histo, display.dV_dx

Examples

# loading of toy-patient objects
step <- 3
patient <- toy.load.patient (modality = "ct", dxyz = rep (step, 3))
CT <- patient$ct[[1]]

# histogram and display
H <- histo.vol (CT, breaks = seq (3, ceiling (CT$max.pixel), 1), 
                alias = "CT_hist")
str (H)