Description This function performs a Spectral Analysis.
Syntax spectNode = SpectralAnalysis( anaNode, daeNode, maxWlCount, rescalePeak, rescaleValue, extendLimits )
Parameters spectNode (Long) Node number of the spectrum containing the results of the spectral analysis.
anaNode As Long Node number of an analysis plane whose ray filters and spatial extents are applied during the spectral analysis.
daeNode As Long Node number of a directional analysis entity whose ray filters and directional extents are applied during the spectral analysis.
maxWlCount As Long The number of unique wavelengths required in the analysis to force wavelength binning into the fixed mode. See Spectral Analysis for more details.
rescalePeak As Boolean Boolean indicating whether the resulting spectrum should be rescaled to have its maximum value corresponding to the value designated in the rescaleValue argument.
rescaleValue As Double If rescalePeak is True, this defines the peak value that the spectrum should be rescaled to. If rescalePeak is False, this argument does not apply (can set to -1).
extendLimits As Boolean Boolean indicating whether the analysis should account for the 1/2 cell difference in the bandwidths represented by the source wavelengths. See Spectral Analysis for more details.
Example The following example clears the ray buffer, creates all active sources and then performs a Spectral Analysis using a designated analysis plane. The resulting spectrum node number is printed to the output window.
Sub Main
DeleteRays() CreateSources()
Dim anaNode As Long anaNode = FindFullName( "Analysis Surface(s).Analysis 1" )
Dim spectNode As Long spectNode = SpectralAnalysis( anaNode, -1, 200, False, -1, False ) Print "Spectrum created at node " & spectNode
End Sub
See Also
|