Navigation: Scripting Reference Manual > Functions & Subroutines > GetSourceBeamOverlap

 

GetSourceBeamOverlap

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the Gaussian beam overlap from a specified coherent optical source.

 

Syntax

overlap = GetSourceBeamOverlap ( n )

 

Parameters

overlap (Double)

Returns the amount of overlap in the coherent rays.

 

n As Long

Node number of the source.

 

Remarks

This function retrieves the Gaussian beam overlap from a specified optical source.  The overlap represents the fraction overlap in the initial sizes of neighboring Gaussian beams created from a coherent source.  Typically the overlap has a value between 1 and 2.  The function is of little value for incoherent sources. If there is a problem the function returns 0 and does not set an error.

 

See Also

GetSourceCoherence

SetSourceBeamOverlap

SetSourceCoherence

Examples

Sources

 

 

 

 

 

Copyright © Photon Engineering, LLC