Navigation: Scripting Reference Manual > Functions & Subroutines > IsPolarized

 

IsPolarized

 

Contact Us: fredsupport@photonengr.com

 

Description

Retrieves the polarization state for a specific ray in the ray buffer.  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

b = IsPolarized ( ray )

 

Parameters

b (Boolean)

Will be set to True if the ray is polarized, False if it is not.

 

ray As Long (or Huge_)

Identifier for the ray.

 

Remarks

This function retrieves the polarization state for a specific ray in the ray buffer.  If there is a problem, the function posts an error and returns False.

 

See Also

IsCoherent

IsRayActive

GetRayParent

GetRaySource

Examples

Raydata GetSet

 

 

 

 

 

 

Copyright © Photon Engineering, LLC