Navigation: Scripting Reference Manual > Functions & Subroutines > RayScalarFieldAtPoint

 

RayScalarFieldAtPoint

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the real and imaginary field contributions at a given (xyz) point in space for the beamlet of a specified (base) ray.  Depending on the number of rays traced, it may be necessary to dimension ray index as data type Huge_ instead of Long.

 

Syntax

RayScalarFieldAtPoint ( n, x, y, z, real, imag )

 

Parameters

n As Long (or Huge_)

The identifier of the (base) ray.

 

x As Double

The x location of the field.

 

y As Double

The y location of the field.

 

z As Double

The z location of the field.

 

real As Double

The real component of the field for ray n at point xyz.  Returned by the function.

 

imag As Double

The imaginary component of the field for ray n at point xyz.  Returned by the function.

 

Remarks

Retrieves the real and imaginary field contributions at a given (xyz) point in space for the beamlet of a specified (base) ray.   The returned real and imaginary values will be zero if the ray is not coherent.

 

See Also

 

Examples

 

 

 

 

 

Copyright © Photon Engineering, LLC