Navigation: Scripting Reference Manual > Functions & Subroutines > ARNGetPhysicalMeaning

 

ARNGetPhysicalMeaning

 

Contact Us: fredsupport@photonengr.com

 

Description

Returns the physical meaning of the data stored in the given Analysis Results Node (ARN).

 

Syntax

physMean = ARNGetPhysicalMeaning( nNodeNum )

 

Parameters

physMean (String)

Physical meaning of ARN data. Options are "CoherentScalarField", "CoherentVectorField", "Irradiance", "Intensity", "EnergyDensity", "ColorImageRGB", "RayCount", "Wavefront", "OPDMap". The value "Unknown" will be returned the physical meaning was set to anything other than in the above list.

 

nNodeNum As Long

Node number of existing ARN.

 

Remarks

Returns the physical meaning of the data stored in the given Analysis Results Node (ARN). This setting allows FRED to properly interpret and present the type of data contained in the ARN.

 

See Also

All ARN Scripting Commands

 

 

 

 

 

Copyright © Photon Engineering, LLC