Class Dose

Represents a 3D dose grid.

Inheritance

System.Object

Dose

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

ApiDataObject.Id

ApiDataObject.Name

ApiDataObject.Comment

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 Dose : ApiDataObject, IXmlSerializable

Properties

DoseMax3D

The maximum dose.

Declaration

public DoseValue DoseMax3D { get; }

Property Value

Type	Description
DoseValue

DoseMax3DLocation

The location of the maximum dose.

Declaration

public VVector DoseMax3DLocation { get; }

Property Value

Type	Description
VVector

Isodoses

A collection of isodoses.

Declaration

public IEnumerable<Isodose> Isodoses { get; }

Property Value

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

Origin

The origin of the dose matrix. In other words, the DICOM coordinates of the center point of the upper-left hand corner voxel of the first dose plane.

Declaration

public VVector Origin { get; }

Property Value

Type	Description
VVector

Series

Returns the series that contains the dose, or null if the dose is not connected to a series.

Declaration

public Series Series { get; }

Property Value

Type	Description
Series

SeriesUID

Returns the DICOM UID of the series that contains the dose, or an empty string if the dose is not connected to a series.

Declaration

public string SeriesUID { get; }

Property Value

Type	Description
System.String

UID

The DICOM UID of the dose.

Declaration

public string UID { get; }

Property Value

Type	Description
System.String

XDirection

The direction of the x-axis in the dose matrix.

Declaration

public VVector XDirection { get; }

Property Value

Type	Description
VVector

XRes

The dose matrix resolution in X-direction in millimeters.

Declaration

public double XRes { get; }

Property Value

Type	Description
System.Double

XSize

The dose matrix size in X-direction in voxels.

Declaration

public int XSize { get; }

Property Value

Type	Description
System.Int32

YDirection

The direction of the y-axis in the dose matrix.

Declaration

public VVector YDirection { get; }

Property Value

Type	Description
VVector

YRes

The dose matrix resolution in Y-direction in millimeters.

Declaration

public double YRes { get; }

Property Value

Type	Description
System.Double

YSize

The dose matrix size in Y-direction in voxels.

Declaration

public int YSize { get; }

Property Value

Type	Description
System.Int32

ZDirection

The direction of the z-axis in the dose matrix.

Declaration

public VVector ZDirection { get; }

Property Value

Type	Description
VVector

ZRes

The dose matrix resolution in Z-direction in millimeters.

Declaration

public double ZRes { get; }

Property Value

Type	Description
System.Double

ZSize

The dose matrix size in Z-direction in voxels.

Declaration

public int ZSize { get; }

Property Value

Type	Description
System.Int32

Methods

GetDoseProfile(VVector, VVector, Double[])

Gets the dose profile.

Declaration

public DoseProfile GetDoseProfile(VVector start, VVector stop, double[] preallocatedBuffer)

Parameters

Type	Name	Description
VVector	start	Location of the first point of the profile.
VVector	stop	Location of the last point of the profile.
System.Double[]	preallocatedBuffer	Preallocated buffer where the values are stored. The size of the buffer determines the number of values to return.

Returns

Type	Description
DoseProfile	The DoseProfile object holding the dose values along the line segment defined by start and stop parameters.

GetDoseToPoint(VVector)

Gets the point dose at a specified location.

Declaration

public DoseValue GetDoseToPoint(VVector at)

Parameters

Type	Name	Description
VVector	at	Location

Returns

Type	Description
DoseValue	Dose value. A NaN is returned if dose value is not available.

GetVoxels(Int32, Int32[,])

Gets the voxels of the given dose plane.

Declaration

public void GetVoxels(int planeIndex, int[, ] preallocatedBuffer)

Parameters

Type	Name	Description
System.Int32	planeIndex	Zero based index of the plane.
System.Int32[,]	preallocatedBuffer	Preallocated buffer where the voxel values are stored. The size of the buffer must conform with the X- and Y-size of this dose.

VoxelToDoseValue(Int32)

Converts the given raw voxel value to the corresponding dose value.

Declaration

public DoseValue VoxelToDoseValue(int voxelValue)

Parameters

Type	Name	Description
System.Int32	voxelValue	Voxel value.

Returns

Type	Description
DoseValue	Value converted to 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.

Overrides

ApiDataObject.WriteXml(XmlWriter)

Implements

System.Xml.Serialization.IXmlSerializable