get.profiles: Get profiles

In planit-group/Rplanit: Radiotherapy with ion beams - planning, simulations and analysis

Get profiles

Description

Get multiple profiles (values along a specific axis, or voxel line) from a values object. The axis is specifed trough the definition of two of the following three coordinates: x, y, z, or with a single ray object for arbitrary directions.

Usage

get.profiles(values, variables = NULL, ...)

Arguments

values	the values object
variables	the variables to be profiled. If it is not specified, al the available variables in values will be used.
x, y, z	definition of the axis (only two coordinates should be defined). For example x=4.4 and z=0.5 specifies a profile along the y-axis passing through x=4.4 and z=0.5
integrate	perform an integration over the two coordinates (boolean, optional). Note: integration is not yet implemented around an arbitrary ray.
ray	The ray object, Note the ray is a data.frame defined by 6 components (X, Y, Z, xn, yn, zn), i.e. point coordinates + normalized vector direction.
return.voxel.index	Returns also the index of the voxel crossed by the ray (used only for a ray profile).
return.xyz	Returns also the x,y,z of the points along the ray (used only for a ray profile).

Value

a dataframe containing the specified profile.

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