Navigation: Scripting Reference Manual > Functions & Subroutines > SetSourcePosApodSuperGaussianMode

 

SetSourcePosApodSuperGaussianMode

 

Contact Us: fredsupport@photonengr.com

 

Description

This subroutine sets the mode index values and mode type of a Super Gaussian position apodization function.

 

 

Syntax

SetSourcePosApodSuperGaussianMode( src, N, M, mType )

 

 

Parameters

src As Long

Node number of the source being modified.

 

N As Long

If mType is Hermite, N is the X mode index.  If mType is Laguerre, N is the Radial mode index.

 

M As Long

If mType is Hermite, M is the Y mode index.  If mType is Laguerre, M is the Azimuthal mode index.

 

mType As Long

Specifies the mode type.  Values have the following meaning:

0          Hermite

1          Laguerre

2          Laguerre Cosine

3          Laguerre Sine

 

Example

The example below demonstrates how to set the widths (0.06 and 0.001), offsets (0 and 0), exponents (10 and 1) and mode values (00 mode, Hermite) 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

SetSourcePosApodSuperGaussian

SetSourceDirApodSuperGaussian

SetSourcePosApodSuperGaussianExponent

 

 

 

 

 

Copyright © Photon Engineering, LLC