Navigation: Scripting Reference Manual > Functions & Subroutines > SetSourcePosApodSuperGaussian

 

SetSourcePosApodSuperGaussian

 

Contact Us: fredsupport@photonengr.com

 

Description

This subroutine sets the 1/e2 semi-widths and offsets of a Super Gaussian position apodization function.

 

 

Syntax

SetSourcePosApodSuperGaussian( src, wX, wY, x0, y0 )

 

 

Parameters

src As Long

Node number of the source being modified.

 

wX As Double

1/e2 semi-width of the apodization function in the X direction.

 

wY As Double

1/e2 semi-width of the apodization function in the Y direction.

 

x0 As Double

X offset of the apodization function center in the local coordinate system of the source.

 

y0 As Double

Y offset of the apodization function center in the local coordinate system of the source.

 

Example

The example below demonstrates how to set the widths, offsets, exponents and mode values of a Super Gaussian position apodization function.

 

Sub Main

 

    Dim src As Long

    src = FindFullName( "Optical Sources.Apodized Source" )

 

    SetSourcePosApodSuperGaussian( src, 0.06, 0.001, 0, 0 )

    SetSourcePosApodSuperGaussianExponents( src, 10, 1 )

    SetSourcePosApodSuperGaussianMode( src, 0, 0, 0 )

 

    Update

 

End Sub

 

See Also

Detailed Source Scripting Commands

GetSourceDirApodSuperGaussian

GetSourcePosApodSuperGaussian

GetSourcePosApodSuperGaussianExponent

GetSourcePosApodSuperGaussianMode

IsSourceDirApodSuperGaussian

IsSourcePosApodSuperGaussian

SetSourceDirApodSuperGaussian

SetSourcePosApodSuperGaussianExponent

SetSourcePosApodSuperGaussianMode

 

 

 

 

 

Copyright © Photon Engineering, LLC