phantoms

Pre-defined phantom data sets for testing and demonstration purposes.

Phantom Builder

Utility functions for programmatically constructing phantom geometries.

class matRad_PhantomVOIBox(name, type, boxDimensions, varargin)

Bases: matRad_PhantomVOIVolume

matRad_PhantomVOIBox implements a class that helps to create box VOIs

References

Copyright 2022-2026 the matRad development team.

This file is part of the matRad project. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at https://github.com/e0404/matRad/LICENSE.md. No part of the matRad project, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the LICENSE file.

Property Summary
boxDimensions

additional property of cubic objects

Method Summary
initializeParameters(ct, cst)

add this objective to the phantomBuilders cst

class matRad_PhantomVOIVolume(name, type, p)

Bases: handle

matRad_PhantomVOIVolume: Interface for VOI Volumes

This abstract base class provides the structure of VOI Volumes. So far implemented: Box and spherical objectives

Copyright 2023-2026 the matRad development team.

This file is part of the matRad project. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at https://github.com/e0404/matRad/LICENSE.md. No part of the matRad project, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the LICENSE file.

p is the input parser used in the child classes to check for additional variables

Property Summary
name
type
TissueClass = 1

ignore_style

Type:

mh

alphaX = 0.1000
betaX = 0.0500
Priority = 1

ignore_style

Type:

mh

Visible = 1

ignore_style

Type:

mh

visibleColor = [000]
HU = 0
offset = [0,0,0]

center of objective

coordType = 'voxel'

‘voxel’ or ‘mm’ - governs how dimensions and offset are interpreted

objectives = {}
colors = [[1,0,0];[0,1,0];[0,0,1];[1,1,0];[1,0,1];[0,1,1];[1,1,1]]
Method Summary
initializeParameters(cst)

initialize entry for this VOI in cst

class matRad_PhantomBuilder(ctDim, ctResolution, numOfCtScen)

Bases: handle

matRad_PhantomBuilder Class that helps to create radiotherapy phantoms

Copyright 2023-2026 the matRad development team.

This file is part of the matRad project. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at https://github.com/e0404/matRad/LICENSE.md. No part of the matRad project, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the LICENSE file.

Property Summary
volumes = {}
ct
cst = {}
Method Summary
addBoxTarget(name, dimensions, varargin)

Adds a box target

Input:

  • name – Name of VOI as string

  • dimensions – Dimensions of the box as [x,y,z] array

Name-Value pairs:

‘offset’: The offset of the VOI with respect to the center of the geometry as [x,y,z] array ‘objectives’: Either a single objective or a cell array of objectives ‘HU’: Houndsfield unit of the volume

addSphericalTarget(name, radius, varargin)

Adds a spherical target

Input:

  • name – Name of VOI as string

  • radius – Radius of the sphere

Name-Value pairs:

‘offset’: The offset of the VOI with respect to the center of the geometry as [x,y,z] array ‘objectives’: Either a single objective or a cell array of objectives ‘HU’: Houndsfield unit of the volume

addBoxOAR(name, dimensions, varargin)

Adds a box OAR

Input:

  • name – Name of VOI as string

  • dimensions – Dimensions of the box as [x,y,z] array

Name-Value pairs:

‘offset’: The offset of the VOI with respect to the center of the geometry as [x,y,z] array ‘objectives’: Either a single objective or a cell array of objectives ‘HU’: Houndsfield unit of the volume

addSphericalOAR(name, radius, varargin)

Adds a spherical OAR

Input:

  • name – Name of VOI as string

  • radius – Radius of the sphere

Name-Value pairs:

‘offset’: The offset of the VOI with respect to the center of the geometry as [x,y,z] array ‘objectives’: Either a single objective or a cell array of objectives ‘HU’: Houndsfield unit of the volume

getctcst()
Returns the ct and struct. The function also initializes

the HUs in reverse order of definition

Output:

  • ct – matRad ct struct

  • cst – matRad cst struct

updatecst()
class matRad_PhantomVOISphere(name, type, radius, varargin)

Bases: matRad_PhantomVOIVolume

matRad_PhantomVOISphere implements a class that helps to create spheric VOIs

References

Copyright 2022-2026 the matRad development team.

This file is part of the matRad project. It is subject to the license terms in the LICENSE file found in the top-level directory of this distribution and at https://github.com/e0404/matRad/LICENSE.md. No part of the matRad project, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the LICENSE file.

Property Summary
radius
Method Summary
initializeParameters(ct, cst)

add this VOI to the phantomBuilders cst