Navigation: Scripting Reference Manual > Functions & Subroutines > SetRayCoherent

 

SetRayCoherent

 

Contact Us: fredsupport@photonengr.com

 

Description

Sets the coherence state of a specific ray.  Depending on the number of rays traced, it may be necessary to dimension ray index and ray counter variables as data type Huge_ instead of Long.  Please see Multi-threaded Raytracing for more information.

 

Syntax

SetRayCoherent id, coherent

 

Parameters

id As Long (or Huge_)

The identifier of the ray.

 

coherent As T_RAYCOHERENT

Structure containing the new coherent specification for the ray.

 

Remarks

This subroutine sets the coherency state of a specific ray.  Specifically it allows you to set the phase curvatures and 1/e Gaussian field amplitude widths of the coherent ray. If there is a problem the subroutine sets an error and returns without modifying the ray.

 

See Also

GetRayCoherent

T_RAYCOHERENT

Examples

Raydata GetSet

 

 

 

 

 

Copyright © Photon Engineering, LLC