Navigation: Scripting Reference Manual > Functions & Subroutines > SetSourcePosImportedUseWavelengthsFromFile

 

SetSourcePosImportedUseWavelengthsFromFile

 

Contact Us: fredsupport@photonengr.com

 

Description

For a detailed source whose ray positions specification uses a ray file, this subroutine sets the flag that determines whether wavelengths are generated according to the ray file itself or according to the source's Wavelengths tab.

 

 

Syntax

SetSourcePosImportedUseWavelengthsFromFile srcNode, wlsFlag

 

 

Parameters

srcNode As Long

Node number of the source having ray positions type "Read rays from a file and generate dynamically" whose wavelength generation flag is being set.

 

wlsFlag As Boolean

Boolean indicating how ray wavelengths are generated in the source.  If True, ray wavelengths will be generated according to the ray file.  If False, ray wavelengths will be generated according to the source's Wavelengths tab.

 

 

Example

The following example specifies that a source using a ray file should generate wavelengths according to the ray file.

 

Sub Main

 

    Dim srcNode As Long

    srcNode = FindFullName( "Optical Sources.Source 1" )

    SetSourcePosImportedUseWavelengthsFromFile( srcNode, True )

 

End Sub

 

 

See Also

Source Scripting Commands

Read Rays From a File and Generate Dynamically

 

 

 

 

 

Copyright © Photon Engineering, LLC