Class OptimizationSetup

Gives access to the optimization parameters and objectives.

Inheritance

System.Object

SerializableObject

OptimizationSetup

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

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 OptimizationSetup : SerializableObject, IXmlSerializable

Properties

Objectives

A collection of optimization objectives.

Declaration

public IEnumerable<OptimizationObjective> Objectives { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<OptimizationObjective>

Parameters

A collection of optimization parameters.

Declaration

public IEnumerable<OptimizationParameter> Parameters { get; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<OptimizationParameter>

UseJawTracking

[Availability of this property depends on your Eclipse Scripting API license] Jaw tracking parameter for VMAT optimization. The parameter can only be set for plans to be delivered with a treatment machine that supports jaw tracking.

Declaration

public bool UseJawTracking { get; set; }

Property Value

Type	Description
System.Boolean

Methods

AddAutomaticNormalTissueObjective(Double)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new automatic normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added.

Declaration

public OptimizationNormalTissueParameter AddAutomaticNormalTissueObjective(double priority)

Parameters

Type	Name	Description
System.Double	priority	Determines the relative importance of the NTO in relation to other optimization objectives.The value is positive.

Returns

Type	Description
OptimizationNormalTissueParameter	The added parameter.

AddBeamSpecificParameter(Beam, Double, Double, Boolean)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new beam-specific parameter for IMRT optimization.

Declaration

public OptimizationIMRTBeamParameter AddBeamSpecificParameter(Beam beam, double smoothX, double smoothY, bool fixedJaws)

Parameters

Type	Name	Description
Beam	beam	The beam for which the parameters are added.
System.Double	smoothX	A fluence-smoothing parameter in X-direction.
System.Double	smoothY	A fluence-smoothing parameter in Y-direction.
System.Boolean	fixedJaws	If true, the collimator jaw positions of the beam remain the same during the optimization.

Returns

Type	Description
OptimizationIMRTBeamParameter	The added parameter.

AddEUDObjective(Structure, OptimizationObjectiveOperator, DoseValue, Double, Double)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new gEUD objective.

Declaration

public OptimizationEUDObjective AddEUDObjective(Structure structure, OptimizationObjectiveOperator objectiveOperator, DoseValue dose, double parameterA, double priority)

Parameters

Type	Name	Description
Structure	structure	The target structure of the objective.
OptimizationObjectiveOperator	objectiveOperator	The type of the gEUD objective.
DoseValue	dose	The dose value of the objective. The unit must be the same as defined in the system configuration.
System.Double	parameterA	gEUD parameter a.
System.Double	priority	The priority of the objective.

Returns

Type	Description
OptimizationEUDObjective	The added objective.

AddMeanDoseObjective(Structure, DoseValue, Double)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new mean dose objective.

Declaration

public OptimizationMeanDoseObjective AddMeanDoseObjective(Structure structure, DoseValue dose, double priority)

Parameters

Type	Name	Description
Structure	structure	The target structure of the objective.
DoseValue	dose	The dose value of the objective. The unit must be the same as defined in the system configuration.
System.Double	priority	The priority of the objective.

Returns

Type	Description
OptimizationMeanDoseObjective	The added objective.

AddNormalTissueObjective(Double, Double, Double, Double, Double)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously.

Declaration

public OptimizationNormalTissueParameter AddNormalTissueObjective(double priority, double distanceFromTargetBorderInMM, double startDosePercentage, double endDosePercentage, double fallOff)

Parameters

Type	Name	Description
System.Double	priority	Determines the relative importance of the normal tissue objective in relation to other optimization objectives.The value is positive.
System.Double	distanceFromTargetBorderInMM	Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins.
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.
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.
System.Double	fallOff	Determines the steepness of the normal tissue objective fall-off. The value is positive.

Returns

Type	Description
OptimizationNormalTissueParameter	The added parameter.

AddPointObjective(Structure, OptimizationObjectiveOperator, DoseValue, Double, Double)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new point objective.

Declaration

public OptimizationPointObjective AddPointObjective(Structure structure, OptimizationObjectiveOperator objectiveOperator, DoseValue dose, double volume, double priority)

Parameters

Type	Name	Description
Structure	structure	The target structure of the objective.
OptimizationObjectiveOperator	objectiveOperator	The type of the dose-volume objective.
DoseValue	dose	The dose value of the objective. The unit must be the same as defined in the system configuration.
System.Double	volume	The volume of the objective.
System.Double	priority	The priority of the objective.

Returns

Type	Description
OptimizationPointObjective	The added objective.

AddProtonNormalTissueObjective(Double, Double, Double, Double)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new normal tissue objective (NTO) for a proton plan or updates the data of the existing objective. Only one NTO can be added. Calling this function disables the automatic NTO if it has been set previously.

Declaration

public OptimizationNormalTissueParameter AddProtonNormalTissueObjective(double priority, double distanceFromTargetBorderInMM, double startDosePercentage, double endDosePercentage)

Parameters

Type	Name	Description
System.Double	priority	Determines the relative importance of the normal tissue objective in relation to other optimization objectives.The value is positive.
System.Double	distanceFromTargetBorderInMM	Determines the distance in millimeters from the target border where the evaluation of the normal tissue objective dose begins.
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.
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.

Returns

Type	Description
OptimizationNormalTissueParameter	The added parameter.

RemoveObjective(OptimizationObjective)

[Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization objective.

Declaration

public void RemoveObjective(OptimizationObjective objective)

Parameters

Type	Name	Description
OptimizationObjective	objective	The objective that is removed.

RemoveParameter(OptimizationParameter)

[Availability of this method depends on your Eclipse Scripting API license] Removes the specified optimization parameter.

Declaration

public void RemoveParameter(OptimizationParameter parameter)

Parameters

Type	Name	Description
OptimizationParameter	parameter	The parameter that is removed.

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

SerializableObject.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable