Namespace VMS.TPS.Common.Model.API

Classes

ActiveStructureCodeDictionaries

Provides access to the structure code dictionaries with the active structure codes.

AddOn

Represents an add-on, which is a beam modifying device that is inserted into a beam in an accessory slot of the external beam machine. An add-on is used to shape the beam or modulate its intensity or both. Add-ons are blocks, MLCs, wedges, compensators, applicators, a tray, and other devices or materials that can be fixed to a tray to be mounted into an accessory slot.

AddOnMaterial

Add-on material describes the dosimetric and physical properties of the metal alloy or other substance used to create the add-on.

ApiDataObject

The base class of objects in the Eclipse Scripting API.

Application

The main application interface.

ApplicationScript

Presents the application script information in the system.

The location of the script file is not stored in the system.

ApplicationScriptLog

The log entry of the application script execution.

Applicator

An applicator add-on, either an electron applicator or cone applicator.

Beam

Represents one beam (also referred to as "field") of an external beam treatment plan. See the definition of DICOM RT Beam for more details.

BeamCalculationLog

Represents a beam calculation log.

BeamDose

Represents a dose that is connected to a Beam.

BeamParameters

An editable copy of the parameters of a treatment beam.

BeamUncertainty

Access to beam uncertainty.

Block

Represents a block add-on, a custom-made beam collimating material fixed to a tray, used to shape the beam.

Bolus

Represents a bolus, which is custom-made material that is usually fixed to the patient's skin for treatment. The bolus is used to modulate the depth dose profile of a beam.

BrachyFieldReferencePoint

This object links a Brachy field to a reference point.

BrachyPlanSetup

Represents a brachytherapy treatment plan.

BrachySolidApplicator

Represents a brachytherapy solid applicator part, such as a tandem or ovoid in a Fletcher Suit Delclos (FSD) applicator set. This class holds only the metadata related to the solid applicator part, and links to the Catheter that are part of the solid applicator.

BrachyTreatmentUnit

Represents a brachytherapy afterloader.

Calculation

Contains a calculation specific functions

CalculationResult

Holds the result of the calculation (pass/fail).

Catheter

Represents a brachytherapy catheter or an applicator channel centerline. Catheters are associated with a BrachyTreatmentUnit, a ChannelNumber, and possibly a BrachySolidApplicatorPartID of the BrachySolidApplicator they belong to. Most notably, catheters encapsulate the Shape of the applicator channel centerline and its SourcePositions.

Compensator

Represents a beam compensator add-on, a custom-made beam modulating material fixed to a tray, used to modulate the beam's intensity.

ControlPoint

Represents a point in a planned sequence of treatment beam parameters. See the definition of control points in a DICOM RT Beam.

ControlPointCollection

Represents a collection of machine parameters that describe the planned treatment beam.

ControlPointParameters

An editable copy of the parameters of a control point.

Course

A course represents the course of treatment that a patient will be given. Every patient must have a course, and all plans always belong to a course.

CustomScriptExecutable

A factory class for creating an application object for a custom script executable.

Diagnosis

Represents a diagnosis of the patient.

Dose

Represents a 3D dose grid.

DVHData

Represents Dose Volume Histogram (DVH) data.

DVHEstimationModelStructure

Structure of a DVH estimation model in Planning Model Library

DVHEstimationModelSummary

A summary of an DVH Estimation Model. Contains the needed information for selecting a model.

DynamicWedge

A Dynamic Wedge is formed by a moving jaw of a standard collimator during irradiation.

EnhancedDynamicWedge

An Enhanced Dynamic Wedge is similar to a Dynamic Wedge, but it features more wedge angles than a simple Dynamic Wedge.

ESAPIActionPackAttribute

Specifies the assembly as an Eclipse visual scripting action pack. Action packs are ESAPI scripts that are used by visual scripts.

ESAPIScriptAttribute

Specifies the assembly as an Eclipse Scripting API (ESAPI) script.

EstimatedDVH

Represents an estimated Dose Volume Histogram (DVH) curve.

EvaluationDose

Represents an evaluation dose that is connected to a plan that has no beams.

ExternalBeamTreatmentUnit

Represents a treatment machine used for delivering external beam radiotherapy.

ExternalPlanSetup

Represents an external beam plan. For more information, see the definition of the DICOM RT Plan.

FieldReferencePoint

This object links a treatment beam to a reference point.

Globals

This class is internal to the Eclipse Scripting API.

Hospital

Represents a hospital.

Image

Represents a 2D or 3D image, which can be a DRR, a CT, MR, or other volumetric dataset.

IonBeam

Proton beam interface.

IonBeamParameters

An editable copy of the parameters of a proton beam.

IonControlPoint

Proton control point interface.

IonControlPointCollection

Represents a collection of machine parameters that describe the planned proton beam.

IonControlPointPair

An editable copy of a control point pair (the pair of the start control point with an even index, and the end control point with an odd index).

IonControlPointPairCollection

A collection of editable copies of control point pairs that describe the planned proton beam.

IonControlPointParameters

An editable copy of the parameters of a proton control point.

IonPlanSetup

Represents a proton treatment plan.

IonSpot

The proton scanning spot interface that contains the 3D spot position and spot weight.

IonSpotCollection

Interface for the proton scanning spot list.

IonSpotParameters

Interface for the proton scanning spot that contains the 3D spot position and spot weight.

IonSpotParametersCollection

Interface for the editable proton scanning spot list.

Isodose

Represents an isodose level for a fixed absolute or relative dose value.

LateralSpreadingDevice

The lateral spreading device.

LateralSpreadingDeviceSettings

Settings for the lateral spreading device.

MLC

Represents a Multileaf Collimator (MLC) add-on.

MotorizedWedge

A motorized wedge is a standard wedge placed in the beam for a user-defined fraction of the total treatment time.

OmniWedge

An OmniWedge is a special type of wedge that combines an open field, a motorized wedge, and a virtual wedge to create the desired wedge effect.

OptimizationEUDObjective

A gEUD objective is an exact, upper or lower objective. An exact gEUD objective defines an exact dose value that a target structure should receive. An upper gEUD objective defines the maximum dose value that a structure should receive. A lower gEUD objective defines the minimum dose value that a target structure should receive.

Generalized Equivalent Uniform Dose (gEUD) is a uniform dose that, if delivered over the same number of fractions, yields the same radiobiological effect as the non-uniform dose distribution of interest.

OptimizationExcludeStructureParameter

Structures that have this parameter are excluded from the optimization.

OptimizationIMRTBeamParameter

Beam-specific optimization parameter for IMRT optimization.

OptimizationJawTrackingUsedParameter

An optimization parameter for using jaw tracking in VMAT optimization. The parameter exists if OptimizationSetup.UseJawTracking has been set to true.

OptimizationLineObjective

A line objective is a collection of point objectives that have the same priority. It is used to limit the dose in a given structure.

OptimizationMeanDoseObjective

A mean objective defines the mean dose that should not be exceeded. The mean objective is used to decrease the dose that a structure receives.

OptimizationNormalTissueParameter

An optimization parameter for the normal tissue objective.

OptimizationObjective

Provides a common base type for all structure-specific optimization objectives.

OptimizationParameter

Provides a common base type for all optimization parameters.

OptimizationPointCloudParameter

Structure-specific parameter for point cloud optimization.

Relevant if the optimization algorithm uses a point cloud. The point cloud parameters are automatically created with default values when you add other structure-specific parameters or objectives in the optimization setup.

OptimizationPointObjective

A point objective is either an upper or lower objective. An upper objective is used to limit the dose in a given structure. A lower objective is used to define the desired dose levels in target structures.

OptimizationSetup

Gives access to the optimization parameters and objectives.

OptimizerDVH

Contains a structure-specific Dose Volume Histogram (DVH) curve generated in optimization.

OptimizerObjectiveValue

The optimizer objective function value for the structure.

OptimizerResult

Holds the result of the optimization (pass/fail).

Patient

Represents a patient.

PatientSummary

Basic information about the patient.

PatientSupportDevice

Represents a proton patient support device.

PlanningItem

Common properties of a treatment plan and a plan sum.

PlanningItemDose

Represents a dose that is connected to a plan setup or a plan sum.

PlanSetup

Represents a treatment plan. See the definition of a DICOM RT Plan for more information.

PlanSum

A plan sum describes the cumulative dose summation of several treatment plans. It can be used, for example, to evaluate the dose the patient received from a treatment plan and boost plan together.

PlanSumComponent

Represents a component plan of a plan sum.

PlanTreatmentSession

Plan in the treatment session.

PlanUncertainty

Provides access to Plan Uncertainty parameters. For more information, see Eclipse Photon and Electron Instructions for Use.

ProtocolPhaseMeasure

Represents the plan measures (quality indices) of the clinical protocol.

ProtocolPhasePrescription

Represents the prescriptions (plan objectives) of the clinical protocol.

RadioactiveSource

Represents a radioactive source installed into a BrachyTreatmentUnit or a seed of a SeedCollection.

RadioactiveSourceModel

The radioactive source model represents the details of the radioactive source used in brachytherapy. It encapsulates the source isotope, dimensions, and dose calculation parameters.

RangeModulator

The range modulator device.

RangeModulatorSettings

Range modulator settings.

RangeShifter

The range shifter device.

RangeShifterSettings

Range shifter settings.

ReferencePoint

A reference point associated with a patient.

Registration

Represents the spatial registration matrix between two frames of reference.

RTPrescription

Represents a prescription.

RTPrescriptionConstraint

Represents a coverage constraint for an RT prescription.

Type of the constraint	Applies to	Example	Value1	Unit1	Value2	Unit2
MinimumDose	Targets	Minimum dose > 95% (of the target dose).	95	%	null	null
MaximumDose	Targets	Maximum dose < 102% (of the target dose).	102	%	null	null
MaximumDose	Organs at risk	Maximum dose < 50 Gy.	50	Gy	null	null
MinimumDvhDose	Targets	At least 95% of structure gets 98% of the target dose, i.e. V98% > 95%.	98	%	95	%
MaximumDvhDose	Targets	No more than 95% of structure gets 102% of the target dose, i.e. V102% < 95%.	102	%	95	%
MaximumMeanDose	Organs at risk	Maximum mean dose < 45 Gy.	45	Gy	null	null
FreeText	Organs at risk	Free text constraint (a < b).	a	null	b	null

RTPrescriptionOrganAtRisk

Represents an organ at risk structure.

RTPrescriptionTarget

Represents a prescription target.

RTPrescriptionTargetConstraints

Represents target structure constraints.

ScriptContext

Contains the runtime context information of the active application for the script.

ScriptEnvironment

Contains the runtime information of the application environment for the script.

SearchBodyParameters

Parameters for the Search Body feature.

SeedCollection

Represents a collection of brachytherapy SourcePosition. Each position is also associated with a radioactive source.

SegmentVolume

The volumetric representation of a structure. This object is used when defining margins for structures, or when performing Boolean operations on structures.

SerializableObject

Base class for objects that can be serialized.

Series

A series is a collection of radiation therapy objects of a patient. The series is part of a study. See the definition of a DICOM Series for more information.

Slot

A slot is the location (typically on the collimator head of the gantry) where an add-on, such as a wedge or block, is mounted.

SourcePosition

Represents a brachytherapy source dwell position in a Catheter or a seed position in a SeedCollection.

StandardWedge

A standard wedge is a physical piece of material with an angle that is static during treatment.

Structure

A structure is a geometrical representation of an anatomical organ, a treatment volume, a marker, or a support structure. See the definition of a DICOM Structure for more information.

StructureCode

Represents a structure code and its coding scheme.

StructureCodeDictionary

Represents a set of structure codes as defined by a structure code scheme. The class exposes the structure codes that are available through the implemented System.Collections.Generic.IReadOnlyDictionary<TKey, TValue> interface. Structure code schemes are managed in RT Administration.

Structs

Calculation.Algorithm

Algorithm

Calculation.CalculationModel

Calculation Model

Interfaces

IDVHEstimationCalculator

Interface to the calculation of the DVH Estimates

Enums

TradeoffPlanGenerationIntermediateDoseMode

Enumeration that specifies the use of intermediate dose when optimizing a plan collection for trade-off exploring.