Class BrachyPlanSetup
Represents a brachytherapy treatment plan.
Implements
Inherited Members
Namespace: VMS.TPS.Common.Model.API
Assembly: VMS.TPS.Common.Model.API.dll
Syntax
public class BrachyPlanSetup : PlanSetup, IXmlSerializableProperties
ApplicationSetupType
The application setup type of this brachytherapy plan. Possible types are: "FLETCHER_SUIT", "DELCLOS", "BLOEDORN", "JOSLIN_FLYNN", "CHANDIGARH", "MANCHESTER", "HENSCHKE", "NASOPHARYNGEAL", "OESOPHAGEAL", "ENDOBRONCHIAL", "SYED_NEBLETT", "ENDORECTAL", "PERINEAL", "HAM_FLAB", "EYE_PLAQUE", and "OTHER".
Declaration
public string ApplicationSetupType { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Catheters
The catheters or applicator channel centerlines of this brachytherapy plan, including any catheters associated with BrachySolidApplicator.
Declaration
public IEnumerable<Catheter> Catheters { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<Catheter> |
NumberOfPdrPulses
The number of pulses in a brachytherapy Pulse Dose Rate (PDR) treatment. Null if the plan is not for a PDR treatment.
Declaration
public int? NumberOfPdrPulses { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int32> |
PdrPulseInterval
The pulse interval in a brachytherapy Pulse Dose Rate (PDR) treatment in seconds. Null if the plan is not for a PDR treatment.
Declaration
public double? PdrPulseInterval { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Double> |
SeedCollections
The seed collections of this brachytherapy plan.
Declaration
public IEnumerable<SeedCollection> SeedCollections { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<SeedCollection> |
SolidApplicators
The solid applicator parts of this brachytherapy plan.
Declaration
public IEnumerable<BrachySolidApplicator> SolidApplicators { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IEnumerable<BrachySolidApplicator> |
TreatmentDateTime
The treatment date of this brachytherapy plan.
Declaration
public DateTime? TreatmentDateTime { get; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> |
TreatmentTechnique
The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT".
Declaration
public string TreatmentTechnique { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Methods
CalculateAccurateTG43DoseProfile(VVector, VVector, Double[])
Calculates and returns the dose profile. Profile is calculated on the fly with TG-43 formalism.
Declaration
public DoseProfile CalculateAccurateTG43DoseProfile(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 | Dose profile that holds the dose values along the line segment defined by the start and stop parameters. Values are NaN if the plan has imported dose or the dose has been calculated with the AcurosBV algorithm. |
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. |