steering

Contains classes to create “steering information” objects that are used to define the geometry of the treatment plan, such as gantry angles, couch angles, and other parameters that influence the treatment delivery.

Used within the top-level API function matRad_generateStf() to create an stf struct.

class matRad_StfGeneratorBrachy(pln)

Bases: matRad_StfGeneratorBase

Property Summary

name = 'Basic Brachytherapy Template'

shortName = 'SimpleBrachy'

possibleRadiationModes = {'brachy'}

needle

template

bixelWidth

Method Summary

setDefaults(this)

createCheckerboard(this, numRows, numCols): Initialize checkerboard matrix

static isAvailable(pln, machine): see superclass for information

class matRad_StfGeneratorPhotonIMRT(pln)

Bases: matRad_StfGeneratorPhotonRayBixelAbstract

Property Summary

name = 'Photon IMRT stf Generator'

shortName = 'PhotonIMRT'

possibleRadiationModes = {'photons'}

Method Summary

static isAvailable(pln, machine): see superclass for information

class matRad_StfGeneratorParticleRayBixelAbstract(pln)

Bases: matRad_StfGeneratorExternalRayBixelAbstract

matRad_StfGeneratorParticleRayBixelAbstract: Abstract Superclass for Particle Stf Generators using the ray-bixel mechanism

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.

Constructs ExternalStfGenerator with or without pln

Property Summary

useRangeShifter = false

rangeShifterEqD

Method Summary

setDefaults(this): Set default values for ExternalStfGenerator

static isAvailable(pln, machine): see superclass for information

class matRad_StfGeneratorParticleIMPT(pln)

Bases: matRad_StfGeneratorParticleRayBixelAbstract

matRad_StfGeneratorParticleIMPT: IMPT Steering Geometry Setup (stf): Creates the stf data structure containing the steering information / field geometry for standard IMPT plans on a regular lateral spot grid with modulation in depth through energy layers

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

name = 'Particle IMPT stf Generator'

shortName = 'ParticleIMPT'

possibleRadiationModes = {'protons','helium','carbon'}

airOffsetCorrection = true

longitudinalSpotSpacing

Method Summary

static isAvailable(pln, machine): see superclass for information

class matRad_StfGeneratorBase(pln)

Bases: handle

matRad_StfGeneratorBase: Abstract Superclass for Steering information: generators. Steering information is used to guide the dose calculation

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.

Constructs standalone StfGenerator with or without pln

Property Summary

isStfGenerator = true: const boolean for inheritance quick check

name: Descriptive Name

shortName: Short name for referencing

possibleRadiationModes: Possible radiation modes for the respective StfGenerator

visMode = 0: Visualization Options

addMargin = true: Add margins to target (for numerical stability and robustness)

multScen: Scenario Model

bioModel: Biological Model

radiationMode: Radiation Mode

machine: Machine

enableGPU = false: Enable computation on the GPU (experimenta, default false)

Method Summary

setDefaults(this): set default values from MatRad_Config

warnDeprecatedProperty(this, oldProp, msg, newProp)

assignPropertiesFromPln(this, pln, warnWhenPropertyChanged): Assign properties from pln.propStf to the stf generator

generate(this, ct, cst): Generate steering information for the given ct and cst This is a base class function performing the following tasks 1. Checking the input 2. Initializing the patient geometry (protected properties) 3. Generating the source information (and thus the “stf”)

static getGeneratorFromPln(pln, warnDefault): GETENGINE Summary of this function goes here Detailed explanation goes here

static getAvailableGenerators(pln, optionalPaths)

Returns a list of names and coresponding handle for stf generators. Returns all stf generators when no arg is given. If no generators are found return gonna be empty.

call

classList = matRad_StfGeneratorBase.getAvailableGenerators(pln,optional_path)

Input:

pln – containing proposed generator and machine file informations
optionalPath – cell array of other folders to search in

Returns:

struct array containing name, shortName, className, and handle for construction of the Generator

Return type:

classList

static isAvailable(pln, machine)

return a boolean if the generator is is available for the given pln struct. Needs to be implemented in non abstract subclasses

Input:

pln – matRad pln struct
machine – optional machine to avoid loading the machine from disk (makes sense to use if machine already loaded)

Output:

available – boolean value to check if the dose engine is available for the given pln/machine
msg – msg to elaborate on availability. If not available, a msg string indicates an error during the check if available, indicates a warning that not all information was present in the machine file and approximations need to be made

static loadMachine(radiationMode, machineName)

class matRad_StfGeneratorParticleVHEE(pln)

Bases: matRad_StfGeneratorParticleRayBixelAbstract

matRad_StfGeneratorParticleVHEE: VHEE Steering Geometry Setup (stf): Creates the stf data structure containing the steering information / field geometry for VHEE plans on a regular lateral spot grid by using a single, manually defined energy setting.

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

name = 'VHEE Geometry Generator'

shortName = 'VHEE'

possibleRadiationModes = {'VHEE'}

energy

Method Summary

static isAvailable(pln, machine): see superclass for information

class matRad_StfGeneratorParticleSingleBeamlet(pln)

Bases: matRad_StfGeneratorParticleRayBixelAbstract

matRad_StfGeneratorPhotonSingleBeamlet:: Creates a single beamlet for particles

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

energy

raShiThickness = 50: Range shifter to be used if useRangeShifter = true;

visualize = false

name = 'Particle Single Spot'

shortName = 'ParticleSingleSpot'

possibleRadiationModes = {'protons','helium','carbon','VHEE'}

Method Summary

static isAvailable(pln, machine): see superclass for information

class matRad_StfGeneratorPhotonSingleBeamlet(pln)

Bases: matRad_StfGeneratorPhotonRayBixelAbstract

matRad_StfGeneratorPhotonSingleBeamlet:: Creates a single beamlet for photons

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

name = 'Photon Single Bixel'

shortName = 'PhotonSingleBixel'

possibleRadiationModes = {'photons'}

Method Summary

static isAvailable(pln, machine): see superclass for information

class matRad_StfGeneratorExternalRayBixelAbstract(pln)

Bases: matRad_StfGeneratorBase

matRad_StfGeneratorPhotonRayBixelAbstract: Abstract Superclass for: external beam stf generators using the ray-bixel mechanism

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.

Constructs ExternalStfGenerator with or without pln

Property Summary

gantryAngles = 0

couchAngles = 0

bixelWidth = 0

isoCenter

fillEmptyBixels

centered

numOfBeams

Method Summary

setDefaults(this): Set default values for ExternalStfGenerator

static isAvailable(pln, machine): see superclass for information

class matRad_StfGeneratorPhotonRayBixelAbstract(pln)

Bases: matRad_StfGeneratorExternalRayBixelAbstract

matRad_StfGeneratorPhotonRayBixelAbstract: Abstract Superclass for Photon: Stf Generators using the ray-bixel mechanism

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.

Constructs ExternalStfGenerator with or without pln

Method Summary

setDefaults(this): Set default values for ExternalStfGenerator

static isAvailable(pln, machine): see superclass for information