Class IonPlanNormalizationParameters

The parameters for proton plan normalization.

Inheritance

System.Object

IonPlanNormalizationParameters

Inherited Members

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.Types

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

Syntax

public class IonPlanNormalizationParameters

Constructors

IonPlanNormalizationParameters(PlanNormalizationMode)

Plan normalization parameters for normalizing the maximum, mean, minimum dose of the target volume to 100%, or to no normalization. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide.

Declaration

public IonPlanNormalizationParameters(PlanNormalizationMode normalizationMode)

Parameters

Type	Name	Description
PlanNormalizationMode	normalizationMode

Remarks

Supported plan normalization modes are PlanNormalizationMode.TargetMax, PlanNormalizationMode.TargetMean, PlanNormalizationMode.TargetMin, PlanNormalizationMode.NoNormalization.

IonPlanNormalizationParameters(PlanNormalizationMode, Double)

Plan normalization parameters user-defined plan normalization value. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide.

Declaration

public IonPlanNormalizationParameters(PlanNormalizationMode normalizationMode, double normalizationValue)

Parameters

Type	Name	Description
PlanNormalizationMode	normalizationMode
System.Double	normalizationValue

Remarks

Provide normalizationValue if normalizationMode is PlanNormalizationMode.UserDefined. normalizationValue will be set to NaN if normalizationMode is not PlanNormalizationMode.UserDefined.

Exceptions

Type	Condition
System.ArgumentException	An exception is thrown if the normalizationValue is invalid or the normalizationMode is not PlanNormalizationMode.UserDefined.

IonPlanNormalizationParameters(PlanNormalizationMode, Double, Double)

Plan normalization parameters for user-defined target volume percentage and plan normalization value. For more information refer to the plan normalization options in the Eclipse Proton Reference Guide.

Declaration

public IonPlanNormalizationParameters(PlanNormalizationMode normalizationMode, double normalizationValue, double volumePercentage)

Parameters

Type	Name	Description
PlanNormalizationMode	normalizationMode
System.Double	normalizationValue
System.Double	volumePercentage

Remarks

Provide normalizationValue and volumePercentage if normalizationMode is PlanNormalizationMode.TargetDVH. normalizationValue and volumePercentage will be set to NaN if the normalizationMode is not PlanNormalizationMode.TargetDVH.

Exceptions

Type	Condition
System.ArgumentException	An exception is thrown if either the normalizationValue and/or volumePercentage are invalid, or the normalizationMode is not PlanNormalizationMode.TargetDVH.

Properties

NormalizationMode

Normalization mode.

Declaration

public PlanNormalizationMode NormalizationMode { get; }

Property Value

Type	Description
PlanNormalizationMode

NormalizationValue

The treatment unit identifier.

Declaration

public double NormalizationValue { get; }

Property Value

Type	Description
System.Double

VolumePercentage

Volume percentage factor.

Declaration

public double VolumePercentage { get; }

Property Value

Type	Description
System.Double