Search Results for

    Show / Hide Table of Contents

    Class OptimizationIMRTBeamParameter

    Beam-specific optimization parameter for IMRT optimization.

    Inheritance
    System.Object
    SerializableObject
    OptimizationParameter
    OptimizationIMRTBeamParameter
    Implements
    System.Xml.Serialization.IXmlSerializable
    Inherited Members
    OptimizationParameter.Equals(Object)
    OptimizationParameter.GetHashCode()
    SerializableObject.GetSchema()
    SerializableObject.ReadXml(XmlReader)
    SerializableObject.ClearSerializationHistory()
    System.Object.ToString()
    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 OptimizationIMRTBeamParameter : OptimizationParameter, IXmlSerializable

    Properties

    Beam

    The beam to which this parameter belongs.

    Declaration
    public Beam Beam { get; }
    Property Value
    Type Description
    Beam

    BeamId

    The identifier of the beam.

    Declaration
    public string BeamId { get; }
    Property Value
    Type Description
    System.String

    Excluded

    True if the beam is excluded from the optimization.

    Declaration
    public bool Excluded { get; }
    Property Value
    Type Description
    System.Boolean

    FixedJaws

    If true, the collimator jaw positions of the beam remain the same during the optimization.

    Declaration
    public bool FixedJaws { get; }
    Property Value
    Type Description
    System.Boolean

    SmoothX

    A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value.

    Declaration
    public double SmoothX { get; }
    Property Value
    Type Description
    System.Double

    SmoothY

    A smoothing parameter that controls the fluence profiles. A high value smoothes the fluence more than a low value.

    Declaration
    public double SmoothY { get; }
    Property Value
    Type Description
    System.Double

    Methods

    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
    OptimizationParameter.WriteXml(XmlWriter)

    Implements

    System.Xml.Serialization.IXmlSerializable
    In This Article
    Back to top