vol.gradient: Gradient of a volume

View source: R/vol_gradient.R

vol.gradientR Documentation

Gradient of a volume

Description

The vol.gradient function calculates the 3D gradient of a "volume" class object

Usage

vol.gradient(vol, alias = "", description = NULL)

Arguments

vol

"volume" class object.

alias

Character string, $alias of the created object.

description

Character string, describing the created object. If description = NULL (default value), it will be set to paste (vol$object.alias, "gradient").

Value

Returns a "volume" class object (see espadon.class for class definitions), with the same grid and modality as vol, gradient of vol.

Examples

# loading of toy-patient objects (decrease dxyz and increase beam.nb for 
# better result)
step <- 3
pat <- toy.load.patient(modality = c("ct"), dxyz = rep(step, 3))
CT.gradient <- vol.gradient(pat$ct[[1]])

display.plane(CT.gradient, view.type = "sagi", view.coord = 61, 
              interpolate = FALSE)

espadon documentation built on May 8, 2026, 9:07 a.m.