Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceDirApodGaussian

 

GetSourceDirApodGaussian

 

Contact Us: fredsupport@photonengr.com

 

Description

Returns the exponent along with the 1/e2 half-angles in degrees for "Gaussian" Directional Apodization on the Power Tab of a Detailed Source.

 

Syntax

success = GetSourceDirApodGaussian ( n, gn, xSemi, ySemi )

 

Parameters

success (Boolean)

Returns True if the source Direction Apodization is of type "Gaussian" and populates the variables gn, xSemi & ySemi. Note that gn, xSemi & ySemi should be Dim'd prior to usage of the command.  If the source is not of Direction Apodization type "Gaussian", then gn, xSemi & ySemi are returned as zero.

 

n As Long

Node number of source.

 

gn As Double

Gaussian exponent

 

xSemi As Double

Gaussian 1/e2 half-width angle along the source coordinate system x-direction (degrees)

 

ySemi As Double

Gaussian 1/e2 half-width angle along the source coordinate system y-direction (degrees)

 

Remarks

Represents a directional apodization of the form Exp[-2rgn] where gn=Sqrt[xSemi2 + ySemi2].

 

 

See Also

IsSourceDirApodGaussian

SetSourceDirApodGaussian

 

 

 

 

 

Copyright © Photon Engineering, LLC