Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourcePosGrid

 

GetSourcePosGrid

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the data from a source with a Grid Plane ray position type.

 

Syntax

success = GetSourcePosGrid ( n, semiWidthX, semiWidthY, numX, numY, isEllipse )

 

Parameters

success (Boolean)

Indicates if the function succeeded (True) or failed (False).

 

n As Long

Node number of the source.

 

semiWidthX As Double

Returns the semi aperture of the ray positions in the X direction.

 

semiWidthY As Double

Returns the semi aperture of the ray positions in the Y direction.

 

numX As Long

Returns the number of rays across in the X direction.

 

numY As Long

Returns the number of rays across in the Y direction.

 

isEllipse As Boolean

Returns the aperture shape. Set by FRED to True for elliptical apertures, False for rectangular ones.

 

Remarks

This function retrieves the data from a source with a Grid Plane ray position type. If there is a problem the function returns False and does not set an error.

 

See Also

IsSourcePosGrid

SetSourcePosGrid

Examples

Sources

 

 

 

 

 

 

Copyright © Photon Engineering, LLC