structure3D-class: Class '"structure3D"'

In reidt03/RadOnc: Analytical Tools for Radiation Oncology

Class "structure3D"

Description

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

names

Extract structure name from structure3D object

names<-

Assign structure name to a structure3D object

print

Display summary of structure3D object

range

Extract coordinate range from structure3D object

show

Display summary of structure3D object

Author(s)

Reid F. Thompson ([e-mail])

See Also

DVH

Examples

# Description of structure/slots in class
showClass("structure3D")

reidt03/RadOnc documentation built on Sept. 29, 2022, 9:50 a.m.