Navigation: Scripting Reference Manual > Functions & Subroutines > LuminousIntensityToARN

 

LuminousIntensityToARN

 

Contact Us: fredsupport@photonengr.com

 

Description

Computes the Luminous Intensity and stores the results in an ARN.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

 

Syntax

numRays = LuminousIntensityToARN( daeNode, outputUnits, detRespSpect, detRespScale, arnName, arnNode )

 

 

Parameters

numRays (Long or Huge_)

Number of rays included in the calculation.

 

daeNode As Long

Node number of the DAE being used in the calculation.  The DAE's ray filters are applied.

 

outputUnits As Long

Long value indicating the units to be used.  Valid values are:

0: Candela

1: Arbitrary Units

If the user has specified to use a detector response, then the units are automatically set to Arbitrary Units.  If the user does not wish to specify a detector response, then set detRespSpect = -1.

 

detRespSpect As Long

Node number of the spectra to be used as the detector response function.

 

detRespScale As Double

Scale factor to be applied to the detector response function.

 

arnName As String

Name of the ARN being created.

 

arnNode

Node number of the ARN being created.  Returned by the function.

 

 

Remarks

The following example calculates the Luminous Intensity for an existing rayset using Arbitrary Units and stores the results in an ARN named "testARN".

 

Dim arnNode As Long

Dim daeNode As Long

Dim numRays As Long

 

daeNode = FindFullName( "Analysis Surface(s).DAE 1" )

 

numRays = LuminousIntensityToARN( daeNode, 1, -1, 1, "testARN", arnNode )

 

 

See Also

IntensityAtSpecifiedDirections

LuminousIntensityToFileDAE

 

 

 

 

 

Copyright © Photon Engineering, LLC