Class BeamParameters

An editable copy of the parameters of a treatment beam.

Inheritance

System.Object

BeamParameters

IonBeamParameters

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: VMS.TPS.Common.Model.API

Assembly: VMS.TPS.Common.Model.API.dll

Syntax

public class BeamParameters

Remarks

To apply the parameters, call the ApplyParameters(BeamParameters) method of the Beam class. Because the parameters are simple copies, they do not reflect the current state of the data model.

Properties

ControlPoints

Editable control point parameters copied from the treatment beam.

Declaration

public IEnumerable<ControlPointParameters> ControlPoints { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ControlPointParameters>

GantryDirection

The direction of gantry rotation (clockwise or counterclockwise).

Declaration

public GantryDirection GantryDirection { get; }

Property Value

Type	Description
GantryDirection

Isocenter

A copy of the isocenter position, in millimeters.

Declaration

public VVector Isocenter { get; set; }

Property Value

Type	Description
VVector

WeightFactor

The weight factor of the beam.

Declaration

public double WeightFactor { get; set; }

Property Value

Type	Description
System.Double

Remarks

The total dose distribution of a plan is calculated by adding the individual beam dose distributions. Before doing this, the dose distributions of each beam are multiplied with the respective beam weights, which indicate the relative weight of each beam in a plan. How the weight factors affect the dose distribution is determined by the selected beam normalization method.

Methods

SetAllLeafPositions(Single[,])

Assigns the given leaf positions to each of the control point parameters.

Declaration

public void SetAllLeafPositions(float[, ] leafPositions)

Parameters

Type	Name	Description
System.Single[,]	leafPositions	The positions of the MLC leaf pairs (in millimeters) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type: the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction.

Remarks

To apply the parameters, call the ApplyParameters(BeamParameters) method of the Beam class.

SetJawPositions(VRect<Double>)

Assigns the given jaw positions to each of the control point parameters.

Declaration

public void SetJawPositions(VRect<double> positions)

Parameters

Type	Name	Description
VRect<System.Double>	positions	A rectangle describing the jaw positions in millimeters in IEC BEAM LIMITING DEVICE coordinates.

Remarks

To apply the parameters, call the ApplyParameters(BeamParameters) method of the Beam class.