Description This function retrieves the swelling factor value from a grating surface using the Volume HOE Efficiency diffraction efficiency type as its Primary efficiency specification.
Syntax swell = GetDiffractEfficiencyVolHOESwellingFactor ( snode )
Parameters swell (Double) Swelling factor value retrieved from the grating efficiency specification. A value of 1.0 means there is no swelling, a value less than 1.0 indicates contraction, and a value greater than 1.0 indicates expansion.
snode As Long This argument specifies the node number of the grating surface whose Volume HOE Efficiency swelling factor parameter is being retrieved.
Example The example below demonstrates how to retrieve and apply the swelling factor to a grating surface using the Volume HOE Efficiency diffraction efficiency type.
Sub Main
'Grating with the Volume hologram efficiency specification Dim hoe As Long hoe = FindFullName( "Geometry.Ideal HOE.Grating.Hemisphere" )
'Retrieve current swelling factor value Dim sf As Double sf = GetDiffractEfficiencyVolHOESwellingFactor( hoe ) Print "Current HOE swelling factor is " & sf
'Set new swelling factor value sf = 1.10 SetDiffractEfficiencyVolHOESwellingFactor( hoe, sf )
'udpate the model Update
End Sub
See Also Diffraction Grating Script Commands
|