Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourcePosApodGaussian

 

GetSourcePosApodGaussian

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the Gaussian power position apodization from a specified source.

 

Syntax

success = GetSourcePosApodGaussian ( n, semiWidthX, semiWidthY, offsetX, offsetY )

 

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 X semi-width of the 1/e2 power point.

 

semiWidthY As Double

Returns the Y semi-width of the 1/e2 power point.

 

offsetX As Double

Returns the X offset of the Gaussian center.

 

offsetY As Double

Returns the Y offset of the Gaussian center.

 

Remarks

This function retrieves the Gaussian power position apodization from a specified source. If there is a problem the function returns False and does not set an error.

 

See Also

IsSourcePosApodGaussian

SetSourcePosApodGaussian

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC