Navigation: Scripting Reference Manual > Functions & Subroutines > SourcePrimSetParmAstig

 

SourcePrimSetParmAstig

 

Contact Us: fredsupport@photonengr.com

 

Description

This function sets the configuration parameters for an Astigmatic Gaussian Beam type Source Primitive node.  A boolean is returned indicating whether the parameters were successfully applied.

 

 

Syntax

success = SourcePrimSetParmAstig( spNode, tAstig, wl )

 

 

Parameters

success (Boolean)

Returned boolean indicating whether the parameters were successfully applied to the source node.

 

spNode As Long

Node number of the Astigmatic Gaussian Beam type Source Primitive being modified.

 

tAstig as T_SOURCEPRIMASTIG

Data structure containing the configuration parameters of the beam.

 

wl As Double

Wavelength of the source in microns.

 

 

Example

The example below demonstrates how to add and configure an Astigmatic Gaussian Beam type Source Primitive.  The wavelength of the source is 0.532 microns.

 

Sub Main

 

    'Source primitive type

    Dim sType As String

    sType = "Astigmatic Gaussian Beam"

 

    'Add the source primitive

    Dim spNode As Long

    Dim tEnt As T_ENTITY

    InitEntity( tEnt )

    tEnt.name = "DJ532"

    spNode    = AddSourcePrim( sType, tEnt )

 

    'Configure the primitive parameters

    Dim success As Boolean

    Dim tAstig As T_SOURCEPRIMASTIG

    tAstig.PowerWatts  = 0.01

    tAstig.semiAngX    = 0.584 'degrees, semi angle

    tAstig.semiAngY    = 0.584 'degrees, semi angle

    tAstig.Xnum        = 51    'samples

    tAstig.Ynum        = 51    'samples

    tAstig.Zcreate     = 10    'Document units

    tAstig.Zseparation = 0.0   'No astigmatism

    success = SourcePrimSetParmAstig( spNode, tAstig, 0.532 )

 

    'Draw color, red

    SourcePrimSetDrawColor( spNode, 255, 0, 0 )

 

    'Update the model

    Update

 

End Sub

 

 

See Also

Source Primitive Script Commands

Astigmatic Gaussian Beam

SourcePrimGetParmAstig

T_SOURCEPRIMASTIG

 

 

 

 

 

Copyright © Photon Engineering, LLC