Class ControlPointParameters

An editable copy of the parameters of a control point.

Inheritance

System.Object

ControlPointParameters

IonControlPointParameters

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 ControlPointParameters

Remarks

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

Properties

CollimatorAngle

A copy of the collimator angle at this control point, in degrees, in the range [0, 360[. It is defined as 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

This property cannot be edited directly. Consider if removing and creating a new Beam works for your use case.

GantryAngle

A copy of the gantry angle at this control point, in degrees, in the range [0, 360[. It is defined as 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

This property cannot be edited directly. Consider if removing and creating a new Beam works for your use case.

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

A copy of the jaw positions of the treatment beams at this control point in millimeters, and in IEC BEAM LIMITING DEVICE coordinates.

Declaration

public VRect<double> JawPositions { get; set; }

Property Value

Type	Description
VRect<System.Double>

Remarks

To set the same leaf positions for all control points (as is required if you use a static beam), use the SetJawPositions(VRect<Double>) method in BeamParameters.

LeafPositions

A copy of 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. If no MLC exists, a (0,0)-length array is returned.

Declaration

public float[, ] LeafPositions { get; set; }

Property Value

Type	Description
System.Single[,]

Remarks

To set the same leaf positions for all control points (as is required if you use a static MLC), use the SetAllLeafPositions(Single[,]) method in BeamParameters.

MetersetWeight

A copy of the cumulative meterset weight to this control point.

Declaration

public double MetersetWeight { get; }

Property Value

Type	Description
System.Double

Remarks

This property cannot be edited directly. Consider if removing and creating a new Beam works for your use case.

PatientSupportAngle

A copy of the patient support angle at this control point, in degrees, in the range [0, 360[. It is defined as 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

This property cannot be edited directly. Consider if removing and creating a new Beam works for your use case.

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