Class IonBeam

Proton beam interface.

Inheritance
System.Object
SerializableObject
ApiDataObject
Beam
IonBeam
Implements
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: VMS.TPS.Common.Model.API
Assembly: VMS.TPS.Common.Model.API.dll
Syntax
public class IonBeam : Beam, IXmlSerializable

Properties

AirGap

The user-defined air gap in mm.

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

BeamLineStatus

Determine beamline's status

Declaration
public ProtonBeamLineStatus BeamLineStatus { get; }
Property Value
Type Description
ProtonBeamLineStatus

DistalTargetMargin

Distal end margin, in mm.

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

IonControlPoints

Gets the proton control points.

Declaration
public IonControlPointCollection IonControlPoints { get; }
Property Value
Type Description
IonControlPointCollection

LateralMargins

The lateral margins of this field, in mm.

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

LateralSpreadingDevices

The lateral spreading devices in this beam.

Declaration
public IEnumerable<LateralSpreadingDevice> LateralSpreadingDevices { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<LateralSpreadingDevice>

NominalRange

The nominal range of the beam line, in mm.

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

NominalSOBPWidth

The nominal width of the Spread Out Bragg Peak, in mm.

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

OptionId

The identifier of the selected beam-line setting for proton beams. For a typical double scattering system, for example, an option is a combination of range modulator, second scatterer, and nominal energy that correspond to a broad proton beam with a certain range in patient and field size. Returns null if the option is undefined.

Declaration
public string OptionId { get; }
Property Value
Type Description
System.String

PatientSupportId

Patient support identifier. Returns null if undefined.

Declaration
public string PatientSupportId { get; }
Property Value
Type Description
System.String

PatientSupportType

Patient support type.

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

ProximalTargetMargin

Proximal end margin, in mm.

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

RangeModulators

The range modulator devices in this beam.

Declaration
public IEnumerable<RangeModulator> RangeModulators { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<RangeModulator>

RangeShifters

The range shifter devices in this beam.

Declaration
public IEnumerable<RangeShifter> RangeShifters { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<RangeShifter>

ScanMode

The method of beam scanning to be used during treatment.

Declaration
public IonBeamScanMode ScanMode { get; }
Property Value
Type Description
IonBeamScanMode

SnoutId

The Snout identifier. Returns null if undefined.

Declaration
public string SnoutId { get; }
Property Value
Type Description
System.String

SnoutPosition

The snout position in cm. Returns System::Double::NaN if undefined.

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

TargetStructure

Returns the field target structure. Null if the field target is not defined (and axial margins are defined around the isocenter level).

Declaration
public Structure TargetStructure { get; }
Property Value
Type Description
Structure

VirtualSADX

Virtual Source-to-Axis Distance X, in mm.

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

VirtualSADY

Virtual Source-to-Axis Distance Y, in mm.

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

Methods

ApplyParameters(BeamParameters)

[Availability of this method depends on your Eclipse Scripting API license] Modifies the proton beam by applying the given parameters. This is the only way to modify a beam using the Eclipse Scripting API. After a call to ApplyParameters, the getters of this beam instance will return the new values. An ApplicationException is thrown if the parameters form an invalid combination. DVH Estimations of the plan, if any, are cleared.

Declaration
public void ApplyParameters(BeamParameters beamParams)
Parameters
Type Name Description
BeamParameters beamParams

The parameters to apply to the beam.

GetEditableParameters()

Returns a new editable copy of the ion beam parameters. The returned IonBeamParameters object is not updated if the beam parameters in the data model are changed, for example, by using another IonBeamParameters object.

Declaration
public IonBeamParameters GetEditableParameters()
Returns
Type Description
IonBeamParameters

Returns a new parameters object. Its values are copied from the corresponding properties of this object.

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