ARNDisplayInChart Function

Navigation: Scripting Reference Manual > Functions & Subroutines > ARNDisplayInChart

ARNDisplayInChart

Description

Displays an Analysis Results Node (ARN) in a chart window.

Syntax

success = ARNDisplayInChart( arnNode, parmString )

Parameters

success (Boolean)

True if chart display was successful. False otherwise.

arnNode As Long

Node number of the ARN being displayed in the chart view.

parmString As String

Current implementation requires at least an empty string argument. All parameter string entries other than those listed in the table below will be ignored and default chart settings used. Future implementations will allow additional display options using this string argument.

	parmString Options
ARN Type	Form	Description
Color Image	Brightness=X	X is a numeric value between 1E-30 and 1E+30, with X=1.0 being the default value. If the Brightness parameter is omitted from the parameter string, then the default Brightness value of 1.0 will be applied in the resulting chart view.

Example

The following example traces a new rayset and uses an existing analysis surface to compute and display both Irradiance and Color Image results.

Sub Main

Dim arnNode As Long, anaNode As Long, count As Long

Dim success As Boolean

Dim parmString As String

'get the node number of the analysis surface being used

anaNode = FindFullName( "Analysis Surface(s).Analysis Surface(s)_Detector Entity" )

'delete current rayset and trace sources

DeleteRays

TraceCreate

'store the results of the irradiance calculation in an ARN

count = IrradianceToARN( anaNode, "IrradARN", arnNode )

'display the ARN in the chart view, empty parameter string

parmString = ""

success = ARNDisplayInChart( arnNode, parmString)

'calculate a Color Image

count = ColorImageToARN( anaNode, "CI", arnNode )

'display the ARN in the chart view, use brightness option

parmString = "Brightness=10"

success = ARNDisplayInChart( arnNode, parmString )

End Sub