Class ExternalPlanSetup

Represents an external beam plan. For more information, see the definition of the DICOM RT Plan.

Inheritance

System.Object

ExternalPlanSetup

Implements

System.Xml.Serialization.IXmlSerializable

IDVHEstimationCalculator

Inherited Members

PlanSetup.GetProtocolPrescriptionsAndMeasures(List<ProtocolPhasePrescription>, List<ProtocolPhaseMeasure>)

PlanSetup.AddReferencePoint(Boolean, Nullable<VVector>, String)

PlanSetup.IsValidForPlanApproval(List<PlanValidationResultEsapiDetail>)

PlanSetup.AddPlanUncertaintyWithParameters(PlanUncertaintyType, Boolean, Double, VVector)

PlanSetup.ClearCalculationModel(CalculationType)

PlanSetup.GetCalculationModel(CalculationType)

PlanSetup.GetCalculationOption(String, String, String)

PlanSetup.GetCalculationOptions(String)

PlanSetup.GetDvhEstimationModelName()

PlanSetup.SetCalculationModel(CalculationType, String)

PlanSetup.SetCalculationOption(String, String, String)

PlanSetup.SetPrescription(Int32, DoseValue, Double)

PlanSetup.SetTargetStructureIfNoDose(Structure, StringBuilder)

PlanSetup.Id

PlanSetup.Name

PlanSetup.Comment

PlanSetup.PlanNormalizationValue

PlanSetup.PlanUncertainties

PlanSetup.PlanObjectiveStructures

PlanSetup.ApprovalHistory

PlanSetup.DosePerFractionInPrimaryRefPoint

PlanSetup.PrescribedDosePerFraction

PlanSetup.PrescribedPercentage

PlanSetup.TotalPrescribedDose

PlanSetup.ApplicationScriptLogs

PlanSetup.ApprovalStatus

PlanSetup.BaseDosePlanningItem

PlanSetup.Beams

PlanSetup.CreationUserName

PlanSetup.DosePerFraction

PlanSetup.DVHEstimates

PlanSetup.ElectronCalculationModel

PlanSetup.ElectronCalculationOptions

PlanSetup.IntegrityHash

PlanSetup.IsDoseValid

PlanSetup.IsTreated

PlanSetup.NumberOfFractions

PlanSetup.OptimizationSetup

PlanSetup.PatientSupportDevice

PlanSetup.PhotonCalculationModel

PlanSetup.PhotonCalculationOptions

PlanSetup.PlanIntent

PlanSetup.PlannedDosePerFraction

PlanSetup.PlanningApprovalDate

PlanSetup.PlanningApprover

PlanSetup.PlanningApproverDisplayName

PlanSetup.PlanNormalizationMethod

PlanSetup.PlanNormalizationPoint

PlanSetup.PlanType

PlanSetup.PredecessorPlan

PlanSetup.PredecessorPlanUID

PlanSetup.PrimaryReferencePoint

PlanSetup.ProtocolID

PlanSetup.ProtocolPhaseID

PlanSetup.ProtonCalculationModel

PlanSetup.ProtonCalculationOptions

PlanSetup.ReferencePoints

PlanSetup.RTPrescription

PlanSetup.Series

PlanSetup.SeriesUID

PlanSetup.TargetVolumeID

PlanSetup.TotalDose

PlanSetup.TreatmentApprovalDate

PlanSetup.TreatmentApprover

PlanSetup.TreatmentApproverDisplayName

PlanSetup.TreatmentOrientation

PlanSetup.TreatmentPercentage

PlanSetup.TreatmentSessions

PlanSetup.UID

PlanSetup.UseGating

PlanSetup.VerifiedPlan

PlanningItem.GetClinicalGoals()

PlanningItem.GetDVHCumulativeData(Structure, DoseValuePresentation, VolumePresentation, Double)

PlanningItem.GetDoseAtVolume(Structure, Double, VolumePresentation, DoseValuePresentation)

PlanningItem.GetVolumeAtDose(Structure, DoseValue, VolumePresentation)

PlanningItem.Course

PlanningItem.CreationDateTime

PlanningItem.Dose

PlanningItem.DoseValuePresentation

PlanningItem.StructureSet

PlanningItem.StructuresSelectedForDvh

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

ApiDataObject.HistoryUserName

ApiDataObject.HistoryUserDisplayName

ApiDataObject.HistoryDateTime

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

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 ExternalPlanSetup : PlanSetup, IXmlSerializable, IDVHEstimationCalculator

Properties

DoseAsEvaluationDose

The evaluation dose is connected to the plan and contains voxels that are set by SetVoxels(Int32, Int32[,]) instead of the dose calculation algorithm. Returns null if the plan has no evaluation dose.

Declaration

public EvaluationDose DoseAsEvaluationDose { get; }

Property Value

Type	Description
EvaluationDose

TradeoffExplorationContext

[Availability of this property depends on your Eclipse Scripting API license] Gets the TradeoffExplorationContext.

Declaration

public TradeoffExplorationContext TradeoffExplorationContext { get; }

Property Value

Type	Description
TradeoffExplorationContext

Remarks

To be able to get the TradeoffExplorationContext class, the plan needs to have the optimization objectives set.

Methods

AddArcBeam(ExternalBeamMachineParameters, VRect<Double>, Double, Double, Double, GantryDirection, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam to the plan.

Declaration

public Beam AddArcBeam(ExternalBeamMachineParameters machineParameters, VRect<double> jawPositions, double collimatorAngle, double gantryAngle, double gantryStop, GantryDirection gantryDirection, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
VRect<System.Double>	jawPositions	The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	gantryStop	The stop angle of the gantry, in degrees.
GantryDirection	gantryDirection	The rotation direction of the arc.
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created Beam.

Remarks

All angles must be specified in the range [0, 360[.

AddConformalArcBeam(ExternalBeamMachineParameters, Double, Int32, Double, Double, GantryDirection, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new conformal arc beam to the plan.

Declaration

public Beam AddConformalArcBeam(ExternalBeamMachineParameters machineParameters, double collimatorAngle, int controlPointCount, double gantryAngle, double gantryStop, GantryDirection gantryDirection, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Int32	controlPointCount	The number of control points to use.
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	gantryStop	The stop angle of the gantry, in degrees.
GantryDirection	gantryDirection	The rotation direction of the arc.
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddFixedSequenceBeam(ExternalBeamMachineParameters, Double, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new fixed sequence (flattening sequence) beam to the plan.

Declaration

public Beam AddFixedSequenceBeam(ExternalBeamMachineParameters machineParameters, double collimatorAngle, double gantryAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters. The machine must be Halcyon.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

AddImagingSetup(ExternalBeamMachineParameters, ImagingBeamSetupParameters, Structure)

[Availability of this method depends on your Eclipse Scripting API license] Adds new imaging beam or beams to the plan. First removes the existing imaging beams. If MV imaging beams are involved, the plan should be optimized again.

Declaration

public bool AddImagingSetup(ExternalBeamMachineParameters machineParameters, ImagingBeamSetupParameters setupParameters, Structure targetStructure)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
ImagingBeamSetupParameters	setupParameters	Setup parameters for the imaging beam. See ImagingBeamSetupParameters.
Structure	targetStructure	Target structure for imaging. If not specified, the target structure in the plan is used.

Returns

Type	Description
System.Boolean	True if imaging beams were successfully created.

AddMLCArcBeam(ExternalBeamMachineParameters, Single[,], VRect<Double>, Double, Double, Double, GantryDirection, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new arc beam with an MLC to the plan.

Declaration

public Beam AddMLCArcBeam(ExternalBeamMachineParameters machineParameters, float[, ] leafPositions, VRect<double> jawPositions, double collimatorAngle, double gantryAngle, double gantryStop, GantryDirection gantryDirection, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Single[,]	leafPositions	The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf], where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default.
VRect<System.Double>	jawPositions	The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	gantryStop	The stop angle of the gantry, in degrees.
GantryDirection	gantryDirection	The direction of the arc.
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddMLCBeam(ExternalBeamMachineParameters, Single[,], VRect<Double>, Double, Double, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new beam with an MLC to the plan.

Declaration

public Beam AddMLCBeam(ExternalBeamMachineParameters machineParameters, float[, ] leafPositions, VRect<double> jawPositions, double collimatorAngle, double gantryAngle, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Single[,]	leafPositions	The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default.
VRect<System.Double>	jawPositions	The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddMLCSetupBeam(ExternalBeamMachineParameters, Single[,], VRect<Double>, Double, Double, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field with an MLC to the plan.

Declaration

public Beam AddMLCSetupBeam(ExternalBeamMachineParameters machineParameters, float[, ] leafPositions, VRect<double> jawPositions, double collimatorAngle, double gantryAngle, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Single[,]	leafPositions	The positions of the beam collimator leaf pairs in millimeters, and in the IEC BEAMLIMITING DEVICE coordinate axis appropriate to the MLC device type. For example, the X-axis for MLCX and the Y-axis for MLCY. The two-dimensional array is indexed [bank, leaf] where the bank is either 0 or 1. Bank 0 represents the leaf bank to the negative MLC X direction, and bank 1 to the positive MLC X direction. Passing null selects the default.
VRect<System.Double>	jawPositions	The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddMultipleStaticSegmentBeam(ExternalBeamMachineParameters, IEnumerable<Double>, Double, Double, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Multiple Static Segments as the delivery technique.

Declaration

public Beam AddMultipleStaticSegmentBeam(ExternalBeamMachineParameters machineParameters, IEnumerable<double> metersetWeights, double collimatorAngle, double gantryAngle, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Collections.Generic.IEnumerable<System.Double>	metersetWeights	The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddSetupBeam(ExternalBeamMachineParameters, VRect<Double>, Double, Double, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new static setup field to the plan.

Declaration

public Beam AddSetupBeam(ExternalBeamMachineParameters machineParameters, VRect<double> jawPositions, double collimatorAngle, double gantryAngle, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
VRect<System.Double>	jawPositions	The jaw positions of the setup field in millimeters, and in IEC BEAM LIMITING DEVICE coordinates.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddSlidingWindowBeam(ExternalBeamMachineParameters, IEnumerable<Double>, Double, Double, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new IMRT beam to the plan and defines Sliding Window as the delivery technique.

Declaration

public Beam AddSlidingWindowBeam(ExternalBeamMachineParameters machineParameters, IEnumerable<double> metersetWeights, double collimatorAngle, double gantryAngle, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Collections.Generic.IEnumerable<System.Double>	metersetWeights	The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddSlidingWindowBeamForFixedJaws(ExternalBeamMachineParameters, IEnumerable<Double>, Double, Double, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new sliding window IMRT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account.

Declaration

public Beam AddSlidingWindowBeamForFixedJaws(ExternalBeamMachineParameters machineParameters, IEnumerable<double> metersetWeights, double collimatorAngle, double gantryAngle, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Collections.Generic.IEnumerable<System.Double>	metersetWeights	The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	Gantry angle in the IEC GANTRY coordinate system (in degrees).
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddStaticBeam(ExternalBeamMachineParameters, VRect<Double>, Double, Double, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new static beam to the plan.

Declaration

public Beam AddStaticBeam(ExternalBeamMachineParameters machineParameters, VRect<double> jawPositions, double collimatorAngle, double gantryAngle, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
VRect<System.Double>	jawPositions	The jaw positions of the treatment beam in millimeters, and in IEC BEAM LIMITING DEVICE coordinates.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddVMATBeam(ExternalBeamMachineParameters, IEnumerable<Double>, Double, Double, Double, GantryDirection, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam to the plan.

Declaration

public Beam AddVMATBeam(ExternalBeamMachineParameters machineParameters, IEnumerable<double> metersetWeights, double collimatorAngle, double gantryAngle, double gantryStop, GantryDirection gantryDirection, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Collections.Generic.IEnumerable<System.Double>	metersetWeights	The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryAngle	The orientation of the IEC GANTRY coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
System.Double	gantryStop	The stop angle of the gantry, in degrees.
GantryDirection	gantryDirection	The rotation direction of the arc.
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position, in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

AddVMATBeamForFixedJaws(ExternalBeamMachineParameters, IEnumerable<Double>, Double, Double, Double, GantryDirection, Double, VVector)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new VMAT beam and takes jaw positions from machine configuration. In case of a Halcyon machine, the special leaf position requirements are taken into account.

Declaration

public Beam AddVMATBeamForFixedJaws(ExternalBeamMachineParameters machineParameters, IEnumerable<double> metersetWeights, double collimatorAngle, double gantryStartAngle, double gantryStopAngle, GantryDirection gantryDir, double patientSupportAngle, VVector isocenter)

Parameters

Type	Name	Description
ExternalBeamMachineParameters	machineParameters	Configuration of the used treatment unit. See ExternalBeamMachineParameters.
System.Collections.Generic.IEnumerable<System.Double>	metersetWeights	The meterset weight for each control point of the beam. The number of meterset weight items defines the number of created control points.
System.Double	collimatorAngle	The orientation of the IEC BEAM LIMITING DEVICE coordinate system with respect to the IEC GANTRY coordinate system (in degrees).
System.Double	gantryStartAngle	Gantry start angle in the IEC GANTRY coordinate system (in degrees).
System.Double	gantryStopAngle	Gantry stop angle in the IEC GANTRY coordinate system (in degrees).
GantryDirection	gantryDir	Gantry direction
System.Double	patientSupportAngle	The orientation of the IEC PATIENT SUPPORT (turntable) coordinate system with respect to the IEC FIXED REFERENCE coordinate system (in degrees).
VVector	isocenter	The isocenter position in millimeters.

Returns

Type	Description
Beam	The created beam.

Remarks

All angles must be specified in the range [0, 360[.

CalculateDose()

[Availability of this method depends on your Eclipse Scripting API license] Calculates the dose for the plan.

Declaration

public CalculationResult CalculateDose()

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from CalculationLogs.

CalculateDoseWithPresetValues(List<KeyValuePair<String, MetersetValue>>)

Calculates the dose for the plan with preset meterset values. This applies only to IMRT beams.

Declaration

public CalculationResult CalculateDoseWithPresetValues(List<KeyValuePair<string, MetersetValue>> presetValues)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.Collections.Generic.KeyValuePair<System.String, MetersetValue>>	presetValues	The list of preset meterset values for the beams. An element of the list should contain a pair consisting of the beam identifier (as the key) and the corresponding preset meterset value for the beam. Each beam in the plan must have one entry in the list.

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from CalculationLogs.

CalculateDVHEstimates(String, Dictionary<String, DoseValue>, Dictionary<String, String>)

[Availability of this method depends on your Eclipse Scripting API license] Calculates DVH estimates for the plan.

Declaration

public CalculationResult CalculateDVHEstimates(string modelId, Dictionary<string, DoseValue> targetDoseLevels, Dictionary<string, string> structureMatches)

Parameters

Type	Name	Description
System.String	modelId	DVH estimation model ID.
System.Collections.Generic.Dictionary<System.String, DoseValue>	targetDoseLevels	Dose levels for the target structures.
System.Collections.Generic.Dictionary<System.String, System.String>	structureMatches	Matching between the IDs of the structures contained in the structure set used in the plan (the Key in the Dictionary) and the structures used in the DVH estimation model (the Value in the Dictionary).

Returns

Type	Description
CalculationResult	The calculation result. See the calculation details CalculationLogs

CalculateLeafMotions()

[Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the calculation options of the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation.

Declaration

public CalculationResult CalculateLeafMotions()

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from CalculationLogs.

CalculateLeafMotions(LMCMSSOptions)

[Availability of this method depends on your Eclipse Scripting API license] Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be MSS Leaf Motion Calculator (LMCMSS).

Declaration

public CalculationResult CalculateLeafMotions(LMCMSSOptions options)

Parameters

Type	Name	Description
LMCMSSOptions	options	Calculation options for the MSS Leaf Motion Calculator (LMCMSS) algorithm.

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from CalculationLogs.

CalculateLeafMotions(LMCVOptions)

Declaration

public CalculationResult CalculateLeafMotions(LMCVOptions options)

Parameters

Type	Name	Description
LMCVOptions	options	Calculation options for the Varian Leaf Motion Calculator (LMCV) algorithm.

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from CalculationLogs.

CalculateLeafMotions(SmartLMCOptions)

Calculates leaf motions using the given calculation options, which override the calculation options defined for the plan setup. Before calling this method, set the calculation models for leaf motions and dose calculation. The used leaf motion calculation algorithm must be Varian Smart LMC.

Declaration

public CalculationResult CalculateLeafMotions(SmartLMCOptions options)

Parameters

Type	Name	Description
SmartLMCOptions	options	Calculation options for the Varian Smart LMC algorithm.

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from CalculationLogs.

CalculateLeafMotionsAndDose()

Calculate leaf motions and dose using the calculation models defined in the plan setup.

Declaration

public CalculationResult CalculateLeafMotionsAndDose()

Returns

Type	Description
CalculationResult	Result of the intermediate dose calculation.

CalculatePlanUncertaintyDoses()

[Availability of this method depends on your Eclipse Scripting API license] Calculates the plan uncertainty dose for the photon plan.

Declaration

public CalculationResult CalculatePlanUncertaintyDoses()

Returns

Type	Description
CalculationResult	The calculation result. See calculation details in CalculationLogs.

CopyEvaluationDose(Dose)

[Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose are copied from the existing dose matrix. To create an evaluation dose, the plan must not contain any beams.

Declaration

public EvaluationDose CopyEvaluationDose(Dose existing)

Parameters

Type	Name	Description
Dose	existing	The dose matrix is copied from this object.

Returns

Type	Description
EvaluationDose	A new evaluation dose object.

CreateEvaluationDose()

[Availability of this method depends on your Eclipse Scripting API license] Creates an evaluation dose for the plan. The voxels in an evaluation dose can be set using the Eclipse Scripting API instead of a dose calculation algorithm. To create an evaluation dose, the plan must not contain any beams. To set the evaluation dose voxels, retrieve the dose matrix using the DoseAsEvaluationDose property of the plan and then use SetVoxels(Int32, Int32[,]).

Declaration

public EvaluationDose CreateEvaluationDose()

Returns

Type	Description
EvaluationDose	A new evaluation dose object.

Remarks

Saving modifications to the database is not possible if the evaluation dose has been created but voxels have not been set.

GetModelsForCalculationType(CalculationType)

Returns a list of calculation models for the given calculation type.

Declaration

public IEnumerable<string> GetModelsForCalculationType(CalculationType calculationType)

Parameters

Type	Name	Description
CalculationType	calculationType	The type of calculation.

Returns

Type	Description
System.Collections.Generic.IEnumerable<System.String>	The list of calculation models.

Optimize()

Runs IMRT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization.

Declaration

public OptimizerResult Optimize()

Returns

Type	Description
OptimizerResult	The result of the optimization.

Optimize(Int32)

Runs IMRT optimization for the plan setup. All existing optimal fluences are removed from the beams. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization.

Declaration

public OptimizerResult Optimize(int maxIterations)

Parameters

Type	Name	Description
System.Int32	maxIterations	The maximum number of iterations.

Returns

Type	Description
OptimizerResult	The result of the optimization.

Optimize(Int32, OptimizationOption)

Runs IMRT optimization for the plan setup. Fails if the method cannot select an MLC for the beams. Plan normalization method is changed to 'No plan normalization' after successful optimization.

Declaration

public OptimizerResult Optimize(int maxIterations, OptimizationOption optimizationOption)

Parameters

Type	Name	Description
System.Int32	maxIterations	The maximum number of iterations.
OptimizationOption	optimizationOption	Optimization options.

Returns

Type	Description
OptimizerResult	The result of the optimization.

Optimize(Int32, OptimizationOption, String)

Runs IMRT optimization for the plan setup. You can add the Multileaf Collimator (MLC) as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization.

Declaration

public OptimizerResult Optimize(int maxIterations, OptimizationOption optimizationOption, string mlcId)

Parameters

Type	Name	Description
System.Int32	maxIterations	The maximum number of iterations.
OptimizationOption	optimizationOption	Optimization option specifying the initial state.
System.String	mlcId	The identifier for the Multileaf Collimator (MLC).

Returns

Type	Description
OptimizerResult	The result of the optimization.

Optimize(OptimizationOptionsIMRT)

[Availability of this method depends on your Eclipse Scripting API license] Runs IMRT optimization for the plan setup. Plan normalization method is changed to 'No plan normalization' after successful optimization.

Declaration

public OptimizerResult Optimize(OptimizationOptionsIMRT options)

Parameters

Type	Name	Description
OptimizationOptionsIMRT	options	Options specifying initial state, intermediate dose, and termination upon convergence.

Returns

Type	Description
OptimizerResult	Result of the optimization.

OptimizeVMAT()

[Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. The Multileaf Collimator (MLC) is determined automatically. If there are more than one MLC or no MLC at all, an exception is thrown. Plan normalization method is changed to 'No plan normalization' after successful optimization.

Declaration

public OptimizerResult OptimizeVMAT()

Returns

Type	Description
OptimizerResult	The result of the optimization.

OptimizeVMAT(String)

[Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup. You can add the MLC as a parameter. Plan normalization method is changed to 'No plan normalization' after successful optimization.

Declaration

public OptimizerResult OptimizeVMAT(string mlcId)

Parameters

Type	Name	Description
System.String	mlcId	The identifier for the Multileaf Collimator (MLC).

Returns

Type	Description
OptimizerResult	The result of the optimization.

OptimizeVMAT(OptimizationOptionsVMAT)

[Availability of this method depends on your Eclipse Scripting API license] Runs VMAT optimization for the plan setup using intermediate dose calculation. Plan normalization method is changed to 'No plan normalization' after successful optimization.

Declaration

public OptimizerResult OptimizeVMAT(OptimizationOptionsVMAT options)

Parameters

Type	Name	Description
OptimizationOptionsVMAT	options	VMAT optimization options.

Returns

Type	Description
OptimizerResult	The result of the optimization.

RemoveBeam(Beam)

[Availability of this method depends on your Eclipse Scripting API license] Removes a beam from the plan.

Declaration

public void RemoveBeam(Beam beam)

Parameters

Type	Name	Description
Beam	beam	The beam that will be removed from the plan.

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

PlanSetup.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable

IDVHEstimationCalculator