Class ControlPoint

Represents a point in a planned sequence of treatment beam parameters. See the definition of control points in a DICOM RT Beam.

Inheritance
System.Object
SerializableObject
ControlPoint
IonControlPoint
Implements
System.Xml.Serialization.IXmlSerializable
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 ControlPoint : SerializableObject, IXmlSerializable
Remarks

Control points are discussed in DICOM PS 3.3 C.8.8.14. All beams have at least two control points. Note that some values may be NaN if they are not applicable to the treatment plan in question.

Properties

Beam

Used for navigating to parent beam

Declaration
public Beam Beam { get; }
Property Value
Type Description
Beam

CollimatorAngle

The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).

Declaration
public double CollimatorAngle { get; }
Property Value
Type Description
System.Double
Remarks

The definition is adapted from DICOM PS 3.3 C.8.8.14 "Beam Limiting Device Angle", but rotation direction is not specified explicitly.

GantryAngle

The gantry angle of the radiation source. In other words, the orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).

Declaration
public double GantryAngle { get; }
Property Value
Type Description
System.Double
Remarks

The definition is from DICOM PS 3.3 C.8.8.14 "Gantry Angle", but rotation direction does not change during treatment and it is specified in Beam.GantryDirection instead.

Index

Control point index starting with zero. Even numbers represent start control points, and odd numbers represent stop control points.

Declaration
public int Index { get; }
Property Value
Type Description
System.Int32

JawPositions

The positions of the beam collimator jaws (in mm) in the IEC BEAM LIMITING DEVICE coordinates.

Declaration
public VRect<double> JawPositions { get; }
Property Value
Type Description
VRect<System.Double>
Remarks

The definition is adapted from DICOM PS 3.3 C.8.8.14 "Leaf/Jaw Positions". The difference is that DICOM likens the collimator jaw positions with MLC leaf positions and places them in the same sequence.

LeafPositions

The positions of the beam collimator leaf pairs (in mm) in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the device type. For example, 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. If there is no MLC, a (0,0)-length array is returned.

Declaration
public float[, ] LeafPositions { get; }
Property Value
Type Description
System.Single[,]
Remarks

The definition is adapted from DICOM PS 3.3 C.8.8.14 "Leaf/Jaw Positions". The difference is that DICOM supports a position sequence for each collimator type while we support a position sequence for a single MLC plus four jaws.

MetersetWeight

The cumulative meterset weight to this control point. The cumulative meterset weight for the first item in a control point sequence is zero.

Declaration
public double MetersetWeight { get; }
Property Value
Type Description
System.Double
Remarks

The meterset at a given control point is equal to the beam meterset, multiplied by the cumulative meterset weight for the control point, divided by the final cumulative meterset weight. The definition is adapted from DICOM PS 3.3 C.8.8.14.

PatientSupportAngle

The patient support angle. In other words, the orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).

Declaration
public double PatientSupportAngle { get; }
Property Value
Type Description
System.Double
Remarks

The definition is from DICOM PS 3.3 C.8.8.14 "Patient Support Angle", but here rotation direction is specified implicitly towards the shortest angle between the current and the next control point.

TableTopLateralPosition

Table top lateral position in millimeters, in the IEC TABLE TOP coordinate system.

Declaration
public double TableTopLateralPosition { get; }
Property Value
Type Description
System.Double

TableTopLongitudinalPosition

Table top longitudinal position in millimeters, in the IEC TABLE TOP coordinate system.

Declaration
public double TableTopLongitudinalPosition { get; }
Property Value
Type Description
System.Double

TableTopVerticalPosition

Table top vertical position in millimeters, in the IEC TABLE TOP coordinate system.

Declaration
public double TableTopVerticalPosition { get; }
Property Value
Type Description
System.Double

Methods

WriteXml(XmlWriter)

Converts an object into its XML representation. For more information on how to serialize an object into an XML document, see System.Xml.Serialization.XmlSerializer.

Declaration
public override void WriteXml(XmlWriter writer)
Parameters
Type Name Description
System.Xml.XmlWriter writer

The System.Xml.XmlWriter stream, to which the object is serialized.
Overrides

Implements

System.Xml.Serialization.IXmlSerializable