Description This subroutine sets the exponent and divergence angle values of a Super Gaussian directional apodization function.
Syntax SetSourceDirApodSuperGaussian( src, eX, eY, xType, yType, xAng, yAng )
Parameters src As Long Node number of the source whose Super Gaussian directional apodization function is being modified.
eX As Double Super Gaussian exponent in the X direction.
eY As Double Super Gaussian exponent in the Y direction.
xType As String Type string specifying the interpretation of xAng. Options are: "Full width at half power" "Half width at half power" "Full width at 1/e amplitude point" "Half width at 1/e amplitude point" "Full width at 1/e^2 power point" "Half width at 1/e^2 power point" "Full width at 1% power point" "Half width at 1% power point" "Variance power full width (second moment)" "Variance power half width (second moment)"
yType As String Type string specifying the interpretation of yAng. Options are: "Full width at half power" "Half width at half power" "Full width at 1/e amplitude point" "Half width at 1/e amplitude point" "Full width at 1/e^2 power point" "Half width at 1/e^2 power point" "Full width at 1% power point" "Half width at 1% power point" "Variance power full width (second moment)" "Variance power half width (second moment)"
xAng As Double Divergence angle of the apodization function in the X direction.
yAng As Double Divergence angle of the apodization function in the Y direction.
Example The example below demonstrates how to set the parameters of a source with the Super Gaussian direction apodization function so that the exponents in the X and Y directions are 1 and 10, respectively, and the divergence angles in X and Y are 5o and 1o, respectively. The interpretation of the X and Y divergence angles are 1/e amplitude half-widths.
Sub Main
Dim src As Long src = FindFullName( "Optical Sources.Apodized Source" )
SetSourceDirApodSuperGaussian( src, 1, 10, "Half width at 1/e amplitude point", "Half width at 1/e amplitude point", 5, 1 ) Update
End Sub
See Also Detailed Source Scripting Commands GetSourcePosApodSuperGaussianExponent GetSourcePosApodSuperGaussianMode
|