A data structure containing 3D volumetric (structure3D) data and associated parameters for a single structure object
Objects from the Class
Objects can be created by calls of the form new("structure3D", name, volume, volume.units, coordinate.units, vertices, origin, triangles, DVH).
Slots
name:
Name of the structure (e.g. "Stomach")
volume:
Volume of the structure (in volume.units)
volume.units:
A character string specifying the units of volume (must be "cc")
coordinate.units:
A character string specifying the units of the coordinate system (must be one of "cm" or "mm")
vertices:
Specifies all points defining the given structure, with data contained in a Nx3 matrix where each column represents x, y, and z coordinates, respectively, for each of N points
origin:
A numeric vector containing the x, y, and z coordinates corresponding to the center of the structure
triangles:
Specifies a complete combination of points which define the triangular mesh surface of the structure; data is contained in a 3xN matrix where each row represents one of the three vertices of a each triangle within the mesh, with N columns corresponding to the number of triangles; note that the value of each element in triangles references a point in vertices, such that all values in triangles must be between 1 and dim(vertices)[1]
closed.polys:
Specifies a complete set of axially-defined closed polygons which, together, comprise the surface of the structure; data is contained in a list of Nx3 matrices where each row represents the x, y, and z coordinates of a point in a single polygon
DVH:
Object of class DVH
Methods
$
Extract a given parameter from a structure3D object
$<-
Assign a value to a given parameter within a structure3D object
c
Combine multiple structure3D objects into a single structure.list
dim
Extract dimensions (number of vertices and axial slices) from structure3D object
# Description of structure/slots in class
showClass("structure3D")
# data(list="RadOnc", package="RadOnc")
# plot(mandible)
# points3d(range(mandible), col="red")
Results
R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)
R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.
R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.
Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.
> library(RadOnc)
Loading required package: rgl
Loading required package: geometry
Loading required package: magic
Loading required package: abind
Loading required package: oro.dicom
oro.dicom: Rigorous - DICOM Input / Output (version = 0.5.0)
Loading required package: ptinpoly
Loading required package: misc3d
> png(filename="/home/ddbj/snapshot/RGM3/R_CC/result/RadOnc/structure3D-class.Rd_%03d_medium.png", width=480, height=480)
> ### Name: structure3D-class
> ### Title: Class '"structure3D"'
> ### Aliases: structure3D-class $,structure3D-method $<-,structure3D-method
> ### c,structure3D-method dim,structure3D-method names,structure3D-method
> ### names<-,structure3D-method plot,structure3D,ANY-method
> ### plot,structure3D,missing-method print,structure3D-method
> ### range,structure3D-method show,structure3D-method
> ### Keywords: classes
>
> ### ** Examples
>
> # Description of structure/slots in class
> showClass("structure3D")
Class "structure3D" [package "RadOnc"]
Slots:
Name: name volume volume.units coordinate.units
Class: character numeric character character
Name: vertices origin triangles closed.polys
Class: matrix numeric matrix matrix
Name: DVH
Class: DVH
>
> # data(list="RadOnc", package="RadOnc")
> # plot(mandible)
> # points3d(range(mandible), col="red")
>
>
>
>
>
> dev.off()
null device
1
>
providing 
.