Navigation: Scripting Reference Manual > Functions & Subroutines > GetAnalysisValue

 

GetAnalysisValue

 

Contact Us: fredsupport@photonengr.com

 

Description

Calculates the interpolated value in a 2D array.

 

Syntax

result = GetAnalysisValue ( x, y, analysis, values )

 

Parameters

result (Double)

The interpolated value calculated from the data passed in.

 

x As Double

The local x coordinate in the 2-D array where the interpolated value will be calculated.

 

y As Double

The local y coordinate in the 2-D array where the interpolated value will be calculated.

 

analysis As T_ANALYSIS

The description of how the array of values maps to positions.

 

values() As Double

The array of data values.

 

Remarks

This function calculates a value at the given local (x,y) point based on the values in the array.  The calculation is bi-linear interpolation based on the nearest neighbor array values.  If there is a problem, it sets an error and returns 0.

 

The following discussion defining the local coordinate system assumes that you have read and understand the definition of the T_ANALYSIS user-defined type.  The local x direction is parallel to the (AcellX,AcellY,AcellZ) direction, and the local y direction is parallel to the (BcellY,BcellY,BcellZ) direction given in the T_ANALYSIS variable, "analysis".  The origin of the local coordinate system is at the spatial location of (posX,posY,posZ) given in the T_ANALYSIS variable, "analysis".  It will always coincide with the (i,j)=(0,0) sample point.  Note that this point may not be at the spatial center of the array.

 

See Also

T_ANALYSIS

Examples

 

 

 

 

 

Copyright © Photon Engineering, LLC