Navigation: Scripting Reference Manual > Functions & Subroutines > GetDiffractEfficiencyVolHOEAlgorithmSecondary

 

GetDiffractEfficiencyVolHOEAlgorithmSecondary

 

Contact Us: fredsupport@photonengr.com

 

Description

When the Secondary diffraction efficiency specification of a grating surface is the Volume Hologram Efficiency type, this subroutine retrieves the algorithm mode specification as a string.

 

Syntax

algo = GetDiffractEfficiencyVolHOEAlgorithmSecondary ( snode )

 

Parameters

algo As String

Returned string indicating the efficiency algorithm mode currently used by the Volume Hologram Efficiency specification.  Possible return values are:

"surface-based grating equation signal direction algorithm"

“K-sphere (standard) signal direction algorithm”

“K-closed (legacy) signal direction algorithm”

 

snode As Long

This argument specifies the node number of the grating surface whose Secondary Volume Hologram Efficiency algorithm mode specification is being retrieved.

 

Example

The example below demonstrates how to retrieve and report the Secondary diffraction efficiency specification of a Volume Hologram Efficiency type.

 Sub Main

 

    Dim sNode As Long, algo As String

    sNode = FindFullName( "Geometry.Plane.Surface" )

 

    algo = GetDiffractEfficiencyVolHOEAlgorithmSecondary( sNode )

    Print "Algorithm = " & algo

 

 End Sub

 

 

See Also

Diffraction Grating Script Commands

Diffraction Gratings

 

 

 

 

 

 

Copyright © Photon Engineering, LLC