Class OptimizationNormalTissueParameter

An optimization parameter for the normal tissue objective.

Inheritance
System.Object
SerializableObject
OptimizationParameter
OptimizationNormalTissueParameter
Implements
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.ToString()
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 OptimizationNormalTissueParameter : OptimizationParameter, IXmlSerializable

Properties

DistanceFromTargetBorderInMM

Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins.

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

EndDosePercentage

Determines the relative dose level in the normal tissue objective in the area furthest from the target border. Expressed in percentage. The value is positive. 100% is specified as 100.

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

FallOff

Determines the steepness of the normal tissue objective fall-off. The value is positive.

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

IsAutomatic

Returns True if an automatic normal tissue objective (NTO) is used. The automatic NTO adapts to the patient anatomy and the optimization objectives, and automatically determines the dose fall-off criteria.

When an automatic NTO is used, the other properties of this object, except Priority, are not used.

Declaration
public bool IsAutomatic { get; }
Property Value
Type Description
System.Boolean

Priority

Determines the relative importance of the normal tissue objective in relation to other optimization objectives. The value is positive.

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

StartDosePercentage

Determines the relative dose level in the normal tissue objective at the target border, expressed in percentage of the upper objective for the target. The value is positive. 100% is specified as 100.

Declaration
public double StartDosePercentage { 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