Class BrachyPlanSetup

Represents a brachytherapy treatment plan.

Inheritance
System.Object
SerializableObject
ApiDataObject
PlanningItem
PlanSetup
BrachyPlanSetup
Implements
System.Xml.Serialization.IXmlSerializable
Inherited Members
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 BrachyPlanSetup : PlanSetup, IXmlSerializable

Properties

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

BrachyTreatmentTechnique

The treatment technique of this brachytherapy plan. Possible techniques are "INTRALUMENARY", "INTRACAVITARY", "INTERSTITIAL", "CONTACT", "INTRAVASCULAR", and "PERMANENT".

Declaration
public BrachyTreatmentTechniqueType BrachyTreatmentTechnique { get; set; }
Property Value
Type Description
BrachyTreatmentTechniqueType

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>

ReferenceLines

Collection of reference lines in the plan.

Declaration
public IEnumerable<Structure> ReferenceLines { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Structure>

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; set; }
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
[Obsolete("Use BrachyTreatmentTechnique instead")]
public string TreatmentTechnique { get; }
Property Value
Type Description
System.String

Methods

AddCatheter(String, BrachyTreatmentUnit, StringBuilder, Boolean, Int32)

[Availability of this method depends on your Eclipse Scripting API license] Creates a new brachyterapy applicator to the plan.

Declaration
public Catheter AddCatheter(string catheterId, BrachyTreatmentUnit treatmentUnit, StringBuilder outputDiagnostics, bool appendChannelNumToId, int channelNum)
Parameters
Type Name Description
System.String catheterId

Id of the catheter.
BrachyTreatmentUnit treatmentUnit

The BrachyTreatmentUnit to be set to the applicator.
System.Text.StringBuilder outputDiagnostics

Additional information about brachytherapy applicator creation.
System.Boolean appendChannelNumToId

If true, channel number will be appended to the given catheterId.
System.Int32 channelNum

Channel number of the catheter. 0 assigns next available free channel number. -1 assigns empty channel number.
Returns
Type Description
Catheter

Newly created brachytherapy applicator.

AddLocationToExistingReferencePoint(VVector, ReferencePoint)

[Availability of this method depends on your Eclipse Scripting API license] Add location to reference point.

Declaration
public void AddLocationToExistingReferencePoint(VVector location, ReferencePoint referencePoint)
Parameters
Type Name Description
VVector location

Reference point location in mm.
ReferencePoint referencePoint

Reference point.

AddReferencePoint(Boolean, String)

[Availability of this method depends on your Eclipse Scripting API license] Creates a new reference point without location. Created reference point is linked to the plan.

Declaration
public ReferencePoint AddReferencePoint(bool target, string id)
Parameters
Type Name Description
System.Boolean target

Indicates whether the reference point tracks treatment target (true) or organ at risk (false).
System.String id

Reference point ID.
Returns
Type Description
ReferencePoint

Newly created reference point.

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.

CalculateTG43Dose()

Calculates 3D dose using the TG-43 brachy calculator.

Declaration
public CalculateBrachy3DDoseResult CalculateTG43Dose()
Returns
Type Description
CalculateBrachy3DDoseResult

Success is true on success. Otherwise Errors contains the failure reason.

ChangeTreatmentUnit(BrachyTreatmentUnit, Boolean, out List<String>)

[Availability of this method depends on your Eclipse Scripting API license] Changes the brachy treatment unit for all applicators in the brachy plan.

Declaration
public ChangeBrachyTreatmentUnitResult ChangeTreatmentUnit(BrachyTreatmentUnit treatmentUnit, bool keepDoseIntact, out List<string> messages)
Parameters
Type Name Description
BrachyTreatmentUnit treatmentUnit

The BrachyTreatmentUnit to be set to the plan.
System.Boolean keepDoseIntact

If true, the dwell times are scaled to keep the dose intact. If false, dwell times are not scaled, and the dose may be invalidated.
System.Collections.Generic.List<System.String> messages

An output parameter that may be populated with 1..n messages of additional information.
Returns
Type Description
ChangeBrachyTreatmentUnitResult

ChangeBrachyTreatmentUnitResult.Success if the brachy treatment unit was successfully changed. ChangeBrachyTreatmentUnitResult.SuccessButPdrDataMissing if the brachy treatment unit was changed, but the plan does not have valid PDR (Pulse Dose Rate) data. ChangeBrachyTreatmentUnitResult.Failed if the brachy treatment unit change failed. ChangeBrachyTreatmentUnitResult.FailedBecausePlanContainsSeedCollections if the treatment unit could not be changed because the plan contains seed collection(s).

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

Implements

System.Xml.Serialization.IXmlSerializable