Description

Performs an illuminance calculation 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 = IlluminanceToARN( anaSurf, outputUnits, nDetRespSpect, DetRespScale, arnName, arnNodeNum )

Parameters

numRays (Long as Huge_)

Number of rays included in the calculation

anaSurf As Long

Node number of the analysis surface used in the calculation.

outputUnits As Long

Value specifies units of the calculation.  Options are:

0: Lumens/(sys units)²

1: Lux

2: Phot

3: Foot-candles

4: 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 nDetRespSpect = -1.

nDetRespSpect As Long

Node number of the spectrum to be used as the detector response.  Set to -1 if not used.

DetRespScale As Double

Scale factor for the spectrum being used as the detector response.  Set to -1 if not used.

arnName As String

Name of the ARN being created from the Illuminance calculation.

arnNodeNum As Long

Node number of the ARN being created from the Illuminance calculation.  Returned by the function.

Remarks

The following example creates an ARN through an Illuminance calculation on an existing rayset.  The units are set to "Phot", the name of the ARN is "ArnTestNode" and the node number is stored in the variable arnNodeNum.

Dim arnNodeNum As Long

Dim anaSurfNum As long

anaSurfNum = FindFullName( "Analsysis Surface(s).Analysis 1" )

numRays = IlluminanceToARN( anaSurfNum, 2, -1, 1, "ArnTestNode", arnNodeNum )

See Also

IlluminanceToFileAS