Navigation: Scripting Reference Manual > Functions & Subroutines > SpectrumFindName

 

SpectrumFindName

 

Contact Us: fredsupport@photonengr.com

 

Description

Finds the node number for a spectrum based on a given name string.  This string can also be easily copied from the GUI using the "Copy Find-Name Command to Clipboard" feature available in the list menu after right mouse clicking on a node in the object tree.

 

 

Syntax

foundNode = SpectrumFindName( nameString )

 

 

Parameters

foundNode (Long)

Node number of the spectrum being searched for.  A value of -1 is returned if the spectrum is not found.          

 

nameString As String

Name of the spectrum being searched for.

 

 

Example

The following example creates a blackbody spectrum, names the spectrum and then searches for its node number.

 

Dim spectNode As Long

Dim foundNode As Long

 

spectNode = SpectrumCreateBlackbody( 5900, 0.3, 0.7 )

SpectrumSetName spectNode, "BB"

foundNode = SpectrumFindName( "BB" )

Print "Spectrum found at node: " & foundNode

 

See Also

SpectrumCombine

SpectrumComputeArea

SpectrumComputeChromaticity

SpectrumComputeLuminousEfficacy

SpectrumCopy

SpectrumDelete

SpectrumDeleteAllNodes

SpectrumGetDescription

SpectrumGetMaxNodeNum

SpectrumGetName

SpectrumGetNodeCount

SpectrumGetRange

SpectrumGetValue

SpectrumIsValidNode

SpectrumSetDescription

SpectrumSetName

 

 

 

 

 

Copyright © Photon Engineering, LLC