Navigation: Scripting Reference Manual > Functions & Subroutines > SetDiffractEfficiencyVolHOEAlgorithmSecondary

 

SetDiffractEfficiencyVolHOEAlgorithmSecondary

 

Contact Us: fredsupport@photonengr.com

 

Description

When the Secondary diffraction efficiency specification of a grating surface is the Volume Hologram Efficiency type, this subroutine sets the algorithm that will be used when computing diffraction efficiency values.  The recommended setting is “surface-based grating equation signal direction algorithm.  The “legacy signal direction algorithm” option is provided only for backward compatibility.

 

Syntax

SetDiffractEfficiencyVolHOEAlgorithmSecondary ( snode, algo )

 

Parameters

snode As Long

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

 

algo As String

This argument specifies the algorithm to be used by the Secondary Volume Hologram Efficiency specification.  Options are:

"surface-based grating equation signal direction algorithm"

“K-sphere (standard) signal direction algorithm”

“K-closed (legacy) signal direction algorithm”

 

Example

The example below demonstrates how to set the Primary diffraction efficiency specification of a Volume Hologram Efficiency type to use the standard grating equation mode.

 

Sub Main

 

    Dim sNode As Long, algo As String

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

    algo  = "surface-based grating equation signal direction algorithm"

 

    SetDiffractEfficiencyVolHOEAlgorithmSecondary( sNode, algo )

    Update

 

End Sub

 

 

See Also

Diffraction Grating Script Commands

Diffraction Gratings

 

 

 

 

 

Copyright © Photon Engineering, LLC