Class PlanUncertainty

Provides access to Plan Uncertainty parameters. For more information, see Eclipse Photon and Electron Instructions for Use.

Inheritance
System.Object
SerializableObject
ApiDataObject
PlanUncertainty
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 PlanUncertainty : ApiDataObject

Properties

BeamUncertainties

Collection of beam uncertainty doses.

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

CalibrationCurveError

The calibration curve error of the plan uncertainty in percentage. Returns 100 for 100%. NaN if not defined.

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

DisplayName

The display name of the plan variation, including the parameter values.

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

Dose

The dose of this plan variation.

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

IsocenterShift

The isocenter shift of the plan uncertainty.

Declaration
public VVector IsocenterShift { get; }
Property Value
Type Description
VVector

UncertaintyType

Type of uncertainty, which determines how and in what context the defined parameters are to be used.

Declaration
public PlanUncertaintyType UncertaintyType { get; }
Property Value
Type Description
PlanUncertaintyType

Methods

GetDVHCumulativeData(Structure, DoseValuePresentation, VolumePresentation, Double)

Returns cumulative Dose Volume Histogram (DVH) data for this uncertainty plan.

Declaration
public DVHData GetDVHCumulativeData(Structure structure, DoseValuePresentation dosePresentation, VolumePresentation volumePresentation, double binWidth)
Parameters
Type Name Description
Structure structure

Structure, for which the DVH data is requested.
DoseValuePresentation dosePresentation

Requested dose presentation mode (absolute or relative). Note that only absolute dose is supported for PlanSums.
VolumePresentation volumePresentation

Requested volume presentation mode.
System.Double binWidth

Requested width of the bin.
Returns
Type Description
DVHData

DVHData object that contains the requested DVH information or null if DVH could not be calculated.

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