Class EvaluationDose
Represents an evaluation dose that is connected to a plan that has no beams.
Implements
Inherited Members
Namespace: VMS.TPS.Common.Model.API
Assembly: VMS.TPS.Common.Model.API.dll
Syntax
public class EvaluationDose : Dose, IXmlSerializableMethods
DoseValueToVoxel(DoseValue)
Converts the given dose value to the corresponding raw voxel value.
Declaration
public int DoseValueToVoxel(DoseValue doseValue)Parameters
| Type | Name | Description |
|---|---|---|
| DoseValue | doseValue | Dose value. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Value converted to voxel value. |
SetVoxels(Int32, Int32[,])
[Availability of this method depends on your Eclipse Scripting API license] For an evaluation dose (the dose of a plan that has no beams), sets the voxels of the given dose plane. Create the evaluation dose first using CreateEvaluationDose().
Declaration
public void SetVoxels(int planeIndex, int[, ] values)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | planeIndex | Zero-based index of the plane. |
| System.Int32[,] | values | The plane of voxel values. The size of the array must conform to the X-size and Y-size of the dose. |
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. |