Class SegmentVolume

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

Inheritance

System.Object

SerializableObject

SegmentVolume

Implements

System.Xml.Serialization.IXmlSerializable

Inherited Members

SerializableObject.GetSchema()

SerializableObject.ReadXml(XmlReader)

SerializableObject.ClearSerializationHistory()

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: VMS.TPS.Common.Model.API

Assembly: VMS.TPS.Common.Model.API.dll

Syntax

public class SegmentVolume : SerializableObject, IXmlSerializable

Methods

And(SegmentVolume)

Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to both this segment volume and another segment volume, that is, the intersection of this and the other segment volume.

Declaration

public SegmentVolume And(SegmentVolume other)

Parameters

Type	Name	Description
SegmentVolume	other	The segment volume that is combined with this segment volume.

Returns

Type	Description
SegmentVolume	A new combined segment volume.

AsymmetricMargin(AxisAlignedMargins)

Expands or shrinks this segment volume with the specified margins, aligned to the axes of the image coordinate system.

Declaration

public SegmentVolume AsymmetricMargin(AxisAlignedMargins margins)

Parameters

Type	Name	Description
AxisAlignedMargins	margins	The margins in millimeters. The maximum is 50.

Returns

Type	Description
SegmentVolume	A new expanded or shrunk segment volume.

Margin(Double)

Creates a new segment volume by expanding or shrinking this segment volume with the specified margin (in millimeters). A positive value creates an outer margin. A negative value creates an inner margin.

Declaration

public SegmentVolume Margin(double marginInMM)

Parameters

Type	Name	Description
System.Double	marginInMM	The used margin in millimeters. The maximum is 50.

Returns

Type	Description
SegmentVolume	A new expanded or shrunk segment volume.

Not()

Creates a combination of segment volumes. Does not modify this segment volume. The combination includes the area that covers everything else but this segment volume.

Declaration

public SegmentVolume Not()

Returns

Type	Description
SegmentVolume	A new combined segment volume.

Or(SegmentVolume)

Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong to this segment volume, to another segment volume, or both, that is, the union of this and the other segment volume.

Declaration

public SegmentVolume Or(SegmentVolume other)

Parameters

Type	Name	Description
SegmentVolume	other	The segment volume that is combined with this volume.

Returns

Type	Description
SegmentVolume	A new combined segment volume.

Sub(SegmentVolume)

Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the area that belongs to this segment volume, but not to the other segment volume.

Declaration

public SegmentVolume Sub(SegmentVolume other)

Parameters

Type	Name	Description
SegmentVolume	other	The segment volume that is subtracted from this segment volume.

Returns

Type	Description
SegmentVolume	A new combined segment volume.

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

SerializableObject.WriteXml(XmlWriter)

Xor(SegmentVolume)

Creates a combination of segment volumes. The existing segment volumes are not modified. The combination includes the areas that belong either to this segment volume or to another segment volume, but not to both of them.

Declaration

public SegmentVolume Xor(SegmentVolume other)

Parameters

Type	Name	Description
SegmentVolume	other	The segment volume that is combined with this volume.

Returns

Type	Description
SegmentVolume	A new combined segment volume.

Implements

System.Xml.Serialization.IXmlSerializable