Class StructureSet

A structure set is a container for structures of a patient, including anatomical organs, treatment volumes and markers, and support structures.

Inheritance

System.Object

SerializableObject

ApiDataObject

StructureSet

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

ApiDataObject.ToString()

ApiDataObject.Equals(Object)

ApiDataObject.GetHashCode()

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 StructureSet : ApiDataObject

Properties

ApplicationScriptLogs

The log entries of the script executions that have modified the structure set.

Declaration

public IEnumerable<ApplicationScriptLog> ApplicationScriptLogs { get; }

Property Value

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

Id

[Availability of this property depends on your Eclipse Scripting API license] The identifier of the structure set.

Declaration

public string Id { get; set; }

Property Value

Type	Description
System.String

Image

Used for navigating to the image.

Declaration

public Image Image { get; }

Property Value

Type	Description
Image

Patient

Used for navigating to the patient.

Declaration

public Patient Patient { get; }

Property Value

Type	Description
Patient

Structures

Used for navigating to the child structures.

Declaration

public IEnumerable<Structure> Structures { get; }

Property Value

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

UID

DICOM UID.

Declaration

public string UID { get; }

Property Value

Type	Description
System.String

Methods

AddStructure(String, String)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new structure according to the DICOM structure type.

Declaration

public Structure AddStructure(string dicomType, string id)

Parameters

Type	Name	Description
System.String	dicomType	RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION".
System.String	id	The identifier for the new structure.

Returns

Type	Description
Structure	Newly created structure.

CanAddStructure(String, String)

Returns true if it is possible to add the given type of structure to the structure set.

Declaration

public bool CanAddStructure(string dicomType, string id)

Parameters

Type	Name	Description
System.String	dicomType	RT ROI Interpreted Type (DICOM). Identifies the DICOM structure type. Possible values are "AVOIDANCE", "CAVITY", "CONTRAST_AGENT", "CTV", "EXTERNAL", "GTV", "IRRAD_VOLUME", "ORGAN", "PTV", "TREATED_VOLUME", "SUPPORT", "FIXATION", "CONTROL", and "DOSE_REGION".
System.String	id	The identifier for the new structure.

Returns

Type	Description
System.Boolean	true if it is possible to add the given type of structure to the structure set. Otherwise false.

CanRemoveStructure(Structure)

Returns true if it is possible to remove the given structure from the structure set.

Declaration

public bool CanRemoveStructure(Structure structure)

Parameters

Type	Name	Description
Structure	structure	The structure to check.

Returns

Type	Description
System.Boolean	Returns true if the structure can be removed, false otherwise.

Copy()

[Availability of this method depends on your Eclipse Scripting API license] Creates a copy of this structure set.

Declaration

public StructureSet Copy()

Returns

Type	Description
StructureSet	The newly created copy of the structure set.

CreateAndSearchBody(SearchBodyParameters)

[Availability of this method depends on your Eclipse Scripting API license] Creates a new Body structure and searches Body with the specified parameters. The existing Body structure is returned, if there is one.

Declaration

public Structure CreateAndSearchBody(SearchBodyParameters parameters)

Parameters

Type	Name	Description
SearchBodyParameters	parameters	Parameters for the Search Body feature.

Returns

Type	Description
Structure	Newly created or already existing Body structure.

Delete()

[Availability of this method depends on your Eclipse Scripting API license] Deletes this structure set.

Declaration

public void Delete()

GetDefaultSearchBodyParameters()

Gets a default set of Search Body parameters.

Declaration

public SearchBodyParameters GetDefaultSearchBodyParameters()

Returns

Type	Description
SearchBodyParameters	Parameters for the Search Body feature.

RemoveStructure(Structure)

[Availability of this method depends on your Eclipse Scripting API license] Removes the structure from this structure set if removal is allowed.

Declaration

public void RemoveStructure(Structure structure)

Parameters

Type	Name	Description
Structure	structure	The structure to remove.

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