Navigation: Scripting Reference Manual > Functions & Subroutines > ColorImageToARN

 

ColorImageToARN

 

Contact Us: fredsupport@photonengr.com

 

Description

Computes the color image using an analysis surface and returns the results to an ARN.  The data grid has dimensions m x n x 3, where m and n are the number of x and y divisions in the analysis grid.  The bounds limits on the BASIC array is then (m-1) x (n-1) x 2, with the third index being used to access the XYZ tristimulus components of a given pixel (0 for X tri-stimulus, 1 for Y tri-stimulus, 2 for Z tri-stimulus).  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 = ColorImageToARN( anaNode, arnName, arnNode )

 

 

Parameters

numRays (Long or Huge_)

Number of rays included in the analysis.

 

anaNode As Long

Node number of the analysis surface to be used in the analysis.  The analysis surface's ray filters are applied.

 

arnName As String

Name of the ARN being created.

 

arnNode As Long

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

 

 

Remarks

The following example performs a color image calculation on an existing rayset.

 

Dim anaNode As Long

Dim arnNode As Long

Dim numRays As Long

 

anaNode = FindFullName( "Analysis Surface(s).Analysis 1" )

numRays = ColorImageToARN( anaNode, "Example ARN", arnNode )

 

See Also

ColorImageToFile

ColorImageToFileAS

 

 

 

 

 

Copyright © Photon Engineering, LLC