Class OptimizationSetup

Inheritance

System.Object

SerializableObject

OptimizationSetup

Inherited Members

SerializableObject.IsLive

SerializableObject.GetSchema()

SerializableObject.ReadXml(Xml.XmlReader)

SerializableObject.WriteXml(Xml.XmlWriter)

SerializableObject.ClearSerializationHistory()

Namespace:ESAPIX.Facade.API

Assembly:cs.temp.dll.dll

Syntax

public class OptimizationSetup : SerializableObject, Xml.Serialization.IXmlSerializable

Constructors

OptimizationSetup()

Declaration

public OptimizationSetup()

OptimizationSetup()

Declaration

public OptimizationSetup()

OptimizationSetup()

Declaration

public OptimizationSetup()

OptimizationSetup()

Declaration

public OptimizationSetup()

OptimizationSetup()

Declaration

public OptimizationSetup()

OptimizationSetup(Object)

Declaration

public OptimizationSetup(dynamic client)

Parameters

Type	Name	Description
System.Object	client

OptimizationSetup(Object)

Declaration

public OptimizationSetup(dynamic client)

Parameters

Type	Name	Description
System.Object	client

OptimizationSetup(Object)

Declaration

public OptimizationSetup(dynamic client)

Parameters

Type	Name	Description
System.Object	client

OptimizationSetup(Object)

Declaration

public OptimizationSetup(dynamic client)

Parameters

Type	Name	Description
System.Object	client

OptimizationSetup(Object)

Declaration

public OptimizationSetup(dynamic client)

Parameters

Type	Name	Description
System.Object	client

Properties

Objectives

Declaration

public IEnumerable<OptimizationObjective> Objectives { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationObjective>

Objectives

Declaration

public IEnumerable<OptimizationObjective> Objectives { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationObjective>

Objectives

Declaration

public IEnumerable<OptimizationObjective> Objectives { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationObjective>

Objectives

Declaration

public IEnumerable<OptimizationObjective> Objectives { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationObjective>

Objectives

Declaration

public IEnumerable<OptimizationObjective> Objectives { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationObjective>

Parameters

Declaration

public IEnumerable<OptimizationParameter> Parameters { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationParameter>

Parameters

Declaration

public IEnumerable<OptimizationParameter> Parameters { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationParameter>

Parameters

Declaration

public IEnumerable<OptimizationParameter> Parameters { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationParameter>

Parameters

Declaration

public IEnumerable<OptimizationParameter> Parameters { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationParameter>

Parameters

Declaration

public IEnumerable<OptimizationParameter> Parameters { get; set; }

Property Value

Type	Description
IEnumerable<OptimizationParameter>

UseJawTracking

Declaration

public bool UseJawTracking { get; set; }

Property Value

Type	Description
System.Boolean

UseJawTracking

Declaration

public bool UseJawTracking { get; set; }

Property Value

Type	Description
System.Boolean

UseJawTracking

Declaration

public bool UseJawTracking { get; set; }

Property Value

Type	Description
System.Boolean

UseJawTracking

Declaration

public bool UseJawTracking { get; set; }

Property Value

Type	Description
System.Boolean

UseJawTracking

Declaration

public bool UseJawTracking { get; set; }

Property Value

Type	Description
System.Boolean

Methods

AddAutomaticNormalTissueObjective(Double)

Declaration

public OptimizationNormalTissueParameter AddAutomaticNormalTissueObjective(double priority)

Parameters

Type	Name	Description
System.Double	priority

Returns

Type	Description
OptimizationNormalTissueParameter

AddAutomaticNormalTissueObjective(Double)

Declaration

public OptimizationNormalTissueParameter AddAutomaticNormalTissueObjective(double priority)

Parameters

Type	Name	Description
System.Double	priority

Returns

Type	Description
OptimizationNormalTissueParameter

AddAutomaticNormalTissueObjective(Double)

Declaration

public OptimizationNormalTissueParameter AddAutomaticNormalTissueObjective(double priority)

Parameters

Type	Name	Description
System.Double	priority

Returns

Type	Description
OptimizationNormalTissueParameter

AddAutomaticNormalTissueObjective(Double)

Declaration

public OptimizationNormalTissueParameter AddAutomaticNormalTissueObjective(double priority)

Parameters

Type	Name	Description
System.Double	priority

Returns

Type	Description
OptimizationNormalTissueParameter

AddAutomaticNormalTissueObjective(Double)

Declaration

public OptimizationNormalTissueParameter AddAutomaticNormalTissueObjective(double priority)

Parameters

Type	Name	Description
System.Double	priority

Returns

Type	Description
OptimizationNormalTissueParameter

AddBeamSpecificParameter(Beam, Double, Double, Boolean)

Declaration

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

Parameters

Type	Name	Description
Beam	beam
System.Double	smoothX
System.Double	smoothY
System.Boolean	fixedJaws

Returns

Type	Description
OptimizationIMRTBeamParameter

AddBeamSpecificParameter(Beam, Double, Double, Boolean)

Declaration

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

Parameters

Type	Name	Description
Beam	beam
System.Double	smoothX
System.Double	smoothY
System.Boolean	fixedJaws

Returns

Type	Description
OptimizationIMRTBeamParameter

AddBeamSpecificParameter(Beam, Double, Double, Boolean)

Declaration

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

Parameters

Type	Name	Description
Beam	beam
System.Double	smoothX
System.Double	smoothY
System.Boolean	fixedJaws

Returns

Type	Description
OptimizationIMRTBeamParameter

AddBeamSpecificParameter(Beam, Double, Double, Boolean)

Declaration

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

Parameters

Type	Name	Description
Beam	beam
System.Double	smoothX
System.Double	smoothY
System.Boolean	fixedJaws

Returns

Type	Description
OptimizationIMRTBeamParameter

AddBeamSpecificParameter(Beam, Double, Double, Boolean)

Declaration

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

Parameters

Type	Name	Description
Beam	beam
System.Double	smoothX
System.Double	smoothY
System.Boolean	fixedJaws

Returns

Type	Description
OptimizationIMRTBeamParameter

AddEUDObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationEUDObjective AddEUDObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double parameterA, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	parameterA
System.Double	priority

Returns

Type	Description
OptimizationEUDObjective

AddEUDObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationEUDObjective AddEUDObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double parameterA, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	parameterA
System.Double	priority

Returns

Type	Description
OptimizationEUDObjective

AddEUDObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationEUDObjective AddEUDObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double parameterA, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	parameterA
System.Double	priority

Returns

Type	Description
OptimizationEUDObjective

AddEUDObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationEUDObjective AddEUDObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double parameterA, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	parameterA
System.Double	priority

Returns

Type	Description
OptimizationEUDObjective

AddEUDObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationEUDObjective AddEUDObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double parameterA, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	parameterA
System.Double	priority

Returns

Type	Description
OptimizationEUDObjective

AddMeanDoseObjective(Structure, Common.Model.Types.DoseValue, Double)

Declaration

public OptimizationMeanDoseObjective AddMeanDoseObjective(Structure structure, Common.Model.Types.DoseValue dose, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	priority

Returns

Type	Description
OptimizationMeanDoseObjective

AddMeanDoseObjective(Structure, Common.Model.Types.DoseValue, Double)

Declaration

public OptimizationMeanDoseObjective AddMeanDoseObjective(Structure structure, Common.Model.Types.DoseValue dose, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	priority

Returns

Type	Description
OptimizationMeanDoseObjective

AddMeanDoseObjective(Structure, Common.Model.Types.DoseValue, Double)

Declaration

public OptimizationMeanDoseObjective AddMeanDoseObjective(Structure structure, Common.Model.Types.DoseValue dose, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	priority

Returns

Type	Description
OptimizationMeanDoseObjective

AddMeanDoseObjective(Structure, Common.Model.Types.DoseValue, Double)

Declaration

public OptimizationMeanDoseObjective AddMeanDoseObjective(Structure structure, Common.Model.Types.DoseValue dose, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	priority

Returns

Type	Description
OptimizationMeanDoseObjective

AddMeanDoseObjective(Structure, Common.Model.Types.DoseValue, Double)

Declaration

public OptimizationMeanDoseObjective AddMeanDoseObjective(Structure structure, Common.Model.Types.DoseValue dose, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	priority

Returns

Type	Description
OptimizationMeanDoseObjective

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

Declaration

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

Parameters

Type	Name	Description
System.Double	priority
System.Double	distanceFromTargetBorderInMM
System.Double	startDosePercentage
System.Double	endDosePercentage
System.Double	fallOff

Returns

Type	Description
OptimizationNormalTissueParameter

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

Declaration

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

Parameters

Type	Name	Description
System.Double	priority
System.Double	distanceFromTargetBorderInMM
System.Double	startDosePercentage
System.Double	endDosePercentage
System.Double	fallOff

Returns

Type	Description
OptimizationNormalTissueParameter

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

Declaration

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

Parameters

Type	Name	Description
System.Double	priority
System.Double	distanceFromTargetBorderInMM
System.Double	startDosePercentage
System.Double	endDosePercentage
System.Double	fallOff

Returns

Type	Description
OptimizationNormalTissueParameter

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

Declaration

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

Parameters

Type	Name	Description
System.Double	priority
System.Double	distanceFromTargetBorderInMM
System.Double	startDosePercentage
System.Double	endDosePercentage
System.Double	fallOff

Returns

Type	Description
OptimizationNormalTissueParameter

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

Declaration

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

Parameters

Type	Name	Description
System.Double	priority
System.Double	distanceFromTargetBorderInMM
System.Double	startDosePercentage
System.Double	endDosePercentage
System.Double	fallOff

Returns

Type	Description
OptimizationNormalTissueParameter

AddPointObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationPointObjective AddPointObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double volume, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	volume
System.Double	priority

Returns

Type	Description
OptimizationPointObjective

AddPointObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationPointObjective AddPointObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double volume, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	volume
System.Double	priority

Returns

Type	Description
OptimizationPointObjective

AddPointObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationPointObjective AddPointObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double volume, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	volume
System.Double	priority

Returns

Type	Description
OptimizationPointObjective

AddPointObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationPointObjective AddPointObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double volume, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	volume
System.Double	priority

Returns

Type	Description
OptimizationPointObjective

AddPointObjective(Structure, Common.Model.Types.OptimizationObjectiveOperator, Common.Model.Types.DoseValue, Double, Double)

Declaration

public OptimizationPointObjective AddPointObjective(Structure structure, Common.Model.Types.OptimizationObjectiveOperator objectiveOperator, Common.Model.Types.DoseValue dose, double volume, double priority)

Parameters

Type	Name	Description
Structure	structure
VMS.TPS.Common.Model.Types.OptimizationObjectiveOperator	objectiveOperator
VMS.TPS.Common.Model.Types.DoseValue	dose
System.Double	volume
System.Double	priority

Returns

Type	Description
OptimizationPointObjective

AddStructurePointCloudParameter(Structure, Double)

Declaration

public OptimizationPointCloudParameter AddStructurePointCloudParameter(Structure structure, double pointResolutionInMM)

Parameters

Type	Name	Description
Structure	structure
System.Double	pointResolutionInMM

Returns

Type	Description
OptimizationPointCloudParameter

AddStructurePointCloudParameter(Structure, Double)

Declaration

public OptimizationPointCloudParameter AddStructurePointCloudParameter(Structure structure, double pointResolutionInMM)

Parameters

Type	Name	Description
Structure	structure
System.Double	pointResolutionInMM

Returns

Type	Description
OptimizationPointCloudParameter

RemoveObjective(OptimizationObjective)

Declaration

public void RemoveObjective(OptimizationObjective objective)

Parameters

Type	Name	Description
OptimizationObjective	objective

RemoveObjective(OptimizationObjective)

Declaration

public void RemoveObjective(OptimizationObjective objective)

Parameters

Type	Name	Description
OptimizationObjective	objective

RemoveObjective(OptimizationObjective)

Declaration

public void RemoveObjective(OptimizationObjective objective)

Parameters

Type	Name	Description
OptimizationObjective	objective

RemoveObjective(OptimizationObjective)

Declaration

public void RemoveObjective(OptimizationObjective objective)

Parameters

Type	Name	Description
OptimizationObjective	objective

RemoveObjective(OptimizationObjective)

Declaration

public void RemoveObjective(OptimizationObjective objective)

Parameters

Type	Name	Description
OptimizationObjective	objective

RemoveParameter(OptimizationParameter)

Declaration

public void RemoveParameter(OptimizationParameter parameter)

Parameters

Type	Name	Description
OptimizationParameter	parameter

RemoveParameter(OptimizationParameter)

Declaration

public void RemoveParameter(OptimizationParameter parameter)

Parameters

Type	Name	Description
OptimizationParameter	parameter

RemoveParameter(OptimizationParameter)

Declaration

public void RemoveParameter(OptimizationParameter parameter)

Parameters

Type	Name	Description
OptimizationParameter	parameter

RemoveParameter(OptimizationParameter)

Declaration

public void RemoveParameter(OptimizationParameter parameter)

Parameters

Type	Name	Description
OptimizationParameter	parameter

RemoveParameter(OptimizationParameter)

Declaration

public void RemoveParameter(OptimizationParameter parameter)

Parameters

Type	Name	Description
OptimizationParameter	parameter