Description

This subroutine modifies the data in an ARN by taking the base 10 logarithm of the data.  An absolute floor value on the logarithm is provided below which the actual logarithm of the data is not computed.  The following example creates several Analysis Results Nodes and manipulates their data by either taking a Log or performing an FFT.

Syntax

ARNLog10WithAbsoluteFloor arnNode, floorCutoff, showFloor, modifyName

Parameters

arnNode As Long

Node number of the ARN whose data is being modified.

floorCutoff As Double

Specifies the absolute floor value below which the Log is not taken.

showFloor As Boolean

When set to True, the floor values are included in the chart data.  When set to False, cells in the dataset below the specified floor are populated with hole values (1E+308).

modifyName As Boolean

When set to True, the display title and name of the ARN is modified from Name to Log(Name).  When set to False, no modifications to the title or name are made.

Example

The following example retrieves a 2D ARN created by a detector entity, calculates the ARN cell statistics to determine the A and B axis index ranges containing non-zero data, and then creates a new ARN containing the subset of non-zero data.

Sub Main

    ARNDeleteAllNodes()

    DeleteRays()

    TraceCreate()

    Dim anaNode As Long

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

    Dim rayCnt As Long

    Dim arnNode As Long

    rayCnt = IrradianceToARN( anaNode, "Detector Irradiance", arnNode )

    'Log10 relative

    Dim newARN As Long

    newARN = ARNCreateCopy( arnNode, "Detector Irradiance Rel." )

    ARNLog10WithRelativeFloor( newARN, 2, False, True )

    ARNDisplayInChart( newARN, "" )

    'Log10 absolute

    newARN = ARNCreateCopy( arnNode, "Detector Irradiance Abs." )

    ARNLog10WithAbsoluteFloor( newARN, 66000, True, True )

    ARNDisplayInChart( newARN, "" )

    'FFT

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

    IrradianceToARN( anaNode, "Detector Irradiance", arnNode )

    newARN = ARNCreate2DComplexFromDouble( arnNode )

    ARNFFT2D( newARN )

    ARNDisplayInChart( newARN, "" )

End Sub

See Also

ARN Script Commands