The evaluation dose is connected to the plan and contains voxels that are set by SetVoxels 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

IonBeams

Gets the proton beams of the plan.

Declaration

public IEnumerable<IonBeam> IonBeams { get; }

Property Value

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

IsPostProcessingNeeded

Instructs whether to include the post-processing of scanning spots in proton dose calculation.

Declaration

public bool IsPostProcessingNeeded { get; set; }

Property Value

Type	Description
System.Boolean

Methods

CalculateDose()

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

Declaration

public CalculationResult CalculateDose()

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from the calculation logs.

CalculateDoseWithoutPostProcessing()

Calculates the dose for a proton plan without post-processing. The existing final spot list is used, and no new list is created during the calculation.

Declaration

public CalculationResult CalculateDoseWithoutPostProcessing()

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from the calculation logs.

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.

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.

PostProcessAndCalculateDose()

ost-processes the proton plan by creating a final spot list, and calculates the dose.

Declaration

public CalculationResult PostProcessAndCalculateDose()

Returns

Type	Description
CalculationResult	The calculation result. See calculation details from the calculation logs.

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