Class Fluence

Represents the fluence for a beam. The resolution in the fluence matrix is 2.5 mm in x and y directions. In the fluence matrix, x dimension is the number of columns, and y dimension is the number of rows.

Inheritance

System.Object

Fluence

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 Fluence

Constructors

Fluence(Single[,], Double, Double)

Constructor.

Declaration

public Fluence(float[, ] fluenceMatrix, double xOrigin, double yOrigin)

Parameters

Type	Name	Description
System.Single[,]	fluenceMatrix	Contains the pixel values for the fluence. x dimension is the number of columns, and y dimension is the number of rows in the matrix. The minimum number of rows and columns is 2, and the maximum is 1024. For the optimal fluence of a beam, the values in the fluence matrix are floats, 4 bytes per pixel. The pixel values are determined as follows: fluence value 1 produces a dose of 1 Gy at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Correspondingly, fluence value 2 produces 2 Gy, fluence value 3 produces 3 Gy, etc. at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Pixel values are positive.
System.Double	xOrigin	The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system.
System.Double	yOrigin	The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system.

Fluence(Single[,], Double, Double, String)

Constructor.

Declaration

public Fluence(float[, ] fluenceMatrix, double xOrigin, double yOrigin, string mlcId)

Parameters

Type	Name	Description
System.Single[,]	fluenceMatrix	Contains the pixel values for the fluence. x dimension is the number of columns, and y dimension is the number of rows in the matrix. The minimum number of rows and columns is 2, and the maximum is 1024. The pixel values are determined as follows: fluence value 1 produces a dose of 1 Gy at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Correspondingly, fluence value 2 produces 2 Gy, fluence value 3 produces 3 Gy, etc. at the depth of 10 cm in a water phantom with a 10 x 10 cm open field. Pixel values are positive.
System.Double	xOrigin	The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system.
System.Double	yOrigin	The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system.
System.String	mlcId	The identifier of the MLC that is related to the fluence. This parameter is optional. If the identifier is empty, the system tries to find the MLC from the treatment unit configuration. This happens when you call one of the Optimize(Int32) methods in the ExternalPlanSetup.

Properties

MaxSizePixel

The maximum size of pixels for x or y dimension in the fluence.

Declaration

public static int MaxSizePixel { get; }

Property Value

Type	Description
System.Int32

MLCId

The identifier of the MLC that is related to the fluence. The value can be empty or null.

Declaration

public string MLCId { get; }

Property Value

Type	Description
System.String

XOrigin

The x coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system.

Declaration

public double XOrigin { get; }

Property Value

Type	Description
System.Double

XSizeMM

The size of x dimension in mm for the fluence. The resolution is 2.5 mm in x and y directions.

Declaration

public double XSizeMM { get; }

Property Value

Type	Description
System.Double

XSizePixel

The size of x dimension in pixels for the fluence. This corresponds to the number of columns in the pixels matrix.

Declaration

public int XSizePixel { get; }

Property Value

Type	Description
System.Int32

YOrigin

The y coordinate of the first pixel in a fluence map. The value is measured in millimeters from the field isocenter to the center of the first pixel. The coordinate axes are the same as in the IEC BEAM LIMITING DEVICE coordinate system.

Declaration

public double YOrigin { get; }

Property Value

Type	Description
System.Double

YSizeMM

The size of y dimension in mm for the fluence. The resolution is 2.5 mm in x and y directions.

Declaration

public double YSizeMM { get; }

Property Value

Type	Description
System.Double

YSizePixel

The size of y dimension in pixels for the fluence. This corresponds to the number of rows in the pixels matrix.

Declaration

public int YSizePixel { get; }

Property Value

Type	Description
System.Int32

Methods

GetPixels()

Returns the fluence matrix.

Declaration

public float[, ] GetPixels()

Returns

Type	Description
System.Single[,]	The pixel values for the fluence as described in Fluence(Single[,], Double, Double)>.