Navigation: Scripting Reference Manual > Functions & Subroutines > SetSourcePowerUnits

 

SetSourcePowerUnits

 

Contact Us: fredsupport@photonengr.com

 

Description

Sets the power units for a given source node.  Units are indicated by a value of type Long, where 0 = Unspecified units, 1 = Watts and 2 = Lumens.  Note that unless the source has a spectrum applied, using option 2 (Lumens) will produce an error and the operation will be halted.

 

 

Syntax

SetSourcePowerUnits srcNode, pwrUnits

 

 

Parameters

srcNode As Long

Node number of the source being modified.

 

pwrUnits As Long

Value indicating power units to be used.  Valid options are:

0: Unspecified Units

1: Watts

2: Lumens (Source must also have a spectrum applied)

 

 

Remarks

The following example  finds the node for a source and then sets the source power units to Watts.

 

Dim srcNode As Long

 

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

 

SetSourcePowerUnits  srcNode, 1

 

 

See Also

SetSourceSpectrum

GetSourceSpectrum

GetSourcePowerUnits

SetSourceRayWavelengthMethod

GetSourceRayWavelengthMethod

SetSourceRayWavelengthRange

GetSourceRayWavelengthRange

 

 

 

 

 

Copyright © Photon Engineering, LLC