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.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, IXmlSerializable

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>

Comment

[Availability of this property depends on your Eclipse Scripting API license] A comment about the structure set.

Declaration

public string Comment { get; set; }

Property Value

Type	Description
System.String

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

Name

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

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

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

AddCouchStructures(String, PatientOrientation, RailPosition, RailPosition, Nullable<Double>, Nullable<Double>, Nullable<Double>, out IReadOnlyList<Structure>, out Boolean, out String)

[Availability of this method depends on your Eclipse Scripting API license] Adds couch structures to the StructureSet. Eclipse can model certain couches for photon treatment planning. A couch is modeled as a set of couch structures.The couch panel surface and interior, movable structural rails and grid(for Unipanel only) are each modeled as separate couch structures. The structure code of a couch structure is Support by default. You can change it to another structure code if necessary. The volume type of a couch structure is always Support. Couch structures are modeled inside a 3D image. If the 3D image is too small, this method will always enlarge the image to fit the couch structures.

Declaration

public bool AddCouchStructures(string couchModel, PatientOrientation orientation, RailPosition railA, RailPosition railB, double? surfaceHU, double? interiorHU, double? railHU, out IReadOnlyList<Structure> addedStructures, out bool imageResized, out string error)

Parameters

Type	Name	Description
System.String	couchModel	The id of the couch profile configured in Eclipse to use when creating the couch structures.
PatientOrientation	orientation	Patient orientation specifying where the couch structures are added. Pass NoOrientation to take the orientation from the image.
RailPosition	railA	Position of moveable rail A.
RailPosition	railB	Position of moveable rail B.
System.Nullable<System.Double>	surfaceHU	HU value of the modeled couch surface. Pass null to use the setting from the specified couch profile or override by passing another value.
System.Nullable<System.Double>	interiorHU	HU value of the modeled couch interior. Pass null to use the setting from the specified couch profile or override by passing another value.
System.Nullable<System.Double>	railHU	HU value of the modeled couch rails. Pass null to use the setting from the specified couch profile or override by passing another value.
System.Collections.Generic.IReadOnlyList<Structure>	addedStructures	Returned list of added couch structures if successful.
System.Boolean	imageResized	True if image was resized.
System.String	error	Returned error message if call failed.

Returns

Type	Description
System.Boolean	True if couch structures added.

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.

AddStructure(StructureCodeInfo)

[Availability of this method depends on your Eclipse Scripting API license] Adds a new structure based on structure code. The DICOM structure type and structure ID are automatically assigned.

Declaration

public Structure AddStructure(StructureCodeInfo code)

Parameters

Type	Name	Description
StructureCodeInfo	code	The structure code.

Returns

Type	Description
Structure	Newly created structure.

CanAddCouchStructures(out String)

This method is used to verify whether it is possible to add couch structures to the StructureSet.

Declaration

public bool CanAddCouchStructures(out string error)

Parameters

Type	Name	Description
System.String	error	Returned reason why couch structures cannot be added if method returns false.

Returns

Type	Description
System.Boolean	True if couch structures can be added.

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.

CanRemoveCouchStructures(out String)

This method is used to verify whether it is possible to remove couch structures from the StructureSet.

Declaration

public bool CanRemoveCouchStructures(out string error)

Parameters

Type	Name	Description
System.String	error	Returned reason why couch structures cannot be removed if method returns false.

Returns

Type	Description
System.Boolean	True if couch structures can be removed.

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.

RemoveCouchStructures(out IReadOnlyList<String>, out String)

[Availability of this method depends on your Eclipse Scripting API license] Removes couch structures from the StructureSet.

Declaration

public bool RemoveCouchStructures(out IReadOnlyList<string> removedStructureIds, out string error)

Parameters

Type	Name	Description
System.Collections.Generic.IReadOnlyList<System.String>	removedStructureIds	Returned list of removed couch structure IDs if successful.
System.String	error	Returned error message if call failed.

Returns

Type	Description
System.Boolean	True if couch structures were removed.

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